Skip to main content
POST
/
extract_async
Extract Data (Async)
curl --request POST \
  --url https://platform.aifano.com/extract_async \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": "<string>",
  "schema": {},
  "system_prompt": "<string>",
  "async": {
    "priority": false,
    "webhook": {
      "mode": "svix",
      "url": "<string>"
    },
    "metadata": "<unknown>"
  },
  "parsing": {
    "enhance": {
      "agentic": [],
      "summarize_figures": true
    },
    "retrieval": {
      "chunking": {
        "chunk_mode": "disabled",
        "chunk_size": 123
      },
      "filter_blocks": [],
      "embedding_optimized": false
    },
    "formatting": {
      "add_page_markers": false,
      "table_output_format": "dynamic",
      "merge_tables": false,
      "include": []
    },
    "spreadsheet": {
      "split_large_tables": {
        "enabled": true,
        "size": 50
      },
      "clustering": "accurate"
    },
    "settings": {
      "ocr_system": "standard",
      "extraction_mode": "hybrid",
      "force_url_result": false,
      "return_ocr_data": false,
      "return_images": [],
      "page_range": {
        "start": 123,
        "end": 123
      },
      "timeout": 123,
      "document_password": "<string>"
    }
  }
}
'
{
  "job_id": "<string>"
}

Authorizations

Authorization
string
header
required

API key authentication. Use your Aifano API key (starts with ak_live_) as the Bearer token.

Body

application/json
input
required

The document to process. Accepts: (1) a public URL, (2) a presigned S3 URL, (3) an aifano://file_id from /upload, or (4) a jobid://job_id from a previous /parse call.

schema
object
required
system_prompt
string
async
object
parsing
object

Configuration for the parsing step. Ignored when using jobid:// input.

Response

Job created

job_id
string
required

Job ID for polling via GET /job/{job_id}.