API referenceRuns

Get run results

Get the results of a completed run.

This API operation might return field names that differ from those in the Build project. The operation converts field names to valid Python variable names by:

  • Allowing only letters, numbers, and underscores
  • Requiring names to start with a letter or underscore
  • Replacing invalid characters with underscores
  • Converting single underscores to double underscores

Examples:

  • due date → due_date
  • driver's license → driver_s_license
  • 3rd category → _3rd_category
  • secret_id → secret__id

These changes apply only to field names in the API response. The field names in the Build project are not changed.

Path parameters

run_idstringRequired

The run ID.

Headers

AuthorizationstringRequired

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

IB-ContextstringOptional

Specify whether to use your community account or organization account to complete the request. To use your community account, define as your user ID. To use your organization account, define as your organization ID. If unspecified, defaults to community account context. See Authorization and context identification for details.

Query parameters

include_review_resultsbooleanOptionalDefaults to false

Whether to include human review details in the results. When set to true, various human review details are returned.

The review process can include manually correcting values. This endpoint doesn’t support returning the original and corrected values.

The following values are returned at the document level (files/documents/...):

  • review_completed
  • class_edit_history
  • class_edit_history/timestamp
  • class_edit_history/user_id
  • class_edit_history/modifications
  • class_edit_history/modifications/message

The following values are returned at the field level (files/documents/fields/...):

  • edit_history
  • edit_history/timestamp
  • edit_history/user_id
  • edit_history/modifications
  • edit_history/modifications/message

See the response schema for details and descriptions.

include_confidence_scoresbooleanOptionalDefaults to false

Whether to include confidence scores in the results. When set to true, various confidence scores are returned.

The following values are returned at the field level (files/documents/fields/...):

  • confidence/model
  • confidence/ocr

See the response schema for details and descriptions.

include_validation_resultsbooleanOptionalDefaults to false

Whether to include validation status in the results. When set to true, various validation results are returned.

The following values are returned at the document level (files/documents/...):

  • validations/final_result_pass

The following values are returned at the field level (files/documents/fields/...):

  • validations/valid
  • validations/alerts

See the response schema for details and descriptions.

include_source_infobooleanOptionalDefaults to false

Whether to include source information in the results. When set to true, various source details are returned.

The following values are returned at the document level (files/documents/...):

  • post_processed_paths

  • post_processed_pdf_path

    A post_processed_pdf_path is populated when the app runs with generate_post_process_pdf=true in its runtime config. Paths to PDFs are generated from each document, with separate PDF paths for documents split during classification.

The following values are returned at the field level (files/documents/fields/...):

  • source_coordinates/top_x
  • source_coordinates/top_y
  • source_coordinates/bottom_x
  • source_coordinates/bottom_y
  • source_coordinates/page_number

See the response schema for details and descriptions.

file_offsetintegerOptionalDefaults to 0

The initial file index to start returning results from. Defaults to 0.

Response

Run results retrieved successfully.

batch_idstringOptional

The batch ID used as input for this run, if run using a batch.

fileslist of objectsOptional
has_morebooleanOptional

Indicates whether additional results are available beyond those included in the current response.

review_completedbooleanOptional

Indicates whether the run or document has completed review.