Skip to content

Create extract job

POST/v1/jobs/extract-jobs/

Create an extract job from an existing parse job.

Body

Sent as application/json.

  • parse_job_idstringRequired

    Public ID of the completed parse job to extract data from.

  • schemaobjectRequired

    JSON extraction schema for the extract job.

  • extraction_complexitystring

    Complexity tier for the extraction: low, medium, or high.

    One of low, medium, high

    Default medium

Returns

200 with a JSON object.

Show response attributesHide response attributes
  • detailstringRequired
  • extract_jobobjectRequired
    Show child attributesHide child attributes
    • job_idstringRequired

      Unique job identifier.

    • nicknamestring or null

      Display name you gave the job.

    • processing_statusstringRequired

      Where the job is in its lifecycle: pending (received, being inspected), queued (accepted, waiting to be processed), processing, completed (the result can be downloaded) or failed (the job's error and error_code say why). completed and failed are final.

      One of pending, processing, completed, failed, queued

    • created_atstring or null

      When the job was created.

    • updated_atstring or null

      When the job last changed.

    • processing_time_secondsnumber or null

      Time the job took to process, once it has finished.

    • credits_costnumber

      Credits charged for the job.

    • errorstring or null

      Why the job failed, when it did.

    • error_codestring or null

      Stable error code of a failed job, from the same vocabulary as API errors.

    • file_namestring or null

      Name of the uploaded file, when the job has one.

    • page_countinteger or null

      Pages in the document, once it has been inspected.

    • job_typestringRequired

      One of extract

    • input_job_idstring or nullRequired

      The parse job this extraction reads from.

    • extraction_schemaobjectRequired

      JSON schema that was applied.

    • extraction_complexitystringRequired

      Complexity level the extraction ran with.

      One of low, medium, high

    • billable_unitstring or null

      Unit the job is billed in: page, char, cell or pixel.

    • billable_quantityinteger or null

      Quantity billed, in billable_unit.

Errors

Every error has the same JSON body. See Errors for the error codes and when to retry.

  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 409Conflict
  • 410Gone
  • 413Request Entity Too Large
  • 422Unprocessable Entity
  • 429Too Many Requests
  • 500Internal Server Error