Skip to content

Download job result

GET/v1/jobs/{id}/result/

Download the result of a completed job; what you get depends on its job_type:

  • parse: the parsed document (in output_format when given);
  • extract: JSON shaped by your extraction schema;
  • classification: JSON with the document_class and the classified pages;
  • custom: the custom job's result, or with include_extras one ZIP with the result and its extra files under extras/.

Responds with 409 while the job is still processing.

Path parameters

  • idstringRequired

Query parameters

  • include_extrasboolean

    Custom jobs only: return one ZIP with the result and the job's extra files (under extras/) instead of the result alone.

    Default false

  • output_formatstring

    Optional output format override. When set, the result file with the requested extension is retrieved instead of the default. Case-insensitive.

    One of txt, json, html, md, zip

Returns

200 with the file in the response body.

Errors

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

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