Extract

Get the status and result of an async extract job

Changed on

Poll for the status and result of an async extract job submitted via POST /api/v3/extract with options.async=true. Returns the same envelope shape as the synchronous extract endpoint once status is completed.

curl https://api.lighton.ai/api/v3/extract/ext_0196e4b2a3c14d5e \
  -H 'Authorization: Bearer $TOKEN'

Pagination: when completed, result.data is paginated with a fixed page size of 15. Use the page query param (1-based) to navigate; result.pagination reports total_items, total_pages, has_next, has_prev.

Recommended polling cadence: 1s for the first 10s, then 5s, capped at 30s. Stop polling once status is in {completed, failed}.

get/api/v3/extract/{job_id}

Request

  • Base URL
    https://api.lighton.ai
  • URL
    https://api.lighton.ai/api/v3/extract/{job_id}
  • Auth
    HTTP bearer

Path parameters

job_idstring required

Query parameters

pageinteger

1-based page index for navigating result.data. Fixed page size of 15 items. An out-of-range page is rejected.

Response

Extract job status (pending, processing, completed, or failed).

idstring required
statusstring required
created_atstring date-time nullable
completed_atstring date-time nullable
processing_time_msinteger nullable

Changes

    • breaking

      added the new path request parameter job_id

    • info

      api operation id api_v3_extract_retrieve was added

    • info

      the endpoint scheme security bearerAuth was added to the API

    • info

      added the new optional query request parameter page

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status