文件解析(同步)

创建文件解析任务，支持多种文件格式和解析工具。见 文件解析服务。点击 Try it 按钮可快速试用。

POST /paas/v4/files/parser/sync

文件解析(同步)

cURL

curl --request POST \
  --url https://open.bigmodel.cn/api/paas/v4/files/parser/sync \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form tool_type=prime-sync

import requests

url = "https://open.bigmodel.cn/api/paas/v4/files/parser/sync"

files = { "file": ("example-file", open("example-file", "rb")) }
payload = { "tool_type": "prime-sync" }
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');
form.append('tool_type', 'prime-sync');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://open.bigmodel.cn/api/paas/v4/files/parser/sync', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.post("https://open.bigmodel.cn/api/paas/v4/files/parser/sync")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tool_type\"\r\n\r\nprime-sync\r\n-----011000010111000001101001--")
  .asString();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://open.bigmodel.cn/api/paas/v4/files/parser/sync"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tool_type\"\r\n\r\nprime-sync\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://open.bigmodel.cn/api/paas/v4/files/parser/sync",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tool_type\"\r\n\r\nprime-sync\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

200

{
  "status": "succeeded",
  "message": "结果获取成功",
  "task_id": "task_123456789",
  "content": "这是解析后的文本内容...",
  "parsing_result_url": "https://example.com/download/result.zip"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

Authorization · string · header · required

标准的 HTTP Bearer 认证方式，在 API Keys 页面获取密钥。

Body

multipart/form-data

file · file · required

待解析文件

tool_type · enum<string> · required

使用的解析工具类型

Available options: prime-sync

file_type · enum<string>

文件类型支持：pdf,docx,doc,xls,xlsx,ppt,pptx,png,jpg,jpeg,csv,txt,md,html,bmp,gif,webp,heic,eps,icns,im,pcx,ppm,tiff,xbm,heif,jp2

Available options: WPS, PDF, DOCX, DOC, XLS, XLSX, PPT, PPTX, PNG, JPG, JPEG, CSV, TXT, MD, HTML, BMP, GIF, WEBP, HEIC, EPS, ICNS, IM, PCX, PPM, TIFF, XBM, HEIF, JP2

Response

200

application/json

结果获取成功

status · enum<string> · required

任务处理状态

Available options: processing, succeeded, failed

Example:

"succeeded"

message · string · required

结果状态描述

Example:

"结果获取成功"

task_id · string · required

文件解析任务ID

Example:

"task_123456789"

content · string | null

当format_type=text时返回的解析文本内容

Example:

"这是解析后的文本内容..."

parsing_result_url · string | null

当format_type=download_link时返回的结果下载链接

Example:

"https://example.com/download/result.zip"