{"openapi":"3.1.0","info":{"title":"API reference","version":"1.0.0"},"paths":{"/v2/batches":{"post":{"operationId":"createBatch","summary":"Create batch","description":"Create a new batch.\n\n<Note>[Upload files to the batch](/api-sdk/api-reference/batches/add-file-to-batch) in a separate request.</Note>\n","tags":["batches"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer HTTP authentication.","required":true,"schema":{"type":"string"}},{"name":"IB-Context","in":"header","description":"Typically your organization ID. See [Authorization and context identification](/api-sdk/authorization#ib-context-header) for details.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Batch created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/batch"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the batch. Maximum length is 255 characters."},"workspace":{"type":"string","description":"The name of the workspace in which to add the batch. If not specified, the default location is your personal workspace.\n\nWhen making this call from a service account, you must specify a workspace.\n\n<Info>For organization members, if the default drive changes but is still connected, you can still use the batch as input for running an app. However, you can't upload any additional files to the batch. If the default drive is disconnected, you can't use batches stored on that drive as input for any app run.</Info>\n"}},"required":["name"]}}}}},"get":{"operationId":"listBatches","summary":"List batches","description":"Return a list of batches. Use query parameters to filter results.","tags":["batches"],"parameters":[{"name":"workspace","in":"query","description":"Filter to batches in the specified workspace.","required":false,"schema":{"type":"string"}},{"name":"username","in":"query","description":"Filter to batches created by the specified username (user ID).","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"If paginating results, specify how many batches to return.","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"If paginating results, specify the offset of the returned list.","required":false,"schema":{"type":"integer"}},{"name":"Authorization","in":"header","description":"Bearer HTTP authentication.","required":true,"schema":{"type":"string"}},{"name":"IB-Context","in":"header","description":"Typically your organization ID. See [Authorization and context identification](/api-sdk/authorization#ib-context-header) for details.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Batches_listBatches_Response_200"}}}}}}},"/v2/batches/{batch_id}":{"get":{"operationId":"getBatch","summary":"Get batch information","description":"Retrieve information about a batch.","tags":["batches"],"parameters":[{"name":"batch_id","in":"path","description":"The batch ID.","required":true,"schema":{"type":"integer"}},{"name":"Authorization","in":"header","description":"Bearer HTTP authentication.","required":true,"schema":{"type":"string"}},{"name":"IB-Context","in":"header","description":"Typically your organization ID. See [Authorization and context identification](/api-sdk/authorization#ib-context-header) for details.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Batch successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/batchInfo"}}}},"404":{"description":"Batch does not exist, or denied access.","content":{"application/json":{"schema":{"description":"Any type"}}}}}},"delete":{"operationId":"deleteBatch","summary":"Delete batch","description":"Delete a batch and all its files. This is an asynchronous operation that must be [checked for completion](/api-sdk/api-reference/batches/poll-batches-job).","tags":["batches"],"parameters":[{"name":"batch_id","in":"path","description":"The batch ID.","required":true,"schema":{"type":"integer"}},{"name":"Authorization","in":"header","description":"Bearer HTTP authentication.","required":true,"schema":{"type":"string"}},{"name":"IB-Context","in":"header","description":"Typically your organization ID. See [Authorization and context identification](/api-sdk/authorization#ib-context-header) for details.","required":false,"schema":{"type":"string"}}],"responses":{"202":{"description":"Batch deletion request accepted. [Poll the job ID](/api-sdk/api-reference/batches/poll-batches-job) to check completion status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/batchDeletionJobResponse"}}}},"404":{"description":"Batch does not exist.","content":{"application/json":{"schema":{"description":"Any type"}}}}}}},"/v2/batches/{batch_id}/files/{filename}":{"put":{"operationId":"addFileToBatch","summary":"Upload file to batch","description":"Upload a file to a batch or update the contents of a previously uploaded file in a batch.\n\n<Info>Files can be uploaded one at a time and the suggested max size for each file is 10 MB. For larger files, see [Multipart file upload](/api-sdk/api-reference/batches/create-multipart-upload-session).</Info>\n\n<Note>If you upload a password-protected PDF, provide the password when you process the PDF with an AI Hub app. See instructions for configuring the `settings.runtime_config.instabase.pdf.passwords` property for the [Run deployment](/api-sdk/api-reference/runs/run-deployment#request.body.settings.runtime_config.instabase.pdf.passwords) or [Run app](/api-sdk/api-reference/runs/run-app#request.body.settings.runtime_config.instabase.pdf.passwords) operations.</Note>\n","tags":["batches"],"parameters":[{"name":"batch_id","in":"path","description":"The batch ID.","required":true,"schema":{"type":"integer"}},{"name":"filename","in":"path","description":"A user-defined name for the file on the Instabase filesystem. Include the file extension. This doesn't need to be the same as its name on your local filesystem.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer HTTP authentication.","required":true,"schema":{"type":"string"}},{"name":"IB-Context","in":"header","description":"Typically your organization ID. See [Authorization and context identification](/api-sdk/authorization#ib-context-header) for details.","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"File uploaded successfully.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"404":{"description":"Batch with ID <BATCH-ID> does not exist.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}},"delete":{"operationId":"deleteFileFromBatch","summary":"Delete file from batch","description":"Delete a file from a batch.","tags":["batches"],"parameters":[{"name":"batch_id","in":"path","description":"The batch ID.","required":true,"schema":{"type":"integer"}},{"name":"filename","in":"path","description":"The name of the file.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer HTTP authentication.","required":true,"schema":{"type":"string"}},{"name":"IB-Context","in":"header","description":"Typically your organization ID. See [Authorization and context identification](/api-sdk/authorization#ib-context-header) for details.","required":false,"schema":{"type":"string"}}],"responses":{"202":{"description":"File deletion request accepted. Poll the deletion job for completion status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Batches_deleteFileFromBatch_Response_202"}}}},"404":{"description":"Batch does not exist.","content":{"application/json":{"schema":{"description":"Any type"}}}}}}},"/v2/batches/{batch_id}/files":{"get":{"operationId":"listFiles","summary":"List files in a batch","description":"Return a list of files in a batch.","tags":["batches"],"parameters":[{"name":"batch_id","in":"path","description":"The batch ID.","required":true,"schema":{"type":"integer"}},{"name":"page_size","in":"query","description":"The number of files to return in each page.","required":false,"schema":{"type":"integer"}},{"name":"start_token","in":"query","description":"The token to start the list from.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer HTTP authentication.","required":true,"schema":{"type":"string"}},{"name":"IB-Context","in":"header","description":"Typically your organization ID. See [Authorization and context identification](/api-sdk/authorization#ib-context-header) for details.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/listBatchFilesResponse"}}}},"404":{"description":"Batch does not exist, or denied access.","content":{"application/json":{"schema":{"description":"Any type"}}}}}}},"/v2/batches/jobs/{job_id}":{"get":{"operationId":"pollBatchesJob","summary":"Poll batches job","description":"Poll the asynchronous job created when deleting a batch.\n\n<Info>This API operation and SDK method are maintained for backward compatibility, but the functionally identical API operation [poll file operation job status](/api-sdk/api-reference/jobs/job-status) and its corresponding SDK method [client.jobs.status()](/api-sdk/api-reference/jobs/job-status) are preferred.</Info>\n","tags":["batches"],"parameters":[{"name":"job_id","in":"path","description":"The job ID returned by a [Delete batch](/api-sdk/api-reference/batches/delete-batch) request.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer HTTP authentication.","required":true,"schema":{"type":"string"}},{"name":"IB-Context","in":"header","description":"Typically your organization ID. See [Authorization and context identification](/api-sdk/authorization#ib-context-header) for details.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/jobStatusResponse"}}}}}}},"/v2/batches/multipart-upload":{"post":{"operationId":"createMultipartUploadSession","summary":"Start multipart upload session","description":"Start a multipart upload session. Use this endpoint when you need to upload a file larger than 10 MB to a batch.\n\nThe multipart upload process consists of three steps:\n1. Create a multipart upload session (this endpoint)\n2. [Upload file parts](/api-sdk/api-reference/batches/upload-multipart-part) to the session\n3. [Commit the session](/api-sdk/api-reference/batches/commit-multipart-upload-session) to finalize the upload\n","tags":["batches"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer HTTP authentication.","required":true,"schema":{"type":"string"}},{"name":"IB-Context","in":"header","description":"Typically your organization ID. See [Authorization and context identification](/api-sdk/authorization#ib-context-header) for details.","required":false,"schema":{"type":"string"}}],"responses":{"201":{"description":"The multipart upload session was initiated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/multipartUploadSessionResponse"}}}},"404":{"description":"Batch with the specified ID doesn't exist.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"batch_id":{"type":"integer","description":"The batch ID to upload the file to."},"filename":{"type":"string","description":"A file name for the uploaded file on the AI Hub filesystem, including the file extension. Maximum of 255 characters."},"file_size":{"type":"integer","description":"The file size, in bytes. Can be an integer or a string."}},"required":["batch_id","filename","file_size"]}}}}}},"/v2/batches/multipart-upload/sessions/{session_id}/parts/{part_num}":{"put":{"operationId":"uploadMultipartPart","summary":"Upload part to multipart session","description":"Upload part of a file to the multipart upload session. The size of each part must match the `part_size` returned by the [Start multipart upload session](/api-sdk/api-reference/batches/create-multipart-upload-session) call, except for the final part, which can be smaller.\n\nParts must be uploaded with consecutive part numbers starting at 1.\n","tags":["batches"],"parameters":[{"name":"session_id","in":"path","description":"The session ID obtained from the Start multipart upload session response.","required":true,"schema":{"type":"string"}},{"name":"part_num","in":"path","description":"The part number, starting at 1 and increasing consecutively for each part.","required":true,"schema":{"type":"integer"}},{"name":"Authorization","in":"header","description":"Bearer HTTP authentication.","required":true,"schema":{"type":"string"}},{"name":"IB-Context","in":"header","description":"Typically your organization ID. See [Authorization and context identification](/api-sdk/authorization#ib-context-header) for details.","required":false,"schema":{"type":"string"}}],"responses":{"201":{"description":"The part was successfully uploaded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/multipartUploadPartResponse"}}}}},"requestBody":{"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}}},"/v2/batches/multipart-upload/sessions/{session_id}":{"post":{"operationId":"commitMultipartUploadSession","summary":"Commit or abort multipart session","description":"After uploading all parts to a multipart upload session, use this endpoint to commit and close the session, or abort the session.\n\nWhen committing, provide all the uploaded parts in the correct order. When aborting, the session and all uploaded parts are discarded.\n","tags":["batches"],"parameters":[{"name":"session_id","in":"path","description":"The session ID obtained from the Start multipart upload session response.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer HTTP authentication.","required":true,"schema":{"type":"string"}},{"name":"IB-Context","in":"header","description":"Typically your organization ID. See [Authorization and context identification](/api-sdk/authorization#ib-context-header) for details.","required":false,"schema":{"type":"string"}}],"responses":{"201":{"description":"The multipart upload session was successfully committed or aborted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Batches_commitMultipartUploadSession_Response_201"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"$ref":"#/components/schemas/V2BatchesMultipartUploadSessionsSessionIdPostRequestBodyContentApplicationJsonSchemaAction","description":"Set to `commit` to finalize the upload or `abort` to cancel it."},"parts":{"type":"array","items":{"$ref":"#/components/schemas/V2BatchesMultipartUploadSessionsSessionIdPostRequestBodyContentApplicationJsonSchemaPartsItems"},"description":"Required when action is `commit`. List of all uploaded parts in order."}},"required":["action"]}}}}}},"/v2/apps/deployments/{deployment-id}/runs":{"post":{"operationId":"runDeployment","summary":"Run deployment","description":"Run an AI Hub deployment by its deployment ID. The input for the run is specified using a batch ID or file path.\n\n<Info>Use the UI to optionally [configure email notifications or webhooks](/automate/deployments#configuring-notifications) for certain events within the deployed app's lifecycle.</Info>\n\n<Note>Any specified input or output is validated against the context set by the `IB-Context` header.</Note>\n","tags":["runs"],"parameters":[{"name":"deployment-id","in":"path","description":"The deployment ID.\n\n<Tip>Find the deployment ID by opening the deployment in AI Hub and looking at the site URL, such as https<span>://</span>aihub.instabase.com/deployments/**01902d6f-bb35-74cb-bd27-c09b38bbf20a**/runs.</Tip>\n","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer HTTP authentication.","required":true,"schema":{"type":"string"}},{"name":"IB-Context","in":"header","description":"Typically your organization ID. See [Authorization and context identification](/api-sdk/authorization#ib-context-header) for details.","required":false,"schema":{"type":"string"}}],"responses":{"202":{"description":"Successfully initiated an asynchronous operation to run the deployment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/run"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"batch_id":{"type":"integer","description":"Required unless using `input_dir` or `manual_upstream_integration`. The batch ID of a batch created with the [Batches endpoint](/api-sdk/api-reference/batches/create-batch/). All files uploaded to the batch are used as input for the run."},"input_dir":{"type":"string","description":"Required unless using `batch_id` or `manual_upstream_integration`. The path of the input folder in a connected drive or Instabase Drive. See [Specifying file paths](/api-sdk/api-reference/run-reference/)."},"manual_upstream_integration":{"type":"boolean","description":"Use the deployment's upstream integration as a source rather than a `batch_id` or `input_dir`. Requires an upstream integration to be configured for the deployment."},"from_timestamp":{"type":"number","format":"double","description":"Required if `manual_upstream_integration` is true and the upstream integration is a mailbox integration. Specifies the earliest date in Unix time milliseconds from which to pull emails."},"to_timestamp":{"type":"number","format":"double","description":"Required if `manual_upstream_integration` is true and the upstream integration is a mailbox integration. Specifies the latest date in Unix time milliseconds from which to pull emails."},"version":{"type":"string","description":"Version of the app to use. If not specified, defaults to the latest production version."},"output_dir":{"type":"string","description":"Defines a specific location for the output to be saved in a connected drive or Instabase Drive. If defined, overrides the output workspace configured for the deployment. See [Specifying file paths](/api-sdk/api-reference/run-reference)."},"settings":{"$ref":"#/components/schemas/V2AppsDeploymentsDeploymentIdRunsPostRequestBodyContentApplicationJsonSchemaSettings","description":"JSON object containing settings for the deployment run."}}}}}}}},"/v2/apps/runs":{"post":{"operationId":"runApp","summary":"Run app","description":"Run an automation app by its name or app ID. The input for the run can be a batch ID or an input file path.\n\n<Tip>\n\nRunning an automation app via a deployment is generally preferred over running an app directly.\n\nDeployments offer additional features including upstream and downstream integrations, deployment metrics, human review workflows, and secret and configuration management.\n\nLearn more about [deployments](/automate/deployments) to decide if you'd rather use the [Run deployment](/api-sdk/api-reference/runs/run-deployment) API operation.\n\n</Tip>\n\n<Note>Any specified input or output is validated against the context set by the `IB-Context` header.</Note>\n","tags":["runs"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer HTTP authentication.","required":true,"schema":{"type":"string"}},{"name":"IB-Context","in":"header","description":"Typically your organization ID. See [Authorization and context identification](/api-sdk/authorization#ib-context-header) for details.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Run started successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/run"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"app_name":{"type":"string","description":"Required unless using `app_id`. The name of the app to run."},"app_id":{"type":"string","description":"Required unless using `app_name`. The app ID of the app to run.\n\n<Tip>You can find an app ID in the app URL, such as http<span>s://</span>aihub.instabase.com/hub/apps/**528c36e8-ac5b-490d-a41b-7eec9c404b87**.</Tip>\n"},"owner":{"type":"string","description":"The account that generated the app. If not specified, defaults to your AI Hub username.\n\nFor custom apps belonging to you, accept the default. For AI Hub Marketplace apps published by Instabase, specify `instabase`.\n"},"batch_id":{"type":"integer","description":"Required unless using `input_dir`. The batch ID of a batch created with the [Batches endpoint](/api-sdk/api-reference/batches/create-batch/). All files uploaded to the batch are used as input for the run."},"input_dir":{"type":"string","description":"Required unless using `batch_id`. The path of the input folder in a connected drive or Instabase Drive. See [Specifying file paths](/api-sdk/api-reference/run-reference/)."},"version":{"type":"string","description":"Version of the app to use. If not specified, defaults to the latest production version."},"output_workspace":{"type":"string","description":"The workspace in which to run the app. Output saves to the specified workspace. If not defined, the default is your personal workspace.\n\n<Note>Service accounts don't have personal workspaces. If making this call from a service account, you must specify a value for either `output_workspace` or `output_dir`.</Note>\n"},"output_dir":{"type":"string","description":"Defines a specific location for the output to be saved in a connected drive or Instabase Drive. If defined, overrides the `output_workspace` value. See [Specifying file paths](/api-sdk/api-reference/run-reference/)."},"settings":{"$ref":"#/components/schemas/V2AppsRunsPostRequestBodyContentApplicationJsonSchemaSettings","description":"JSON object containing settings for the app run."}}}}}}},"get":{"operationId":"listRuns","summary":"List runs","description":"Return a list of runs. Use query parameters to filter results.","tags":["runs"],"parameters":[{"name":"app_id","in":"query","description":"Filter runs by app ID.","required":false,"schema":{"type":"string"}},{"name":"app_name","in":"query","description":"Filter runs by app name.","required":false,"schema":{"type":"string"}},{"name":"deployment_id","in":"query","description":"Filter runs by deployment ID.","required":false,"schema":{"type":"string"}},{"name":"username","in":"query","description":"Filter runs initiated by the specified user (username).","required":false,"schema":{"type":"string"}},{"name":"run_id","in":"query","description":"Filter specific run by run ID.","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Filter jobs by status, such as COMPLETE, RUNNING, or FAILED.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"output_workspaces","in":"query","description":"Filter runs by the run's output workspace. By default, all runs across all workspaces you have access to are returned, use this query parameter to filter by specific workspace names. You must have access to the named workspaces.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"from_timestamp","in":"query","description":"Filter runs starting from this timestamp. Timestamp in Unix time in seconds. Defaults to 24 hours before the current time.","required":false,"schema":{"type":"integer"}},{"name":"to_timestamp","in":"query","description":"Filter runs up to this timestamp. Timestamp in Unix time in seconds. Defaults to the current time.","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Offset of the first result to return.","required":false,"schema":{"type":"integer"}},{"name":"sort_by","in":"query","description":"Field to sort results by.","required":false,"schema":{"$ref":"#/components/schemas/V2AppsRunsGetParametersSortBy"}},{"name":"order","in":"query","description":"Order of sorting, such as ASCENDING or DESCENDING.","required":false,"schema":{"$ref":"#/components/schemas/V2AppsRunsGetParametersOrder"}},{"name":"Authorization","in":"header","description":"Bearer HTTP authentication.","required":true,"schema":{"type":"string"}},{"name":"IB-Context","in":"header","description":"Typically your organization ID. See [Authorization and context identification](/api-sdk/authorization#ib-context-header) for details.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of all runs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Runs_listRuns_Response_200"}}}}}}},"/v2/apps/runs/{run_id}":{"get":{"operationId":"getRunStatus","summary":"Get run status","description":"Get the status of a run.","tags":["runs"],"parameters":[{"name":"run_id","in":"path","description":"The run ID.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer HTTP authentication.","required":true,"schema":{"type":"string"}},{"name":"IB-Context","in":"header","description":"Typically your organization ID. See [Authorization and context identification](/api-sdk/authorization#ib-context-header) for details.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/run"}}}}}},"delete":{"operationId":"deleteRun","summary":"Delete run","description":"Deletes a specified automation app run and optionally its associated database data, input files, output files, and logs. This is an asynchronous operation that must be [checked for completion](/api-sdk/api-reference/jobs/job-status).\n\n<Warning>Deleting the run's input files also deletes the batch that the run processed.</Warning>\n","tags":["runs"],"parameters":[{"name":"run_id","in":"path","description":"The run ID.","required":true,"schema":{"type":"string"}},{"name":"delete_db_data","in":"query","description":"Delete the run's database data.","required":false,"schema":{"type":"boolean","default":true}},{"name":"delete_input","in":"query","description":"Delete the run's input files.","required":false,"schema":{"type":"boolean","default":true}},{"name":"delete_output","in":"query","description":"Delete the run's output files.","required":false,"schema":{"type":"boolean","default":true}},{"name":"delete_logs","in":"query","description":"Delete the run's logs.","required":false,"schema":{"type":"boolean","default":true}},{"name":"Authorization","in":"header","description":"Bearer HTTP authentication.","required":true,"schema":{"type":"string"}},{"name":"IB-Context","in":"header","description":"Typically your organization ID. See [Authorization and context identification](/api-sdk/authorization#ib-context-header) for details.","required":false,"schema":{"type":"string"}}],"responses":{"202":{"description":"Run deleted successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Runs_deleteRun_Response_202"}}}}}}},"/v2/apps/runs/{run_id}/results":{"get":{"operationId":"getRunResults","summary":"Get run results","description":"Get the results of a completed automation app run.\n\n<Note>\nThe 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.\n\nFor an example of using `file_offset` to fetch all results, see the *Retrieving paginated results* code sample.\n</Note>\n\n<Info>\n\nThis API operation might return field names that differ from those in the automation project.\nThe operation converts field names to valid Python variable names by:\n\n* Allowing only letters, numbers, and underscores\n* Requiring names to start with a letter or underscore\n* Replacing invalid characters with underscores\n* Converting single underscores to double underscores\n\nExamples:\n* `due date` → `due_date`\n* `driver's license` → `driver_s_license`\n* `3rd category` → `_3rd_category`\n* `secret_id` → `secret__id`\n\nThese changes apply only to field names in the API response. The field names in the automation project are not changed.\n\n</Info>\n","tags":["runs"],"parameters":[{"name":"run_id","in":"path","description":"The run ID.","required":true,"schema":{"type":"string"}},{"name":"include_review_results","in":"query","description":"Whether to include human review details in the results. When set to `true`, various human review details are returned.\n\n<Note>The review process can include manually correcting values. This endpoint doesn't support returning the original and corrected values.</Note>\n\nThe following values are returned at the document level (`files/documents/...`):\n\n- `review_completed`\n- `class_edit_history`\n- `class_edit_history/timestamp`\n- `class_edit_history/user_id`\n- `class_edit_history/modifications`\n- `class_edit_history/modifications/message`\n\nThe following values are returned at the field level (`files/documents/fields/...`):\n\n- `edit_history`\n- `edit_history/timestamp`\n- `edit_history/user_id`\n- `edit_history/modifications`\n- `edit_history/modifications/message`\n\nThe following values are returned at the packet level (also known as case level) (`case_info/fields/...`):\n\n- `edit_history`\n- `edit_history/timestamp`\n- `edit_history/user_id`\n- `edit_history/modifications`\n- `edit_history/modifications/message`\n\nSee the response schema for details and descriptions.\n","required":false,"schema":{"type":"boolean","default":false}},{"name":"include_confidence_scores","in":"query","description":"Whether to include confidence scores in the results. When set to `true`, various confidence scores are returned.\n\nThe following values are returned at the document level (`files/documents/...`):\n\n- `classification_confidence`\n\nThe following values are returned at the field level (`files/documents/fields/...`):\n\n- `confidence/model`\n- `confidence/ocr`\n\nSee the response schema for details and descriptions.\n","required":false,"schema":{"type":"boolean","default":false}},{"name":"include_validation_results","in":"query","description":"Whether to include validation status in the results. When set to `true`, various validation results are returned.\n\nThe following values are returned at the document level (`files/documents/...`):\n\n- `validations/final_result_pass`\n\nThe following values are returned at the field level (`files/documents/fields/...`):\n\n- `validations/valid`\n- `validations/alerts`\n\nThe following values are returned at the packet level (also known as case level) (`case_info/fields/...`):\n\n- `validations/valid`\n- `validations/failures`\n\nCross-class validation ensures data quality and consistency across documents within a packet.\n\nSee the response schema for details and descriptions.\n","required":false,"schema":{"type":"boolean","default":false}},{"name":"include_source_info","in":"query","description":"Whether to include source information in the results. When set to `true`, various source details are returned.\n\nThe following values are returned at the document level (`files/documents/...`):\n\n- `post_processed_paths`\n- `post_processed_pdf_path`\n\n   <Note>\n   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.\n   </Note>\n\n- `page_layouts`\n\nThe following values are returned at the field level (`files/documents/fields/...`):\n\n- `source_coordinates/top_x`\n- `source_coordinates/top_y`\n- `source_coordinates/bottom_x`\n- `source_coordinates/bottom_y`\n- `source_coordinates/page_number`\n\nSee the response schema for details and descriptions.\n","required":false,"schema":{"type":"boolean","default":false}},{"name":"file_offset","in":"query","description":"The initial file index to start returning results from. Defaults to `0`.","required":false,"schema":{"type":"integer","default":0}},{"name":"Authorization","in":"header","description":"Bearer HTTP authentication.","required":true,"schema":{"type":"string"}},{"name":"IB-Context","in":"header","description":"Typically your organization ID. See [Authorization and context identification](/api-sdk/authorization#ib-context-header) for details.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Run results retrieved successfully.\n\n<Note>\n\nIf errors occur at the class, field, or document levels, the response status code is `200` and the response body includes error details.\n\n</Note>\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/resultsResponse"}}}}}}},"/v2/jobs/{job_id}":{"get":{"operationId":"jobStatus","summary":"Poll file operation job status","description":"Poll the asynchronous job created during a file operation request such as deleting a batch or file.","tags":["jobs"],"parameters":[{"name":"job_id","in":"path","description":"The job ID returned by a request.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer HTTP authentication.","required":true,"schema":{"type":"string"}},{"name":"IB-Context","in":"header","description":"Typically your organization ID. See [Authorization and context identification](/api-sdk/authorization#ib-context-header) for details.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/jobStatusResponse"}}}}}}},"/v2/aihub/secrets":{"post":{"operationId":"createSecret","summary":"Create secret","description":"Create a new secret in this organization.\n\n<Note>Only organization admins can create secrets.</Note>\n","tags":["secrets"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer HTTP authentication.","required":true,"schema":{"type":"string"}},{"name":"IB-Context","in":"header","description":"Typically your organization ID. See [Authorization and context identification](/api-sdk/authorization#ib-context-header) for details.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Secret created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Secrets_createSecret_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"alias":{"type":"string","description":"Name of the secret."},"description":{"type":"string","description":"Description of the secret."},"value":{"type":"string","description":"Content of the secret."},"allowed_workspaces_type":{"$ref":"#/components/schemas/V2AihubSecretsPostRequestBodyContentApplicationJsonSchemaAllowedWorkspacesType","description":"Which workspaces in this organization are allowed to use this secret in custom functions."},"allowed_workspaces":{"type":"array","items":{"type":"string"},"description":"Which workspaces are allowed to use this secret, if only some are allowed. Required when `allowed_workspaces_type` is `SOME`, otherwise ignored."}},"required":["alias","value","allowed_workspaces_type"]}}}}},"get":{"operationId":"listSecrets","summary":"List secrets","description":"List secrets available to the organization, available to a given workspace, or with a given alias.\n\n<Note>Only organization admins can list all secrets in the organization. Non-admins must specify a workspace.</Note>\n","tags":["secrets"],"parameters":[{"name":"workspace","in":"query","description":"Show secrets available in the specified workspace.\n\n<Info>Only members of a workspace can access secrets that are available within that workspace.</Info>\n","required":false,"schema":{"type":"string"}},{"name":"alias","in":"query","description":"Get the secret with the specified alias.\n","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer HTTP authentication.","required":true,"schema":{"type":"string"}},{"name":"IB-Context","in":"header","description":"Typically your organization ID. See [Authorization and context identification](/api-sdk/authorization#ib-context-header) for details.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of secrets.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Secrets_listSecrets_Response_200"}}}}}},"patch":{"operationId":"updateSecret","summary":"Update secret","description":"Update the description, value, or allowed workspaces for a secret. If a value for a parameter is not specified, it will remain the same.\n\n<Note>Only organization admins can update secrets.</Note>\n","tags":["secrets"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer HTTP authentication.","required":true,"schema":{"type":"string"}},{"name":"IB-Context","in":"header","description":"Typically your organization ID. See [Authorization and context identification](/api-sdk/authorization#ib-context-header) for details.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Secret updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Secrets_updateSecret_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"alias":{"type":"string","description":"Name of the secret to update."},"description":{"type":"string","description":"New description of the secret."},"value":{"type":"string","description":"New content of the secret."},"allowed_workspaces_type":{"$ref":"#/components/schemas/V2AihubSecretsPatchRequestBodyContentApplicationJsonSchemaAllowedWorkspacesType","description":"New designation of which workspaces in this organization are allowed to use this secret in custom functions."},"allowed_workspaces":{"type":"array","items":{"type":"string"},"description":"New designation of which workspaces are allowed to use this secret, if only some are."}},"required":["alias"]}}}}},"delete":{"operationId":"deleteSecret","summary":"Delete secret","description":"Delete a secret from the organization.\n\n<Note>Only organization admins can delete secrets.</Note>\n","tags":["secrets"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer HTTP authentication.","required":true,"schema":{"type":"string"}},{"name":"IB-Context","in":"header","description":"Typically your organization ID. See [Authorization and context identification](/api-sdk/authorization#ib-context-header) for details.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Secret deleted successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Secrets_deleteSecret_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"alias":{"type":"string","description":"Name of the secret to delete."}},"required":["alias"]}}}}}},"/v2/files/{path}":{"get":{"operationId":"readFile","summary":"Read file","description":"Read contents from a file.\n\n<Info>This acts on files in the AI Hub filesystem, not your local filesystem.</Info>\n\n<Note>Ensure the path is accessible within the context defined by the `IB-Context` header.</Note>\n","tags":["files"],"parameters":[{"name":"path","in":"path","description":"Full path to the file.","required":true,"schema":{"type":"string"}},{"name":"expect-node-type","in":"query","description":"Type of node at the target path.","required":true,"schema":{"$ref":"#/components/schemas/V2FilesPathGetParametersExpectNodeType"}},{"name":"Authorization","in":"header","description":"Bearer HTTP authentication.","required":true,"schema":{"type":"string"}},{"name":"IB-Context","in":"header","description":"Typically your organization ID. See [Authorization and context identification](/api-sdk/authorization#ib-context-header) for details.","required":false,"schema":{"type":"string"}},{"name":"Range","in":"header","description":"The portion of the file to read. A single HTTP byte range, with inclusive bounds and a non-negative start value. If not provided, return the entire file. Example: `bytes=0-4`\n","required":false,"schema":{"type":"string"}},{"name":"IB-Retry-Config","in":"header","description":"Configures retry logic if no file is found at the target path. Uses a constant backoff algorithm. Don't retry if this header isn't provided. Example: `{retries:3,backoff-seconds:5}`\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Indicates that the response contains the entire file contents.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}}},"put":{"operationId":"writeFile","summary":"Create or overwrite file","description":"Create a non-empty file or overwrite an existing file.\n\nIf the parent folder of the `path` parameter doesn't exist, the file system creates it before creating the file.\n\n<Info>This acts on files in the AI Hub filesystem, not your local filesystem.</Info>\n\n<Note>Ensure the path is accessible within the context defined by the `IB-Context` header.</Note>\n\nNot all filesystem types support this operation.\n\n| Filesystem           | Supported |\n|----------------------|-----------|\n| Instabase            | ✓         |\n| Amazon S3            | ✓         |\n| Azure Blob Storage   | ✓         |\n| Google Cloud Storage | ✓         |\n| Google Drive         | -         |\n","tags":["files"],"parameters":[{"name":"path","in":"path","description":"Full path to the file.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer HTTP authentication.","required":true,"schema":{"type":"string"}},{"name":"IB-Context","in":"header","description":"Typically your organization ID. See [Authorization and context identification](/api-sdk/authorization#ib-context-header) for details.","required":false,"schema":{"type":"string"}}],"responses":{"201":{"description":"The request succeeded and a new file was created at the target location. AI Hub returns this status code only when the request includes an `If-None-Match` header with a value of `*`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Files_writeFile_Response_201"}}}},"412":{"description":"The request failed because a file exists at the target location that matches the `If-None-Match` header.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}},"head":{"operationId":"getFileMetadata","summary":"Read file or folder metadata","description":"Read metadata of a file or folder at the target path.\n\nThis API operation reports whether the object at the target path is a file or folder. If a file, it also reports the file size and last modification time.\n\n<Info>This acts on files and folders in the AI Hub filesystem, not your local filesystem.</Info>\n\n<Note>Ensure the path is accessible within the context defined by the `IB-Context` header.</Note>\n","tags":["files"],"parameters":[{"name":"path","in":"path","description":"Full path to the file or folder.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer HTTP authentication.","required":true,"schema":{"type":"string"}},{"name":"IB-Context","in":"header","description":"Typically your organization ID. See [Authorization and context identification](/api-sdk/authorization#ib-context-header) for details.","required":false,"schema":{"type":"string"}},{"name":"IB-Retry-Config","in":"header","description":"Configures retry logic if no file or folder is found at the target path. Uses a constant backoff algorithm. Don't retry if this header isn't provided. Example: `{'retries': 3, 'backoff-seconds': 5}`\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved metadata.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Files_getFileMetadata_Response_200"}}}},"404":{"description":"No file or folder was found at the target path.","content":{"application/json":{"schema":{"description":"Any type"}}}}}},"delete":{"operationId":"deleteFileOrFolder","summary":"Delete file or folder","description":"Delete a single file or folder.\n\nThis operation is also available via the SDK method `client.files.delete()`.\n\n<Info>This acts on files in the AI Hub filesystem, not your local filesystem.</Info>\n\n<Note>Ensure the path is accessible within the context defined by the `IB-Context` header.</Note>\n\nNot all filesystem types support this operation.\n\n| Filesystem           | Supported |\n|----------------------|-----------|\n| Instabase            | ✓         |\n| Amazon S3            | ✓         |\n| Azure Blob Storage   | ✓         |\n| Google Cloud Storage | ✓         |\n| Google Drive         | -         |\n","tags":["files"],"parameters":[{"name":"path","in":"path","description":"Full path to the file or folder.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer HTTP authentication.","required":true,"schema":{"type":"string"}},{"name":"IB-Context","in":"header","description":"Typically your organization ID. See [Authorization and context identification](/api-sdk/authorization#ib-context-header) for details.","required":false,"schema":{"type":"string"}}],"responses":{"202":{"description":"Indicates that the deletion request has been accepted. <br/> <Note>The operation returns this status code regardless of whether the file or folder exists.</Note>","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Files_deleteFileOrFolder_Response_202"}}}}}}},"/v1/auditlogs":{"post":{"operationId":"getAuditLogs","summary":"Get audit logs","description":"Retrieve audit logs based on specified filters. Returns a paginated list of audit log entries.\n\n<Note>This API operation is available for Enterprise-tier organizations with single-tenant environments. To use it you must have audit log access permissions. Contact Instabase Support to request access to audit logs for your organization.</Note>\n\n<Note>This API operation is not supported by the SDK but you can access it from Python by making direct REST calls, as shown in the sample code.</Note>\n","tags":["audit"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer HTTP authentication.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved audit logs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Audit_getAuditLogs_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"start":{"type":["integer","null"],"description":"Number of results to skip for pagination"},"size":{"type":["integer","null"],"description":"Maximum number of results to return"},"log_type":{"type":["string","null"],"description":"Type of audit log to filter by. Valid values include:\n- `account_v2`: User account creation logs\n- `api_v2`: API request logs\n- `app_deployment_run_v2`: Deployment run operation logs\n- `app_deployment_v2`: Deployment operation logs\n- `app_v2`: Automation app operation logs\n- `datasource_v2`: Data connection operation logs\n- `login_v2`: User login and authentication logs\n- `oauth2_v2`: OAuth token operation logs\n- `org_v2`: Organization role change logs\n- `org_secrets_v2`: Organization secrets operation logs\n- `perms_v2`: Membership and role change logs, for the organization, workspaces, and groups\n- `projects_v2`: Automation project operation logs\n- `review_v2`: Human review operation logs\n- `workspace_v2`: Workspace management operation logs\n\nFor details about tracked operations, see [Viewing audit logs](/admin/audit-logs/).\n"},"email":{"type":["string","null"],"description":"Filter logs by user email"},"start_time":{"type":["string","null"],"description":"Start time in epoch milliseconds"},"end_time":{"type":["string","null"],"description":"End time in epoch milliseconds"}}}}}}}}},"servers":[{"url":"https://aihub.instabase.com/api","description":"https://aihub.instabase.com/api"}],"components":{"schemas":{"batch":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the batch."}},"required":["id"],"title":"batch"},"batchInfo":{"type":"object","properties":{"id":{"type":"integer","description":"The batch ID."},"name":{"type":"string","description":"The batch name."},"workspace":{"type":"string","description":"The name of the workspace in which the batch exists."},"mount_point":{"type":"string","description":"The name of the connected drive in which the batch is stored."},"repo_owner":{"type":"string","description":"The owner of the workspace (also known as the repo) in which the batch exists."},"batch_owner":{"type":"string","description":"Username of the user that created the batch."},"created_at_ms":{"type":"integer","format":"int64","description":"When the batch was created, in Unix time milliseconds."},"updated_at_ms":{"type":"integer","format":"int64","description":"When the batch was last updated, in Unix time milliseconds."},"path_suffix":{"type":"string","description":"Batch path suffix from the mount point."}},"required":["id","name"],"title":"batchInfo"},"Batches_listBatches_Response_200":{"type":"object","properties":{"batches":{"type":"array","items":{"$ref":"#/components/schemas/batchInfo"},"description":"List of batches. See response schema for each batch object."}},"title":"Batches_listBatches_Response_200"},"batchDeletionJobResponse":{"type":"object","properties":{"job_id":{"type":"string","description":"The job ID of the operation. Use the job ID with the [Poll batches job endpoint](/api-sdk/api-reference/batches/poll-batches-job) to check batch deletion status."}},"required":["job_id"],"title":"batchDeletionJobResponse"},"ListBatchFilesResponseNodesItemsMetadata":{"type":"object","properties":{"node_type":{"type":"string","description":"Type of the node (e.g., 'file')."},"size":{"type":"integer","description":"Size of the file in bytes."},"modified_timestamp":{"type":"integer","description":"Last modification timestamp of the file, in Unix time seconds."}},"description":"Metadata information about the file.","title":"ListBatchFilesResponseNodesItemsMetadata"},"ListBatchFilesResponseNodesItemsPerms":{"type":"object","properties":{"can_read":{"type":"boolean","description":"Whether the user has read permission."},"can_write":{"type":"boolean","description":"Whether the user has write permission."},"can_delete":{"type":"boolean","description":"Whether the user has delete permission."}},"description":"Permission settings for the file.","title":"ListBatchFilesResponseNodesItemsPerms"},"ListBatchFilesResponseNodesItems":{"type":"object","properties":{"full_path":{"type":"string","description":"Complete path to the file in the storage system."},"metadata":{"$ref":"#/components/schemas/ListBatchFilesResponseNodesItemsMetadata","description":"Metadata information about the file."},"perms":{"$ref":"#/components/schemas/ListBatchFilesResponseNodesItemsPerms","description":"Permission settings for the file."},"name":{"type":"string","description":"Name of the file, including optional extension."}},"title":"ListBatchFilesResponseNodesItems"},"listBatchFilesResponse":{"type":"object","properties":{"nodes":{"type":"array","items":{"$ref":"#/components/schemas/ListBatchFilesResponseNodesItems"},"description":"List of files in the batch."},"next_page_token":{"type":"string","description":"Token for retrieving the next page of results."},"has_more":{"type":"boolean","description":"Indicates whether there are more files to be retrieved."}},"title":"listBatchFilesResponse"},"Batches_deleteFileFromBatch_Response_202":{"type":"object","properties":{},"description":"Empty response body","title":"Batches_deleteFileFromBatch_Response_202"},"JobStatusResponseState":{"type":"string","enum":["COMPLETE","FAILED","CANCELLED","RUNNING","PENDING"],"description":"The status of the job.","title":"JobStatusResponseState"},"jobStatusResponse":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/JobStatusResponseState","description":"The status of the job."},"message":{"type":"string","description":"Job status message."}},"title":"jobStatusResponse"},"multipartUploadSessionResponse":{"type":"object","properties":{"session_id":{"type":"string","description":"ID of the multipart upload session."},"part_size":{"type":"integer","description":"The number of bytes each part should be when uploading to the session. Each part should match the part_size, except for the final part, which can be smaller than the part_size."}},"required":["session_id","part_size"],"title":"multipartUploadSessionResponse"},"multipartUploadPartResponse":{"type":"object","properties":{"part_id":{"type":"string","description":"ID of the uploaded part."},"part_num":{"type":"integer","description":"The part number of the uploaded part, indicating upload order. Identical to the part number in the request URL."}},"required":["part_id","part_num"],"title":"multipartUploadPartResponse"},"V2BatchesMultipartUploadSessionsSessionIdPostRequestBodyContentApplicationJsonSchemaAction":{"type":"string","enum":["commit","abort"],"description":"Set to `commit` to finalize the upload or `abort` to cancel it.","title":"V2BatchesMultipartUploadSessionsSessionIdPostRequestBodyContentApplicationJsonSchemaAction"},"V2BatchesMultipartUploadSessionsSessionIdPostRequestBodyContentApplicationJsonSchemaPartsItems":{"type":"object","properties":{"part_num":{"type":"integer","description":"The part number of the uploaded part."},"part_id":{"type":"string","description":"The part ID returned when the part was uploaded."}},"required":["part_num","part_id"],"title":"V2BatchesMultipartUploadSessionsSessionIdPostRequestBodyContentApplicationJsonSchemaPartsItems"},"Batches_commitMultipartUploadSession_Response_201":{"type":"object","properties":{},"description":"Empty response body","title":"Batches_commitMultipartUploadSession_Response_201"},"V2AppsDeploymentsDeploymentIdRunsPostRequestBodyContentApplicationJsonSchemaSettingsKeys":{"type":"object","properties":{"custom":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Configure any custom keys, using key/value pairs. In the key/value pair, define the key as the name of an existing key used in your deployment, and define the value as any custom value.\n\n<Note>Any keys being defined by API should correspond to keys listed under your deployment's *Runtime configuration* settings. For keys included in the `custom` object, match against the keys listed on the **Custom keys** tab of the runtime configuration.</Note>\n"},"secret":{"type":"object","additionalProperties":{"type":"string"},"description":"Configure any secret keys, using key/value pairs. In the key/value pair, define the key as the name of an existing secret key used in your deployment, and define the value as any secret in the organization's secrets vault. For guidance on managing secrets, see [Managing secrets](/admin/secret-management/) or refer to the [Secrets endpoints](/api-sdk/api-reference/secrets/).\n\n<Note>Any keys being defined by API should correspond to keys listed under your deployment's *Runtime configuration* settings. For keys included in the `secret` object, match against the keys listed on the **Secret keys** tab of the runtime configuration.</Note>\n"}},"description":"Define the values for any custom or secret keys configured under your deployment's *Runtime configurations* settings. Key values passed via API override any key values defined in the deployment configuration.\n","title":"V2AppsDeploymentsDeploymentIdRunsPostRequestBodyContentApplicationJsonSchemaSettingsKeys"},"V2AppsDeploymentsDeploymentIdRunsPostRequestBodyContentApplicationJsonSchemaSettingsRuntimeConfigInstabasePdf":{"type":"object","properties":{"passwords":{"type":"object","additionalProperties":{"type":"string"},"description":"A dictionary with titles of encrypted PDF documents as keys and passwords for those documents as values."}},"description":"A dictionary supporting select runtime configurations dealing with PDF input documents.","title":"V2AppsDeploymentsDeploymentIdRunsPostRequestBodyContentApplicationJsonSchemaSettingsRuntimeConfigInstabasePdf"},"V2AppsDeploymentsDeploymentIdRunsPostRequestBodyContentApplicationJsonSchemaSettingsRuntimeConfigInstabase":{"type":"object","properties":{"pdf":{"$ref":"#/components/schemas/V2AppsDeploymentsDeploymentIdRunsPostRequestBodyContentApplicationJsonSchemaSettingsRuntimeConfigInstabasePdf","description":"A dictionary supporting select runtime configurations dealing with PDF input documents."}},"description":"A dictionary supporting select runtime configurations.","title":"V2AppsDeploymentsDeploymentIdRunsPostRequestBodyContentApplicationJsonSchemaSettingsRuntimeConfigInstabase"},"V2AppsDeploymentsDeploymentIdRunsPostRequestBodyContentApplicationJsonSchemaSettingsRuntimeConfig":{"type":"object","properties":{"generate_post_process_pdf":{"type":"boolean","description":"Set to `true` to generate a retrievable PDF for each document the app processes, including separate PDFs for each document created by split classification. PDF generation is supported only for documents less than 100 pages in length.\n\n<Note>When getting run results, use the [`include_source_info` query parameter](/api-sdk/api-reference/runs/get-run-results#request.query.include_source_info.include_source_info) to return the file path for any generated PDFs in your results. File paths are returned under `files/documents/post_processed_pdf_path`.</Note>\n"},"instabase":{"$ref":"#/components/schemas/V2AppsDeploymentsDeploymentIdRunsPostRequestBodyContentApplicationJsonSchemaSettingsRuntimeConfigInstabase","description":"A dictionary supporting select runtime configurations."}},"description":"A dictionary supporting select runtime configurations, such as generating retrievable PDFs of processed documents. For all other runtime configurations, use the `keys` parameter.","title":"V2AppsDeploymentsDeploymentIdRunsPostRequestBodyContentApplicationJsonSchemaSettingsRuntimeConfig"},"V2AppsDeploymentsDeploymentIdRunsPostRequestBodyContentApplicationJsonSchemaSettings":{"type":"object","properties":{"keys":{"$ref":"#/components/schemas/V2AppsDeploymentsDeploymentIdRunsPostRequestBodyContentApplicationJsonSchemaSettingsKeys","description":"Define the values for any custom or secret keys configured under your deployment's *Runtime configurations* settings. Key values passed via API override any key values defined in the deployment configuration.\n"},"runtime_config":{"$ref":"#/components/schemas/V2AppsDeploymentsDeploymentIdRunsPostRequestBodyContentApplicationJsonSchemaSettingsRuntimeConfig","description":"A dictionary supporting select runtime configurations, such as generating retrievable PDFs of processed documents. For all other runtime configurations, use the `keys` parameter."},"tags":{"type":"array","items":{"type":"string"},"description":"List of string tags to attach to this run. Combined length of all tags must not exceed 500 characters.\n"}},"description":"JSON object containing settings for the deployment run.","title":"V2AppsDeploymentsDeploymentIdRunsPostRequestBodyContentApplicationJsonSchemaSettings"},"RunStatus":{"type":"string","enum":["CANCELLED","COMPLETE","FAILED","PAUSED","RUNNING","STOPPED_AT_CHECKPOINT"],"description":"Status of the run. Possible values and meanings:\n- `CANCELLED` -- A user cancelled the run\n- `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`.\n- `FAILED` -- The run failed to complete\n- `PAUSED` -- This status is reserved for future use\n- `RUNNING` -- The run is in progress and is not paused\n- `STOPPED_AT_CHECKPOINT` -- A validation error has paused the run for human review\n","title":"RunStatus"},"run":{"type":"object","properties":{"id":{"type":"string","description":"Run ID of the run."},"status":{"$ref":"#/components/schemas/RunStatus","description":"Status of the run. Possible values and meanings:\n- `CANCELLED` -- A user cancelled the run\n- `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`.\n- `FAILED` -- The run failed to complete\n- `PAUSED` -- This status is reserved for future use\n- `RUNNING` -- The run is in progress and is not paused\n- `STOPPED_AT_CHECKPOINT` -- A validation error has paused the run for human review\n"},"start_timestamp":{"type":"integer","format":"int64","description":"When the run started, in Unix time nanoseconds."},"finish_timestamp":{"type":["integer","null"],"format":"int64","description":"When the run finished, in Unix time nanoseconds. `null` if run is still in progress."},"msg":{"type":["string","null"],"description":"Message about the run."},"batch_id":{"type":["integer","null"],"description":"The batch ID used as input for this run."},"input_dir":{"type":["string","null"],"description":"The path of the input folder used for this run."},"app_id":{"type":["string","null"],"description":"The app ID of the app that was run."},"deployment_id":{"type":["string","null"],"description":"The deployment ID used for this run."},"tags":{"type":["array","null"],"items":{"type":"string"},"description":"List of string tags attached to this run."}},"title":"run"},"V2AppsRunsPostRequestBodyContentApplicationJsonSchemaSettingsKeys":{"type":"object","properties":{"custom":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Configure any custom keys, using key/value pairs. In the key/value pair, define the key as the name of an existing key used in your app, and define the value as any custom value.\n\n<Note>Any keys being defined by API should correspond to keys listed on the app **Overview** page, on the **Keys** tab.</Note>\n"},"secret":{"type":"object","additionalProperties":{"type":"string"},"description":"Configure any secret keys, using key/value pairs. In the key/value pair, define the key as the name of an existing secret key used in your app, and define the value as any secret in the organization's secrets vault. For guidance on managing secrets, see [Managing secrets](/admin/secret-management/) or refer to the [Secrets endpoints](/api-sdk/api-reference/secrets/).\n\n<Note>Any keys being defined by API should correspond to keys listed on the app **Overview** page, on the **Keys** tab.</Note>\n"}},"description":"Configure runtime values for any custom and secret keys referenced in the app. Undefined keys run without a value.\n","title":"V2AppsRunsPostRequestBodyContentApplicationJsonSchemaSettingsKeys"},"V2AppsRunsPostRequestBodyContentApplicationJsonSchemaSettingsRuntimeConfigInstabasePdf":{"type":"object","properties":{"passwords":{"type":"object","additionalProperties":{"type":"string"},"description":"A dictionary with titles of encrypted PDF documents as keys and passwords for those documents as values."}},"description":"A dictionary supporting select runtime configurations dealing with PDF input documents.","title":"V2AppsRunsPostRequestBodyContentApplicationJsonSchemaSettingsRuntimeConfigInstabasePdf"},"V2AppsRunsPostRequestBodyContentApplicationJsonSchemaSettingsRuntimeConfigInstabase":{"type":"object","properties":{"pdf":{"$ref":"#/components/schemas/V2AppsRunsPostRequestBodyContentApplicationJsonSchemaSettingsRuntimeConfigInstabasePdf","description":"A dictionary supporting select runtime configurations dealing with PDF input documents."}},"description":"A dictionary supporting select runtime configurations.","title":"V2AppsRunsPostRequestBodyContentApplicationJsonSchemaSettingsRuntimeConfigInstabase"},"V2AppsRunsPostRequestBodyContentApplicationJsonSchemaSettingsRuntimeConfig":{"type":"object","properties":{"generate_post_process_pdf":{"type":"boolean","description":"Set to `true` to generate a retrievable PDF for each document the app processes, including separate PDFs for each document created by split classification. PDF generation is supported only for documents less than 100 pages in length.\n\n<Note>When getting run results, use the [`include_source_info` query parameter](/api-sdk/api-reference/runs/get-run-results#request.query.include_source_info.include_source_info) to return the file path for any generated PDFs in your results. File paths are returned under `files/documents/post_processed_pdf_path`.</Note>\n"},"instabase":{"$ref":"#/components/schemas/V2AppsRunsPostRequestBodyContentApplicationJsonSchemaSettingsRuntimeConfigInstabase","description":"A dictionary supporting select runtime configurations."}},"description":"A dictionary supporting select runtime configurations, such as generating retrievable PDFs of processed documents. For all other runtime configurations, use the `keys` parameter.","title":"V2AppsRunsPostRequestBodyContentApplicationJsonSchemaSettingsRuntimeConfig"},"V2AppsRunsPostRequestBodyContentApplicationJsonSchemaSettings":{"type":"object","properties":{"keys":{"$ref":"#/components/schemas/V2AppsRunsPostRequestBodyContentApplicationJsonSchemaSettingsKeys","description":"Configure runtime values for any custom and secret keys referenced in the app. Undefined keys run without a value.\n"},"runtime_config":{"$ref":"#/components/schemas/V2AppsRunsPostRequestBodyContentApplicationJsonSchemaSettingsRuntimeConfig","description":"A dictionary supporting select runtime configurations, such as generating retrievable PDFs of processed documents. For all other runtime configurations, use the `keys` parameter."},"tags":{"type":"array","items":{"type":"string"},"description":"List of string tags to attach to this run. Combined length of all tags must not exceed 500 characters.\n"}},"description":"JSON object containing settings for the app run.","title":"V2AppsRunsPostRequestBodyContentApplicationJsonSchemaSettings"},"ResultsResponseStatus":{"type":"string","enum":["CANCELLED","COMPLETE","FAILED","PAUSED","RUNNING","STOPPED_AT_CHECKPOINT"],"description":"Status of the run. Possible values and meanings:\n- `CANCELLED` -- A user cancelled the run\n- `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`.\n- `FAILED` -- The run failed to complete\n- `PAUSED` -- This status is reserved for future use\n- `RUNNING` -- The run is in progress and is not paused\n- `STOPPED_AT_CHECKPOINT` -- A validation error has paused the run for human review\n","title":"ResultsResponseStatus"},"fieldSourceCoordinates":{"type":"object","properties":{"top_x":{"type":"string","title":"float","description":"Top-left X coordinate of the bounding box."},"top_y":{"type":"string","title":"float","description":"Top-left Y coordinate of the bounding box."},"bottom_x":{"type":"string","title":"float","description":"Bottom-right X coordinate of the bounding box."},"bottom_y":{"type":"string","title":"float","description":"Bottom-right Y coordinate of the bounding box."},"page_number":{"type":"integer","description":"Zero-indexed page number of the bounding box."}},"title":"fieldSourceCoordinates"},"ModificationObjectModificationsItems":{"type":"object","properties":{"message":{"type":["string","null"],"description":"Message associated with the edit history modification."}},"title":"ModificationObjectModificationsItems"},"modificationObject":{"type":"object","properties":{"timestamp":{"type":"string","description":"Datetime string of the edit history event."},"user_id":{"type":"string","description":"User ID of the user who made the edit."},"modifications":{"type":"array","items":{"$ref":"#/components/schemas/ModificationObjectModificationsItems"},"description":"List of modifications made in this single edit history event."}},"required":["timestamp","user_id"],"title":"modificationObject"},"DocumentFieldConfidence":{"type":"object","properties":{"model":{"type":["string","null"],"title":"float","description":"Field confidence. Indicates the model's certainty in predicting results for a given field."},"ocr":{"type":["string","null"],"title":"float","description":"OCR confidence. Indicates the OCR processor's certainty in digitization accuracy."}},"title":"DocumentFieldConfidence"},"DocumentFieldValidationsAlertsItemsLocationsItems":{"type":"object","properties":{},"title":"DocumentFieldValidationsAlertsItemsLocationsItems"},"DocumentFieldValidationsAlertsItems":{"type":"object","properties":{"alert_level":{"type":"string","description":"Alert level of the validation failure. Always set to `FAILURE`."},"msg":{"type":"string","description":"Description of alert."},"blocked":{"type":"boolean","description":"If this validation failure is blocking."},"type":{"type":"string","description":"Type of validation alert."},"locations":{"type":"array","items":{"$ref":"#/components/schemas/DocumentFieldValidationsAlertsItemsLocationsItems"}}},"title":"DocumentFieldValidationsAlertsItems"},"DocumentFieldValidations":{"type":"object","properties":{"valid":{"type":"boolean","description":"Indicates whether the document has passed validation rules pertaining to this field."},"alerts":{"type":"array","items":{"$ref":"#/components/schemas/DocumentFieldValidationsAlertsItems"},"description":"Alerts for field-level validation rules. Populated only if the `validations/valid` value is `false`."}},"title":"DocumentFieldValidations"},"documentField":{"type":"object","properties":{"field_name":{"type":"string","description":"The name of the field."},"value":{"type":"string","description":"The extracted value of the field."},"type":{"type":"string","description":"The type of the field."},"error_msg":{"type":"string","description":"The error message for the field."},"source_coordinates":{"type":"array","items":{"$ref":"#/components/schemas/fieldSourceCoordinates"}},"edit_history":{"type":"array","items":{"$ref":"#/components/schemas/modificationObject"},"description":"An array containing the history of edits to the field."},"confidence":{"$ref":"#/components/schemas/DocumentFieldConfidence"},"validations":{"$ref":"#/components/schemas/DocumentFieldValidations"}},"title":"documentField"},"pageLayout":{"type":"object","properties":{"page_number":{"type":"integer","description":"Zero-indexed page number."},"width":{"type":"string","title":"float","description":"Width of the page."},"height":{"type":"string","title":"float","description":"Height of the page."}},"required":["page_number","width","height"],"title":"pageLayout"},"DocumentValidations":{"type":"object","properties":{"final_result_pass":{"type":"boolean","description":"Indicates whether the document has passed all validation rules."}},"title":"DocumentValidations"},"DocumentClassificationConfidence":{"type":"object","properties":{"model":{"type":["string","null"],"title":"float","description":"Classification confidence. Indicates the model's certainty in predicting the class of a document."}},"title":"DocumentClassificationConfidence"},"document":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/documentField"},"description":"A list containing the extracted fields from the document, each with its field name, extracted value, and type. See `<DOCUMENT-FIELD>` structure for details."},"review_completed":{"type":"boolean","description":"Indicates whether the document has been marked as reviewed."},"class_name":{"type":["string","null"],"description":"The classification label of the document. `null` if classification is not applicable."},"page_numbers":{"type":"array","items":{"type":"integer"},"description":"An array of the document's page numbers."},"page_layouts":{"type":"array","items":{"$ref":"#/components/schemas/pageLayout"},"description":"An array with one entry per page, containing page layout information including page number, width, and height."},"post_processed_paths":{"type":"array","items":{"type":"string"},"description":"An array of strings, each representing a path to post-processed documents."},"post_processed_pdf_path":{"type":"string","description":"Path to post-processed PDF."},"class_edit_history":{"type":"array","items":{"$ref":"#/components/schemas/modificationObject"},"description":"An array containing the history of edits to the document class."},"validations":{"$ref":"#/components/schemas/DocumentValidations"},"classification_confidence":{"$ref":"#/components/schemas/DocumentClassificationConfidence"}},"title":"document"},"fileWithDocuments":{"type":"object","properties":{"original_file_name":{"type":"string","description":"The original name of the file processed."},"input_file_path":{"type":"string","description":"The file path of the input file."},"documents":{"type":"array","items":{"$ref":"#/components/schemas/document"},"description":"An array containing each document within the file."}},"title":"fileWithDocuments"},"ResultsResponseKeysCustom":{"type":"object","properties":{},"description":"Key/value pairs representing non-secret custom keys set for the run.","title":"ResultsResponseKeysCustom"},"ResultsResponseKeys":{"type":"object","properties":{"custom":{"$ref":"#/components/schemas/ResultsResponseKeysCustom","description":"Key/value pairs representing non-secret custom keys set for the run."}},"title":"ResultsResponseKeys"},"caseInputField":{"type":"object","properties":{"record_index":{"type":"integer","description":"Index of the document used for the input option"},"refined_phrase_name":{"type":"string","description":"Refined phrase name of the input option."}},"description":"Input option for ranked cross-class fields.","title":"caseInputField"},"CaseInfoFieldValidationsFailuresItems":{"type":"object","properties":{"type":{"type":"string","description":"Type of validation failure (for example, \"lambda_code\", \"all_inputs_match\")."},"msg":{"type":"string","description":"Message describing the validation failure."}},"required":["type","msg"],"title":"CaseInfoFieldValidationsFailuresItems"},"CaseInfoFieldValidations":{"type":"object","properties":{"valid":{"type":"boolean","description":"Indicates whether the cross-class field has passed all validation rules."},"failures":{"type":"array","items":{"$ref":"#/components/schemas/CaseInfoFieldValidationsFailuresItems"},"description":"Array of validation failures for the cross-class field. Populated only if the `validations/valid` value is `false`."}},"required":["valid"],"description":"Validation results for the cross-class field. Returned when `include_validation_results` is `true` and field has cross-class validation results.\n\nCross-class validation ensures data quality and consistency across documents within a packet.\n","title":"CaseInfoFieldValidations"},"caseInfoField":{"type":"object","properties":{"name":{"type":"string","description":"Name of the cross-class field."},"value":{"type":"string","description":"The value of the cross-class field."},"input_fields":{"type":"array","items":{"$ref":"#/components/schemas/caseInputField"},"description":"Only applicable for ranked cross-class fields. Input options the user can choose from\nwhen determining the value of this ranked field.\n"},"chosen_field":{"oneOf":[{"$ref":"#/components/schemas/caseInputField"},{"type":"null"}],"description":"Only applicable for ranked cross-class fields. The input option from `input_fields` that was\nselected for the ranked field's value.\n"},"error_msg":{"type":"string","description":"Error message for the cross-class field, if any."},"edit_history":{"type":"array","items":{"$ref":"#/components/schemas/modificationObject"},"description":"The history of edits to the cross-class field. Returned when `include_review_results=true`."},"validations":{"$ref":"#/components/schemas/CaseInfoFieldValidations","description":"Validation results for the cross-class field. Returned when `include_validation_results` is `true` and field has cross-class validation results.\n\nCross-class validation ensures data quality and consistency across documents within a packet.\n"}},"required":["name","value"],"title":"caseInfoField"},"caseInfo":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/caseInfoField"},"description":"A list of cross-class fields captured for this run. Cross-class fields consolidate data extracted from standard fields within a packet.\n"}},"title":"caseInfo"},"resultsResponse":{"type":"object","properties":{"id":{"type":"string","description":"Run ID of the run."},"status":{"$ref":"#/components/schemas/ResultsResponseStatus","description":"Status of the run. Possible values and meanings:\n- `CANCELLED` -- A user cancelled the run\n- `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`.\n- `FAILED` -- The run failed to complete\n- `PAUSED` -- This status is reserved for future use\n- `RUNNING` -- The run is in progress and is not paused\n- `STOPPED_AT_CHECKPOINT` -- A validation error has paused the run for human review\n"},"message":{"type":["string","null"],"description":"Message about the run."},"start_timestamp":{"type":"integer","format":"int64","description":"When the run started, in Unix time nanoseconds."},"finish_timestamp":{"type":["integer","null"],"format":"int64","description":"When the run finished, in Unix time nanoseconds. `null` if run is still in progress."},"batch_id":{"type":"string","description":"The batch ID used as input for this run, if run using a batch."},"files":{"type":"array","items":{"$ref":"#/components/schemas/fileWithDocuments"}},"keys":{"$ref":"#/components/schemas/ResultsResponseKeys"},"case_info":{"$ref":"#/components/schemas/caseInfo","description":"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`.\n\nCross-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).\n"},"review_completed":{"type":"boolean","description":"Indicates whether the run or document has completed review."},"has_more":{"type":"boolean","description":"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."}},"title":"resultsResponse"},"V2AppsRunsGetParametersSortBy":{"type":"string","enum":["start_timestamp","status"],"title":"V2AppsRunsGetParametersSortBy"},"V2AppsRunsGetParametersOrder":{"type":"string","enum":["ASCENDING","DESCENDING"],"title":"V2AppsRunsGetParametersOrder"},"Runs_listRuns_Response_200":{"type":"object","properties":{"runs":{"type":"array","items":{"$ref":"#/components/schemas/run"}}},"title":"Runs_listRuns_Response_200"},"Runs_deleteRun_Response_202":{"type":"object","properties":{"delete_input_dir_job_id":{"type":["string","null"],"description":"Job ID for deleting the input directory."},"delete_output_dir_job_id":{"type":["string","null"],"description":"Job ID for deleting the output directory."},"delete_log_dir_job_id":{"type":["string","null"],"description":"Job ID for deleting the log directory."}},"title":"Runs_deleteRun_Response_202"},"V2AihubSecretsPostRequestBodyContentApplicationJsonSchemaAllowedWorkspacesType":{"type":"string","enum":["ALL","SOME","NONE"],"description":"Which workspaces in this organization are allowed to use this secret in custom functions.","title":"V2AihubSecretsPostRequestBodyContentApplicationJsonSchemaAllowedWorkspacesType"},"Secrets_createSecret_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Secrets_createSecret_Response_200"},"SecretAllowedWorkspacesType":{"type":"string","enum":["ALL","SOME","NONE"],"description":"Which workspaces in this organization are allowed to use this secret in custom functions.","title":"SecretAllowedWorkspacesType"},"secret":{"type":"object","properties":{"alias":{"type":"string","description":"Name of the secret."},"description":{"type":"string","description":"Description of the secret."},"allowed_workspaces_type":{"$ref":"#/components/schemas/SecretAllowedWorkspacesType","description":"Which workspaces in this organization are allowed to use this secret in custom functions."},"allowed_workspaces":{"type":"array","items":{"type":"string"},"description":"Which workspaces are allowed to use this secret, if only some are allowed."},"org":{"type":"string","description":"The organization name in which this secret was created."},"created_at":{"type":"number","format":"double","description":"When the secret was created in Unix time milliseconds."},"created_by":{"type":"string","description":"The user ID of the user who created the secret."},"updated_at":{"type":"number","format":"double","description":"When the secret was last updated in Unix time milliseconds."},"last_updated_by":{"type":"string","description":"The user ID of the user who last edited the secret."}},"title":"secret"},"Secrets_listSecrets_Response_200":{"type":"object","properties":{"secrets":{"type":"array","items":{"$ref":"#/components/schemas/secret"}}},"title":"Secrets_listSecrets_Response_200"},"V2AihubSecretsPatchRequestBodyContentApplicationJsonSchemaAllowedWorkspacesType":{"type":"string","enum":["ALL","SOME","NONE"],"description":"New designation of which workspaces in this organization are allowed to use this secret in custom functions.","title":"V2AihubSecretsPatchRequestBodyContentApplicationJsonSchemaAllowedWorkspacesType"},"Secrets_updateSecret_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Secrets_updateSecret_Response_200"},"Secrets_deleteSecret_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Secrets_deleteSecret_Response_200"},"V2FilesPathGetParametersExpectNodeType":{"type":"string","enum":["file","folder"],"title":"V2FilesPathGetParametersExpectNodeType"},"Files_writeFile_Response_201":{"type":"object","properties":{},"description":"Empty response body","title":"Files_writeFile_Response_201"},"Files_getFileMetadata_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Files_getFileMetadata_Response_200"},"Files_deleteFileOrFolder_Response_202":{"type":"object","properties":{},"description":"Empty response body","title":"Files_deleteFileOrFolder_Response_202"},"V1AuditlogsPostResponsesContentApplicationJsonSchemaDataResultsItems":{"type":"object","properties":{"timestamp_millis":{"type":"string","description":"Timestamp in epoch milliseconds"},"email":{"type":"string","description":"User email associated with the log entry"},"user_ip":{"type":"string","description":"IP address of the user"},"log_type":{"type":"string","description":"Type of the audit log"}},"title":"V1AuditlogsPostResponsesContentApplicationJsonSchemaDataResultsItems"},"V1AuditlogsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/V1AuditlogsPostResponsesContentApplicationJsonSchemaDataResultsItems"}}},"title":"V1AuditlogsPostResponsesContentApplicationJsonSchemaData"},"Audit_getAuditLogs_Response_200":{"type":"object","properties":{"status":{"type":"string"},"data":{"$ref":"#/components/schemas/V1AuditlogsPostResponsesContentApplicationJsonSchemaData"}},"title":"Audit_getAuditLogs_Response_200"}},"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Bearer HTTP authentication."}}}}