Get run results | Instabase AI Hub Documentation

Get the results of a completed automation app run.

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.

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.

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>

Authentication

AuthorizationBearer

Bearer HTTP authentication.

Path parameters

run_idstringRequired

The run ID.

Headers

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.

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](/api-sdk/authorization#ib-context-header) 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

The following values are returned at the packet level (also known as case level) (case_info/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.

Whether to include human review details in the results. When set to `true`, various human review details are returned. <Note>The review process can include manually correcting values. This endpoint doesn't support returning the original and corrected values.</Note> 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` The following values are returned at the packet level (also known as case level) (`case_info/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 document level (files/documents/...):

classification_confidence

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

confidence/model
confidence/ocr

See the response schema for details and descriptions.

Whether to include confidence scores in the results. When set to `true`, various confidence scores are returned. The following values are returned at the document level (`files/documents/...`): - `classification_confidence` 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

The following values are returned at the packet level (also known as case level) (case_info/fields/...):

validations/valid
validations/failures

Cross-class validation ensures data quality and consistency across documents within a packet.

See the response schema for details and descriptions.

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` The following values are returned at the packet level (also known as case level) (`case_info/fields/...`): - `validations/valid` - `validations/failures` Cross-class validation ensures data quality and consistency across documents within a packet. 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 settings/runtime_config/generate_post_process_pdf=true. 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.

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` <Note> A `post_processed_pdf_path` is populated when `settings/runtime_config/generate_post_process_pdf=true`. Paths to PDFs are generated from each document, with separate PDF paths for documents split during classification. </Note> 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.

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

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>

batch_idstring or null

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

fileslist of objects or null

keysobject or null

has_moreboolean or null

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.

case_infoobject or null

Packet-level information (also known as case-level information) captured for the run, including optional edit history per cross-class field when include_review_results=true.

Cross-class fields consolidate data extracted from standard fields within a packet. For more information about packets and cross-class fields, see Extracting data from packets.

Packet-level information (also known as case-level information) captured for the run, including optional edit history per cross-class field when `include_review_results=true`. Cross-class fields consolidate data extracted from standard fields within a packet. For more information about packets and cross-class fields, see [Extracting data from packets](/automate/packet-schema).

review_completedboolean or null

Indicates whether the run or document has completed review.

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

The following values are returned at the packet level (also known as case level) (case_info/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.

1	from aihub import AIHub
2
3	client = AIHub(api_root="https://aihub.instabase.com/api",
4	api_key="abcdefghijklmnopqrst1234567890",
5	ib_context="john.doe_acme.com")
6
7	results = client.apps.runs.results(
8	run_id="a1b2c3d4-e5f6-7890-abcd-ef1234567890")
9	print(f"Retrieved results from {len(results.files)} files")

1	{
2	"batch_id": "1235",
3	"files": [
4	{
5	"original_file_name": "test.png",
6	"input_file_path": "instabase-sandbox-org/test-org/fs/Instabase Drive/app-runs/1234-1235/input/test.png",
7	"documents": [
8	{
9	"fields": [
10	{
11	"field_name": "employers_address_and_ZIP_code",
12	"value": "123 STREET RD ANYWHERE, USA,12345",
13	"type": "TEXT"
14	}
15	],
16	"class_name": "Wage And Tax Statement",
17	"page_numbers": [
18	1,
19	2
20	]
21	}
22	]
23	},
24	{
25	"original_file_name": "test2.png",
26	"input_file_path": "instabase-sandbox-org/test-org/fs/Instabase Drive/app-runs/1234-1235/input/test2.png",
27	"documents": [
28	{
29	"fields": [
30	{
31	"field_name": "sex",
32	"value": "Male",
33	"type": "TEXT"
34	}
35	],
36	"class_name": "Driver License",
37	"page_numbers": [
38	1
39	]
40	}
41	]
42	}
43	],
44	"keys": [
45	{
46	"custom": {}
47	}
48	],
49	"has_more": false,
50	"case_info": {
51	"fields": [
52	{
53	"name": "Employee_Address",
54	"value": "123 STREET RD ANYWHERE, USA,12345",
55	"input_fields": [
56	{
57	"record_index": 0,
58	"refined_phrase_name": "employers_address_and_ZIP_code"
59	}
60	],
61	"chosen_field": {
62	"record_index": 0,
63	"refined_phrase_name": "employers_address_and_ZIP_code"
64	},
65	"edit_history": [
66	{
67	"timestamp": "08/27/2025 00:58:39",
68	"user_id": "john.doe_instabase.com",
69	"modifications": [
70	{
71	"message": "Edited to \"123 STREET RD ANYWHERE, USA,12345\""
72	}
73	]
74	}
75	]
76	},
77	{
78	"name": "Sex",
79	"value": "Male",
80	"input_fields": [
81	{
82	"record_index": 0,
83	"refined_phrase_name": "sex"
84	}
85	],
86	"chosen_field": {
87	"record_index": 0,
88	"refined_phrase_name": "sex"
89	}
90	}
91	]
92	}
93	}