Start File Extraction
start_file_extractionSubmit a local document to start background extraction and receive a task ID immediately after upload, without waiting for processing. Use it to kick off PDF or image parsing workflows.
Instructions
Start background extraction of one local file; return task_id after upload confirmation without waiting for processing or exporting results. This confirms submission, not successful extraction. Use wait_for_task_extraction, then fetch_document_result for a returned document ID or download_results to save an export; get_task_results can inspect partial documents. Uploads may consume credits. On timeout, use any returned recovery task_id rather than uploading again. auto_approve defaults true; false requests human review, which MCP cannot perform or approve. The returned auto_approve echoes the requested option, not backend approval status.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| split | No | Enable auto-splitting of multi-page documents with mixed document types. | |
| api_url | No | ||
| file_path | Yes | Path to a local document on the machine running this MCP server, not a URL or chat attachment. Supported extensions: .pdf, .jpg, .jpeg, .png, .heic, .heif. Prefer an absolute path; relative paths use the server's working directory and ~ is not expanded. | |
| folder_id | No | Optional remote Suparse folder ID to assign to uploaded documents. | |
| template_id | No | Optional extraction template ID. Use only a non-system team template ID from list_templates. System template IDs are discovery-only and cannot be passed directly. Omit to let Suparse auto-detect, or use an authorized quick-schema workflow to create a team template. | |
| auto_approve | No | Automatically approve extracted documents. Defaults to true. Set false only when human review is requested; use a start-only extraction tool to retain the task ID. MCP cannot approve documents, and combined extraction may time out while review is pending. | |
| pdf_password | No | Optional password for an encrypted PDF. Treat this as a secret; it is used only for the upload and is not returned in results. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| task_id | Yes | ||
| file_path | Yes | ||
| auto_approve | Yes |