Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Enter your API key as the bearer token. Set header: Authorization to Bearer <api_key>

Body

application/json
connector_id
string
required

ID of the connector to execute.

arguments
object

Arguments to pass to the connector. Optional if the connector does not require any arguments.

secret_bindings
object

Mapping of secret slot names to secret IDs. Each slot defined in the connector's required_secrets must be mapped to a user-owned secret.

async
boolean
default:false

When true, return immediately with a pending run; poll retrieveRun for the result.

max_timeout_s
integer
default:300

Maximum execution time in seconds before the run is timed out.

Required range: 1 <= x <= 3600

Response

Successful response

id
string
required

Unique identifier for the object.

connector_id
string
required

ID of the connector executed in this run.

arguments
object
required

Arguments in this run for the connector's input parameters.

status
enum<string>
required

Lifecycle status of the run: pending, running, success, connector_error, timed_out, result_too_large, or internal_error. connector_error means the connector's code failed (see error); timed_out and internal_error are platform outcomes worth retrying; result_too_large is not retryable as-is.

Available options:
pending,
running,
success,
connector_error,
timed_out,
result_too_large,
internal_error
result_json
string | null
required

Execution result of the run. In JSON, matching the connector's output schema. Limited to 100MB; results above 100MB will be truncated and result in a result_too_large status.

error
RunError · object | null
required

Why the run failed. Present iff status is connector_error; for platform failures the status itself is the reason.

has_logs
boolean
required

Whether the run has associated logs

created_at
string<date-time>
required

Timestamp when the object was created.

finished_at
string<date-time> | null
required

Timestamp when the object was last updated.

secret_bindings
object

Secrets to use for this run. This dict must be a mapping of secret slot names to secret IDs.