The Results API returns the structured data extracted from your documents. Results are created automatically when a process job completes. Each result is linked to the process job, file, and schema used.
Returns a paginated list of extraction results 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 schema_idstring No — Filter results by schema UUID include_extractionboolean No falseWhen true, includes the full extracted data object in each result
curl -H "x-api-key: your_api_key_here" \ "https://api.exelensia.com/v1/results?schema_id=019760a0-0001-7000-8000-000000000001&include_extraction=true" { "data" : [ { "id" : "019760a0-0040-7000-8000-000000000040" , "process_id" : "019760a0-0030-7000-8000-000000000030" , "file_id" : "019760a0-0020-7000-8000-000000000020" , "schema_id" : "019760a0-0001-7000-8000-000000000001" , "status" : "SUCCESS" , "createdAt" : "2024-01-16T09:00:45.000Z" , "updatedAt" : "2024-01-16T09:00:45.000Z" } ], "meta" : { "page" : 1 , "limit" : 20 , "total" : 1 , "totalPages" : 1 } } { "data" : [ { "id" : "019760a0-0040-7000-8000-000000000040" , "process_id" : "019760a0-0030-7000-8000-000000000030" , "file_id" : "019760a0-0020-7000-8000-000000000020" , "schema_id" : "019760a0-0001-7000-8000-000000000001" , "status" : "SUCCESS" , "extraction" : { "invoice_number" : "INV-2024-001" , "date" : "2024-01-15" , "total" : 1250.00 , "vendor_name" : "Acme Supplies Inc." }, "createdAt" : "2024-01-16T09:00:45.000Z" , "updatedAt" : "2024-01-16T09:00:45.000Z" } ], "meta" : { "page" : 1 , "limit" : 20 , "total" : 1 , "totalPages" : 1 } } Status Description SUCCESSExtraction completed successfully PARTIALSome fields were extracted; others could not be found FAILEDExtraction failed
Status Description 200Success 401Missing or invalid authentication
Returns a single result by ID, always including the full extraction data.
Parameter Type Required Description idstring Yes Result UUID
curl -H "x-api-key: your_api_key_here" \ "https://api.exelensia.com/v1/results/019760a0-0040-7000-8000-000000000040" { "id" : "019760a0-0040-7000-8000-000000000040" , "process_id" : "019760a0-0030-7000-8000-000000000030" , "file_id" : "019760a0-0020-7000-8000-000000000020" , "schema_id" : "019760a0-0001-7000-8000-000000000001" , "status" : "SUCCESS" , "extraction" : { "invoice_number" : "INV-2024-001" , "date" : "2024-01-15" , "total" : 1250.00 , "vendor_name" : "Acme Supplies Inc." }, "createdAt" : "2024-01-16T09:00:45.000Z" , "updatedAt" : "2024-01-16T09:00:45.000Z" } Status Description 200Success 401Missing or invalid authentication 404Result not found
