Skip to main content
POST
Submit interaction input

Authorizations

Authorization
string
header
required

Secret key (sk_live_...)

Path Parameters

run_id
string
required

Unique identifier for the task run (prefixed with trun_).

Body

Request body for submitting interaction input to a paused task run.

input
any

Field values matching the interaction's field names. Each key corresponds to a field name from the interaction object (e.g. { "code": "123456" }).

Response

OK

A task run object representing a single execution of a task.

id
string
required

Unique identifier for the task run, prefixed with trun_.

object
string
required

Always task_run.

status
string
required

Run status: queued, running, canceling, interaction_required, review_required, completed, canceled, or failed.

result
null | string
required

Run result after completion: success, failure, or unknown. Null while running.

task_id
string
required

The task that was executed. Prefixed with task_.

trigger_id
null | string
required

The trigger that created this run, if any. Prefixed with trg_. null for runs created directly through the API.

credential_id
null | string
required

The credential used for authentication, if any. Prefixed with cred_.

session_id
null | string
required

The session this run executed within, if any. Prefixed with sess_.

agent_id
string
required

The agent that executed this run. Prefixed with agt_.

source_id
null | string
required

The source this run connected to, if any. Prefixed with src_.

runtime_ms
required

Execution time in milliseconds.

output
null | any
required

Output data produced by the task execution.

errors
null | object[]
required

Error details if the run failed. Same structure as API-level errors.

interaction
null | any
required

Interaction details when the run is paused waiting for user input (e.g. MFA code, security question).

created_at
string<date-time>
required

ISO 8601 timestamp of when the resource was created.

updated_at
string<date-time>
required

ISO 8601 timestamp of when the resource was last updated.

request_id
string
required

Unique identifier for the API request. Include this when contacting support.

input
null | any

Input data provided when the run was created.

tokenized
null | string[]

Names of input fields whose values were tokenized when the run was created. The listed fields are removed from input. Returned alongside input (only when include=input is requested and one or more fields were vaulted); omitted otherwise.

storage
null | object[]

Files captured during the run, each with inline extraction (if any). Returned only when include=storage is requested.

storage_deduplicated
null | object[]

Files skipped by deduplication during the run. Returned only when include=storage_deduplicated is requested and the run's task has storage.deduplication enabled; omitted otherwise. An empty array means deduplication ran and no files were skipped.

artifacts
null | object

Run-level visibility artifacts (screenshots). Returned only when include=artifacts is requested.