Parse Endpoints

Get Parser Run

Retrieve the status and results of a parser run.

Use this endpoint to get results for a parser run that has already completed, or to check on the status of an asynchronous parser run initiated via the Parse File Asynchronously endpoint.

If parsing is still in progress, you’ll receive a response with just the status. Once complete, you’ll receive the full parsed content in the response.

Path parameters

idstringRequired

The unique identifier for the parser run.

Example: "parser_run_xK9mLPqRtN3vS8wF5hB2cQ"

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-extend-api-versionenumOptional

API version to use for the request. If you do not specify a version, you will either receive a 400 Bad Request or be set to a previous legacy version. See API Versioning for more details.

Allowed values:

Query parameters

responseTypeenumOptional

Controls the format of the response chunks. Defaults to json if not specified.

  • json - Returns chunks with inline content
  • url - Returns chunks with presigned URLs to content instead of inline data
Allowed values:

Response

Successfully retrieved parser run
successboolean
parserRunobject
warningstring or null
Warning message about missing API version header if applicable

Errors