Logo ExelensiaExelensia/Docs
Getting Started
  • Introduction
API Reference
  • Schemas
  • Templates
  • Upload
  • Process
  • Files
  • Results
  • Exports

Results

The Results API returns the structured data extracted from your documents. A result is created automatically when a process job completes. By default, results are returned without their extracted payload — request include_extraction=true (or fetch a single result) to get the full data. To download many results at once, see Exports.

Endpoints

GET /v1/results

Returns a paginated list of extraction results for your team, ordered by creation date (newest first).

Query Parameters

ParameterTypeRequiredDefaultDescription
pagenumberNo1Page number (min: 1)
limitnumberNo20Items per page (min: 1, max: 100)
sort_orderstringNodescSort direction by creation date: asc or desc
created_afterstringNo—ISO 8601 date filter
created_beforestringNo—ISO 8601 date filter
schema_idstringNo—Filter results by schema UUID
include_extractionbooleanNofalseWhen true, includes the full extracted data object in each result

Request

Bash
curl -H "x-api-key: wk_xxxxxxxx.your_secret_here" \
  "https://api.exelensia.com/v1/results?schema_id=019760a0-0001-7000-8000-000000000001&include_extraction=true"

Response (without include_extraction)

JSON
{
  "data": [
    {
      "id": "019760a0-0040-7000-8000-000000000040",
      "filename": "invoice_2024_01.pdf",
      "bytes": 245760,
      "schema_name": "Invoice Schema",
      "created_at": "2024-01-16T09:00:45.000Z"
    }
  ],
  "meta": {
    "total": 1,
    "page": 1,
    "limit": 20,
    "totalPages": 1,
    "hasNextPage": false,
    "hasPrevPage": false
  }
}

Response (with include_extraction=true)

JSON
{
  "data": [
    {
      "id": "019760a0-0040-7000-8000-000000000040",
      "filename": "invoice_2024_01.pdf",
      "bytes": 245760,
      "schema_name": "Invoice Schema",
      "extraction": {
        "invoice_number": "INV-2024-001",
        "issue_date": "2024-01-15",
        "total": 1250.00,
        "vendor_name": "Acme Supplies Inc."
      },
      "created_at": "2024-01-16T09:00:45.000Z"
    }
  ],
  "meta": {
    "total": 1,
    "page": 1,
    "limit": 20,
    "totalPages": 1,
    "hasNextPage": false,
    "hasPrevPage": false
  }
}
FieldDescription
idResult UUID
filenameName of the source file
bytesSize of the source file in bytes
schema_nameName of the schema used, or null
extractionThe extracted data (only when include_extraction=true). Its shape mirrors the schema
created_atWhen the result was created

Status Codes

StatusDescription
200Success
401Missing or invalid authentication

GET /v1/results/:id

Returns a single result by ID, always including the full extraction data.

Path Parameters

ParameterTypeRequiredDescription
idstringYesResult UUID

Request

Bash
curl -H "x-api-key: wk_xxxxxxxx.your_secret_here" \
  "https://api.exelensia.com/v1/results/019760a0-0040-7000-8000-000000000040"

Response

JSON
{
  "id": "019760a0-0040-7000-8000-000000000040",
  "filename": "invoice_2024_01.pdf",
  "bytes": 245760,
  "schema_name": "Invoice Schema",
  "extraction": {
    "invoice_number": "INV-2024-001",
    "issue_date": "2024-01-15",
    "total": 1250.00,
    "vendor_name": "Acme Supplies Inc."
  },
  "created_at": "2024-01-16T09:00:45.000Z"
}

Status Codes

StatusDescription
200Success
401Missing or invalid authentication
404Result not found

On this page

  • Endpoints
  • GET /v1/results
  • GET /v1/results/:id