Synchronous Extraction

Extract structured data from a document synchronously as JSON or CSV.

Provide a file://<uuid> URI or public URL. Optionally specify fields to extract via json_options or reference a saved config.

Tip: You can save and reuse extraction settings by creating a config via Create Config. Pass the returned config_id instead of repeating extraction_config each time.

POST /api/v2/extract/sync

cURL

json_fields

curl --request POST \
  --url https://extraction-api.nanonets.com/api/v2/extract/sync \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": "file://a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "extraction_config": {
    "output_format": "json",
    "json_options": [
      "invoice_number",
      "date",
      "total",
      "vendor"
    ]
  }
}
'

200

{
  "success": true,
  "message": "<string>",
  "record_id": "<string>",
  "file_id": "<string>",
  "config_id": "<string>",
  "result": {
    "content": "<string>",
    "elements": [
      {}
    ],
    "overall_confidence": 50,
    "page_confidence": {},
    "confidence_source": "<string>"
  },
  "processing_time": 123,
  "filename": "<string>",
  "output_format": "<string>",
  "file_size": 123
}

Authorizations

Authorization · string · header · required

API key as Bearer token: Authorization: Bearer YOUR_API_KEY

Body

application/json

input · string string[] · required

file://<uuid> URI or public URL. Async accepts a list (max 50).

config_id · string

config://<uuid> of a saved extract config

extraction_config · object

Show child attributes

Response

200

application/json

Extraction completed

success · boolean · required

message · string · required

record_id · string

Job ID for retrieving results

file_id · string

file://<uuid> reference

config_id · string

config://<uuid> reference

status · enum<string>

Available options: completed, processing, failed

result · object

Show child attributes

processing_time · number

Time in seconds

filename · string

output_format · string

file_size · integer

Size in bytes