Dumpling AI Extract Document
82.5 credits/call
ae_dumplingai_extract_document
Extract structured data from one or more documents based on specific instructions using DumplingAI.
82.5 credits/call
Pricing
82.5 credits/call
| Condition | Charge |
|---|---|
| Each call | 82.5 credits/call |
Parameters
Optional parameters use the platform defaults when omitted.
| Parameter | Type | Required | Description | Default |
|---|---|---|---|---|
files | array | Yes | Array of publicly accessible URLs or base64-encoded document contents. | — |
prompt | string | Yes | Instructions that describe the structured data to extract from the documents. | — |
jsonMode | boolean | No | When true, requests the model to respond with JSON-formatted output. | false |
inputMethod | enum (url | base64) | Yes | Indicates whether binary content is supplied via URL or base64-encoded string. | — |
fileExtension | string | No | File extension for the provided documents (e.g., '.pdf', '.docx', or 'autodetect'). Defaults to '.pdf'. | — |
requestSource | enum (API | WEB | MAKE_DOT_COM | ZAPIER | N8N | PLAYGROUND | DEFAULT_AUTOMATION | AGENT_PREVIEW | AGENT_LIVE | AUTOPILOT | STUDIO) | No | Optional identifier describing where the API request originated. | — |
Invocation example
Copy the request and explore its response example.
POST
/agent-api/v1/tool/executeX-Api-KeyRequest coderequest.sh
curl --request POST \
--url 'https://agentearth.ai/agent-api/v1/tool/execute?tool_name=ae_dumplingai_extract_document' \
--header "X-Api-Key: $AGENTEARTH_API_KEY" \
--header 'Content-Type: application/json' \
--data-raw '{
"params": {
"fileExtension": ".xlsx",
"files": [
"https://infopub.sues.edu.cn/_upload/article/files/8c/8f/ace0d2ae469dad3435b68bedd922/3aee720d-73a2-496e-8ff5-2f3383460c93.xlsx"
],
"inputMethod": "url",
"jsonMode": false,
"prompt": "提取上海工程技术大学2026年招聘计划(第一批)中所有专任教师岗位。逐行说明用人部门、岗位、人数、学历学位、专业要求和其他条件。重点标记是否包含120403、教育经济与管理、公共管理、管理学、教育学、心理学。最后单独列出与教育经济与管理博士最相关的岗位。"
}
}'Response exampleresponse.json
{
"creditUsage": 110,
"fileCount": 1,
"pages": 1,
"prompt": "提取上海工程技术大学2026年招聘计划(第一批)中所有专任教师岗位。逐行说明用人部门、岗位、人数、学历学位、专业要求和其他条件。重点标记是否包含120403、教育经济与管理、公共管理、管理学、教育学、心理学。最后单独列出与教育经济与管理博士最相关的岗位。",
"results": "根据你提供的《上海工程技术大学2026年招聘计划(第一批)-专任教师》页面内容,本批次**“专任教师”岗位**仅能看到两类岗位条目(对应表格中两行):\n\n---\n\n## 逐行提取专任教师岗位信息(第1批)\n\n### 第1行\n- **用人部门**:各学院 \n- **岗位名称**:学科带头人 \n- **岗位/招聘人数**:12 \n- **最低工作年限**:不区分(表中该列显示为“不限”) \n- **年龄上限**:50 \n- **学历学位要求**:研究生毕业;博士学位 \n- **学科/专业要求**:不"
}This example shows part of the response. Copied content is valid JSON.

