AXaxilioai
agents

Update an agent

Changed on

Changes an agent's name, model, output schema, limits or data toggles; omitted fields are left unchanged. Its revisions change through POST /agents/{agent_id}/revisions.

patch/agents/{agent_id}

Request

Path parameters

agent_idstring uuid required

The agent's id.

Request body

$schemastring uri

A URL to the JSON Schema for this object.

accessibility_enabledboolean

Use accessibility mode for runs. true needs your organization's access to accessibility mode (a 403 whose message starts with accessibility_unavailable without it).

capture_enabledboolean

Capture the media runs produce into the file library.

max_cost_microdollarsinteger

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

max_stepsinteger

Most model steps a run may take.

modelstring

The model instruction runs call, one of GET /models.

namestring

The agent's new name.

output_schemaobject nullable

The JSON Schema a run's result must satisfy. null clears it, so runs take any result.

pause_timeout_secondsinteger

Longest a run waits paused for an answer, in seconds, 60 to 3600.

recording_enabledboolean

Record the screen of runs.

telemetry_enabledboolean

Emit telemetry for runs.

timeout_secondsinteger

Longest a run may take, in seconds, at most 3600.

Example request

{
  "$schema": "/api/v1/AgentUpdateRequest.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

accessibility_enabledboolean required

Runs use accessibility mode, which needs a phone that supports it.

capture_enabledboolean required

Runs capture the media they produce on the phone into the file library.

created_atstring date-time required

When the agent was created.

current_revision_idstring uuid

The revision runs of the agent use. Absent until the agent has one.

idstring uuid required

The agent's id.

last_run_atstring date-time

When a run of the agent last started.

max_cost_microdollarsinteger required

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

max_stepsinteger required

Most model steps a run may take.

modelstring required

The model an instructions revision's runs call, one of GET /models.

namestring required

The agent's name, unique within the organization.

output_schemaobject

The JSON Schema a run's result must satisfy. Absent takes any result.

pause_timeout_secondsinteger required

Longest a run waits paused for an answer, in seconds, before it fails with input_timeout. A pause also ends with the session.

recording_enabledboolean required

Runs record the screen.

telemetry_enabledboolean required

Runs emit telemetry, live and stored.

timeout_secondsinteger required

Longest a run may take, in seconds, within the one-hour session cap.

updated_atstring date-time required

When the agent was last changed.

Example response

{
  "$schema": "/api/v1/Agent.json"
}

Changes