LIlighton
Parse

Get the status and result of an async parse job

Changed on

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

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

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

get/api/v3/parse/{id}

Request

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

Path parameters

idstring required

Public parse job id (e.g. parse_Kg) returned by POST /api/v3/parse with options.async=true. Malformed or unknown tokens return 404.

Response

Async parse job status and (once terminal) result. status is pending/processing while in flight, completed on success, failed on failure. The result and usage blocks are populated only on success; the error block is populated only on failure.

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

Changes

  • 63ecbc61b6a9Revision changes
    • breaking

      added the new path request parameter id

    • info

      api operation id api_v3_parse_retrieve was added

    • info

      the endpoint scheme security bearerAuth was added to the API

    • 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 non-success response with the status

    • info

      added the success response with the status