Start Quick Schema Creation
start_quick_schema_creationUpload a local document to start schema creation and generate extraction templates, returning a run ID to poll for generated template and saved document IDs.
Instructions
Upload one local file to automatically create extraction schemas/templates; use when the user authorized schema creation, which may consume credits. Returns run_id for get_quick_schema_creation or wait_for_quick_schema_creation, not an extraction task_id or export_job_id. Completed runs return generated template IDs and saved document IDs; inspect those before submitting another extraction. Supply upload_batch_id and source_upload_id only when provided by an external batched-upload workflow; MCP does not create upload batches. Starting again can create duplicate work.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| 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 the source document. | |
| pdf_password | No | Optional encrypted-PDF password. Treat this as a secret. | |
| upload_batch_id | No | Optional existing upload batch ID from an external batch workflow. | |
| source_upload_id | No | Optional source upload ID from an external batch workflow. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes | ||
| run_id | Yes |