---
title: "Get run results"
method: GET
path: "/v2/apps/runs/{run_id}/results"
tags: ["runs"]
---

# Get run results

`GET /v2/apps/runs/{run_id}/results`

Get the results of a completed automation app run.

<Note>
The results from this endpoint are paginated. The `has_more` field in the response indicates if there are more results to fetch and the `file_offset` query parameter can be used to specify the starting point for the next set of results.

For an example of using `file_offset` to fetch all results, see the *Retrieving paginated results* code sample.
</Note>

<Info>

This API operation might return field names that differ from those in the automation 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 automation project are not changed.

</Info>

## Path parameters

- `run_id` string, required

## Query parameters

- `include_review_results` boolean
- `include_confidence_scores` boolean
- `include_validation_results` boolean
- `include_source_info` boolean
- `file_offset` integer

## Headers

- `Authorization` string, required
- `IB-Context` string

## Response `200`

Run results retrieved successfully.

<Note>

If errors occur at the class, field, or document levels, the response status code is `200` and the response body includes error details.

</Note>

- ResultsResponse
  - `id` string — Run ID of the run.
  - `status` 'CANCELLED' | 'COMPLETE' | 'FAILED' | 'PAUSED' | 'RUNNING' | 'STOPPED_AT_CHECKPOINT' — Status of the run. Possible values and meanings: - `CANCELLED` -- A user cancelled the run - `COMPLETE` -- The run successfully completed. A human review completed if it was required. Results are retrievable, but some fields may have failed and have the value `ERROR`. - `FAILED` -- The run failed to complete - `PAUSED` -- This status is reserved for future use - `RUNNING` -- The run is in progress and is not paused - `STOPPED_AT_CHECKPOINT` -- A validation error has paused the run for human review
  - `message` string, nullable — Message about the run.
  - `start_timestamp` integer — When the run started, in Unix time nanoseconds.
  - `finish_timestamp` integer, nullable — When the run finished, in Unix time nanoseconds. `null` if run is still in progress.
  - `batch_id` string — The batch ID used as input for this run, if run using a batch.
  - `files` FileWithDocuments[]
    - `original_file_name` string — The original name of the file processed.
    - `input_file_path` string — The file path of the input file.
    - `documents` Document[] — An array containing each document within the file.
      - `fields` DocumentField[] — A list containing the extracted fields from the document, each with its field name, extracted value, and type. See `<DOCUMENT-FIELD>` structure for details.
        - `field_name` string — The name of the field.
        - `value` string — The extracted value of the field.
        - `type` string — The type of the field.
        - `error_msg` string — The error message for the field.
        - `source_coordinates` FieldSourceCoordinates[]
          - `top_x` string — Top-left X coordinate of the bounding box.
          - `top_y` string — Top-left Y coordinate of the bounding box.
          - `bottom_x` string — Bottom-right X coordinate of the bounding box.
          - `bottom_y` string — Bottom-right Y coordinate of the bounding box.
          - `page_number` integer — Zero-indexed page number of the bounding box.
        - `edit_history` ModificationObject[] — An array containing the history of edits to the field.
          - `timestamp` string, required — Datetime string of the edit history event.
          - `user_id` string, required — User ID of the user who made the edit.
          - `modifications` ModificationObjectModificationsItems[] — List of modifications made in this single edit history event.
            - `message` string, required — Message associated with the edit history modification.
        - `confidence` DocumentFieldConfidence
          - `model` string, nullable — Field confidence. Indicates the model's certainty in predicting results for a given field.
          - `ocr` string, nullable — OCR confidence. Indicates the OCR processor's certainty in digitization accuracy.
        - `validations` DocumentFieldValidations
          - `valid` boolean — Indicates whether the document has passed validation rules pertaining to this field.
          - `alerts` DocumentFieldValidationsAlertsItems[] — Alerts for field-level validation rules. Populated only if the `validations/valid` value is `false`.
            - `alert_level` string — Alert level of the validation failure. Always set to `FAILURE`.
            - `msg` string — Description of alert.
            - `blocked` boolean — If this validation failure is blocking.
            - `type` string — Type of validation alert.
            - `locations` DocumentFieldValidationsAlertsItemsLocationsItems[]
              - …
      - `review_completed` boolean — Indicates whether the document has been marked as reviewed.
      - `class_name` string, nullable — The classification label of the document. `null` if classification is not applicable.
      - `page_numbers` integer[] — An array of the document's page numbers.
      - `page_layouts` PageLayout[] — An array with one entry per page, containing page layout information including page number, width, and height.
        - `page_number` integer, required — Zero-indexed page number.
        - `width` string, required — Width of the page.
        - `height` string, required — Height of the page.
      - `post_processed_paths` string[] — An array of strings, each representing a path to post-processed documents.
      - `post_processed_pdf_path` string — Path to post-processed PDF.
      - `class_edit_history` ModificationObject[] — An array containing the history of edits to the document class.
        - `timestamp` string, required — Datetime string of the edit history event.
        - `user_id` string, required — User ID of the user who made the edit.
        - `modifications` ModificationObjectModificationsItems[] — List of modifications made in this single edit history event.
          - `message` string, required — Message associated with the edit history modification.
      - `validations` DocumentValidations
        - `final_result_pass` boolean — Indicates whether the document has passed all validation rules.
      - `classification_confidence` DocumentClassificationConfidence
        - `model` string, nullable — Classification confidence. Indicates the model's certainty in predicting the class of a document.
  - `keys` ResultsResponseKeys
    - `custom` ResultsResponseKeysCustom — Key/value pairs representing non-secret custom keys set for the run.
  - `case_info` CaseInfo
    - `fields` CaseInfoField[] — A list of cross-class fields captured for this run. Cross-class fields consolidate data extracted from standard fields within a packet.
      - `name` string, required — Name of the cross-class field.
      - `value` string, required — The value of the cross-class field.
      - `input_fields` CaseInputField[] — Only applicable for ranked cross-class fields. Input options the user can choose from when determining the value of this ranked field.
        - `record_index` integer — Index of the document used for the input option
        - `refined_phrase_name` string — Refined phrase name of the input option.
      - `chosen_field` CaseInputField — Input option for ranked cross-class fields.
        - `record_index` integer — Index of the document used for the input option
        - `refined_phrase_name` string — Refined phrase name of the input option.
      - `error_msg` string — Error message for the cross-class field, if any.
      - `edit_history` ModificationObject[] — The history of edits to the cross-class field. Returned when `include_review_results=true`.
        - `timestamp` string, required — Datetime string of the edit history event.
        - `user_id` string, required — User ID of the user who made the edit.
        - `modifications` ModificationObjectModificationsItems[] — List of modifications made in this single edit history event.
          - `message` string, required — Message associated with the edit history modification.
      - `validations` CaseInfoFieldValidations — Validation results for the cross-class field. Returned when `include_validation_results` is `true` and field has cross-class validation results. Cross-class validation ensures data quality and consistency across documents within a packet.
        - `valid` boolean, required — Indicates whether the cross-class field has passed all validation rules.
        - `failures` CaseInfoFieldValidationsFailuresItems[] — Array of validation failures for the cross-class field. Populated only if the `validations/valid` value is `false`.
          - `type` string, required — Type of validation failure (for example, "lambda_code", "all_inputs_match").
          - `msg` string, required — Message describing the validation failure.
  - `review_completed` boolean — Indicates whether the run or document has completed review.
  - `has_more` boolean — Indicates whether additional results are available beyond those included in the current response. Use the `file_offset` query parameter to specify the starting point when fetching the next set of results.

---

[API](https://skmtc.net/instabase/apis/api-reference.md) · [All operations](https://skmtc.net/instabase/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/instabase/api-reference/revisions/3a4f46d48141/schema)