API referenceRuns

Run deployment

<span class="badge">Commercial & Enterprise</span> Run an AI Hub deployment by its deployment ID. The input for the run is specified using a batch ID or file path. <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> <Note>Any specified input or output is validated against the context set by the `IB-Context` header. For example, if the context is set to your community account, but the batch ID used as input for the run is stored in your organization, the call fails.</Note>

Authentication

AuthorizationBearer
Bearer HTTP authentication.

Path parameters

deployment-idstringRequired
The deployment ID. <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>

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

Request

This endpoint expects an object.
batch_idintegerOptional

Required unless using input_dir or manual_upstream_integration. The batch ID of a batch created with the Batches endpoint. All files uploaded to the batch are used as input for the run.

input_dirstringOptional

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.

manual_upstream_integrationbooleanOptional

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_timestampdoubleOptional

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_timestampdoubleOptional

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.

versionstringOptional
Version of the app to use. If not specified, defaults to the latest production version.
output_dirstringOptional

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.

settingsobjectOptional
JSON object containing settings for the deployment run.

Response

Successfully initiated an asynchronous operation to run the deployment.
idstring
Run ID of the run.
statusenum

Status of the run. Possible values and meanings:

  • CANCELLED — A user cancelled the run
  • COMPLETE — The run successfully completed. A human review completed if it was required. Results are retrievable, but some fields may have failed and have the value ERROR.
  • FAILED — The run failed to complete
  • PAUSED — This status is reserved for future use
  • RUNNING — The run is in progress and is not paused
  • STOPPED_AT_CHECKPOINT — A validation error has paused the run for human review
start_timestamplong
When the run started, in Unix time nanoseconds.
finish_timestamplong or null

When the run finished, in Unix time nanoseconds. null if run is still in progress.

msgstring or null
Message about the run.
batch_idinteger or null
The batch ID used as input for this run.
input_dirstring or null
The path of the input folder used for this run.
app_idstring or null
The app ID of the app that was run.
deployment_idstring or null
The deployment ID used for this run.
tagslist of strings or null
List of string tags attached to this run.