AXaxilioai
Runs

Resume a paused run

Changed on

Resumes a paused run. action answer (the default) answers its input request with response, which must satisfy the request's response_schema (422 when it does not). action retry runs a code run's failed script again (only for reason step_check_failed). action complete ends the run as completed with output, which must satisfy the run's output schema (422). Returns the run as it is. With answer or retry it reads running once the run's phone has the input, and run.resumed fires then; with complete it reads completed once the run ends on its phone, and run.completed fires then. A run that is not paused, a different input_request_id, or a request that has expired is 409.

post/runs/{run_id}:resume

Request

Path parameters

run_idstring uuid required

The run's id.

Request body

action'answer' | 'retry' | 'complete'

answer (the default) hands the run response; not for reason step_check_failed. retry runs the code run's script again in the same session, from where the phone is now; only for a pause with reason step_check_failed. complete ends the run as completed with output, as if it had returned it.

input_request_idstring uuid required

The input request answered: the run's input_request.id.

messagestring

With answer: a note for the agent with the answer.

modelstring

With answer, for an agent-mode run: the model its next steps call, one of GET /models (default the run's). It becomes the run's model, and its current turn's, once the run resumes; each step keeps the model that answered it.

outputunknown
responseunknown
result_textstring

With complete: a short account of the result.

Response

Accepted

agent_idstring uuid

The agent the run is of; absent on an ad hoc run.

agent_namestring

The agent's name, on the run lists; absent on an ad hoc run.

cancelled_atstring date-time

Timestamp when the run was cancelled.

completed_atstring date-time

Timestamp when the run finished.

created_atstring date-time required

Timestamp when the run record was created.

errorstring

Why the run failed.

idstring uuid required

Run identifier.

keep_alive_expires_atstring date-time

Until when an ended agent-mode run holds its phone: :sendMessage before then continues the run there; after it, start a new run.

max_cost_microdollarsinteger

Most the run's model steps may cost, in microdollars.

max_stepsinteger

Most model steps the run may take.

mode'agent' | 'code' required

agent: an agent works the task through a model. code: the agent's script runs.

modelstring

The model the run's steps call, one of GET /models.

network'restricted' | 'internet'

The network the run's code can reach: restricted reaches the phone only; internet adds the public internet.

outputunknown
output_schemaunknown
pause_timeout_secondsinteger

Longest the run waits paused for an answer, in seconds.

phone_idstring

Phone executing the run.

recording_enabledboolean

An ad hoc run's own recording choice; absent takes the default (off), and a saved agent's run takes the agent's.

result_textstring

A short account of the run's result.

revision_idstring uuid

The agent's revision the run was pinned to when it was made.

run_metadataobject

Arbitrary metadata attached to the run.

schedule_idstring uuid

The schedule that started the run, if one did.

session_idstring uuid

Session associated with this run.

start_atstring date-time

When the run was booked to start; absent for a run started on request.

start_timeout_secondsinteger

How long the queued run may wait for a phone before auto-cancel.

started_atstring date-time

Timestamp when the run began executing.

status'scheduled' | 'queued' | 'running' | 'paused' | 'completed' | 'failed' | 'cancelled' required

Current lifecycle state of the run. paused: the run waits on a person; see input_request.

stream_urlstring

The run's live event stream (Server-Sent Events), with a short-lived read-only token. Server clients can send the API key header instead.

successboolean

Whether the run completed without error.

taskstring

An agent-mode run's task: the ad hoc task, or the agent's instructions.

telemetry_enabledboolean

An ad hoc run's own telemetry choice; absent takes the default (on), and a saved agent's run takes the agent's.

timeout_secondsinteger

Longest the run may take, in seconds.

trace_expired_atstring date-time

When the trace recording was deleted.

trigger'manual' | 'scheduled' | 'api' required

Trigger identifies how the run was initiated.

turninteger

An agent-mode run's current turn, from 1.

updated_atstring date-time required

Timestamp of the last update to the run record.

user_idstring uuid required

User who initiated the run.

variablesobject

The run's inputs. Deleted once the finished run is older than the plan's run data retention window (30 days by default).

video_urlstring

URL for the run recording video.

Changes