The Process API submits uploaded files for extraction using a schema. Processing is asynchronous — when you create a process job, it returns immediately with a job record. The actual extraction runs in the background. Poll the Results API to retrieve extracted data once processing completes.
Returns a paginated list of process jobs for your team.
Parameter Type Required Default Description pagenumber No 1 Page number (min: 1) limitnumber No 20 Items per page (min: 1, max: 100) sort_bystring No — Field to sort by (e.g. createdAt) sort_orderstring No descSort direction: asc or desc searchstring No — Search filter created_afterstring No — ISO 8601 date filter created_beforestring No — ISO 8601 date filter fieldsstring No — Comma-separated list of fields to return includestring No — Related resources to include file_idstring No — Filter jobs by a specific file UUID
curl -H "x-api-key: your_api_key_here" \ "https://api.exelensia.com/v1/process?page=1&limit=20" { "data" : [ { "id" : "019760a0-0030-7000-8000-000000000030" , "file_id" : "019760a0-0020-7000-8000-000000000020" , "schema_id" : "019760a0-0001-7000-8000-000000000001" , "status" : "COMPLETED" , "createdAt" : "2024-01-16T09:00:00.000Z" , "updatedAt" : "2024-01-16T09:00:45.000Z" }, { "id" : "019760a0-0031-7000-8000-000000000031" , "file_id" : "019760a0-0021-7000-8000-000000000021" , "schema_id" : "019760a0-0001-7000-8000-000000000001" , "status" : "PENDING" , "createdAt" : "2024-01-16T09:05:00.000Z" , "updatedAt" : "2024-01-16T09:05:00.000Z" } ], "meta" : { "page" : 1 , "limit" : 20 , "total" : 2 , "totalPages" : 1 } } Status Description PENDINGJob queued, waiting to start PROCESSINGExtraction in progress COMPLETEDExtraction finished — results available FAILEDExtraction failed
Status Description 200Success 401Missing or invalid authentication
Creates a new extraction job for a file using a schema. Returns immediately — processing runs asynchronously.
Field Type Required Description file_idstring Yes UUID of the uploaded file (from the Upload API) schema_idstring Yes UUID of the extraction schema to apply
curl -X POST \ -H "x-api-key: your_api_key_here" \ -H "Content-Type: application/json" \ -d '{ "file_id": "019760a0-0020-7000-8000-000000000020", "schema_id": "019760a0-0001-7000-8000-000000000001" }' \ "https://api.exelensia.com/v1/process" { "id" : "019760a0-0030-7000-8000-000000000030" , "file_id" : "019760a0-0020-7000-8000-000000000020" , "schema_id" : "019760a0-0001-7000-8000-000000000001" , "status" : "PENDING" , "createdAt" : "2024-01-16T09:00:00.000Z" , "updatedAt" : "2024-01-16T09:00:00.000Z" }
After submitting, poll GET /v1/results filtered by your schema_id to check when results become available.
Status Description 201Process job created 400Invalid request body 401Missing or invalid authentication 404File or schema not found
