Skip to main content
PATCH
/
api
/
cloud
/
agents
/
{id}
/
cURL
curl --request PATCH \
  --url https://api.bedrock.orinlabs.org/api/cloud/agents/{id}/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "adapters": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "template": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tags": [
    "<string>"
  ],
  "name": "<string>",
  "model": "<string>",
  "timezone": "<string>",
  "system_prompt": "<string>",
  "sleep_until": "2023-11-07T05:31:56Z",
  "email_alias": "<string>",
  "run_started_at": "2023-11-07T05:31:56Z",
  "last_wake_reason": "<string>",
  "last_wake_interrupted_sleep_until": "2023-11-07T05:31:56Z",
  "max_turns": -1,
  "harness_git_ref": "<string>",
  "debounce_window_seconds": 1073741823,
  "vapi_voice_id": "<string>",
  "parent": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parent_name": "<string>",
  "template_name": "<string>",
  "name": "<string>",
  "model": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "adapters": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "template": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tags": [
    "<string>"
  ],
  "timezone": "<string>",
  "system_prompt": "<string>",
  "sleep_until": "2023-11-07T05:31:56Z",
  "email_alias": "<string>",
  "run_started_at": "2023-11-07T05:31:56Z",
  "last_wake_reason": "<string>",
  "last_wake_interrupted_sleep_until": "2023-11-07T05:31:56Z",
  "max_turns": -1,
  "harness_git_ref": "<string>",
  "debounce_window_seconds": 1073741823,
  "vapi_voice_id": "<string>",
  "parent": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

​
id
string<uuid>
required

A UUID string identifying this Agent.

Body

​
adapters
string<uuid>[]
​
template
string<uuid> | null
​
tags
string[]
Required string length: 1 - 255
​
name
string
Required string length: 1 - 255
​
model
string
Required string length: 1 - 255
​
timezone
string
Required string length: 1 - 255
​
system_prompt
string
​
sleep_until
string<date-time> | null
​
email_alias
string | null

Custom email alias for the agent's AgentMail inbox (e.g. 'support' becomes support@domain)

Maximum string length: 255
​
status
enum<string>
  • running - Running
  • sleeping - Sleeping
  • archived - Archived
Available options:
running,
sleeping,
archived
​
run_started_at
string<date-time> | null
​
last_wake_reason
string
Maximum string length: 64
​
last_wake_interrupted_sleep_until
string<date-time> | null
​
max_turns
integer
Required range: -2147483648 <= x <= 2147483647
​
harness_git_ref
string | null

Optional git ref (branch/tag/commit) for harness runs. Null = latest main at dispatch time.

Maximum string length: 255
​
reasoning_effort
  • none - None
  • minimal - Minimal
  • low - Low
  • medium - Medium
  • high - High
  • xhigh - Extra high
Available options:
none,
minimal,
low,
medium,
high,
xhigh
​
debounce_window_seconds
integer | null

Per-agent override for the turn-boundary debounce window (seconds). Leave blank to inherit from the template.

Required range: 0 <= x <= 2147483647
​
vapi_voice_id
string

Cartesia voice ID for inbound VAPI calls. When empty, the platform default voice is used.

Maximum string length: 255
​
purpose
enum<string>
  • production - Production
  • eval - Eval
  • dev - Dev
Available options:
production,
eval,
dev
​
parent
string<uuid> | null

Response

200 - application/json
​
id
string<uuid>
required
read-only
​
organization
string<uuid>
required
read-only
​
parent_name
string
required
read-only
​
template_name
string | null
required
read-only
​
name
string
required
Maximum string length: 255
​
model
string
required
Maximum string length: 255
​
created_at
string<date-time>
required
read-only
​
adapters
string<uuid>[]
​
template
string<uuid> | null
​
tags
string[]
Maximum string length: 255
​
timezone
string
Maximum string length: 255
​
system_prompt
string
​
sleep_until
string<date-time> | null
​
email_alias
string | null

Custom email alias for the agent's AgentMail inbox (e.g. 'support' becomes support@domain)

Maximum string length: 255
​
status
enum<string>
  • running - Running
  • sleeping - Sleeping
  • archived - Archived
Available options:
running,
sleeping,
archived
​
run_started_at
string<date-time> | null
​
last_wake_reason
string
Maximum string length: 64
​
last_wake_interrupted_sleep_until
string<date-time> | null
​
max_turns
integer
Required range: -2147483648 <= x <= 2147483647
​
harness_git_ref
string | null

Optional git ref (branch/tag/commit) for harness runs. Null = latest main at dispatch time.

Maximum string length: 255
​
reasoning_effort
  • none - None
  • minimal - Minimal
  • low - Low
  • medium - Medium
  • high - High
  • xhigh - Extra high
Available options:
none,
minimal,
low,
medium,
high,
xhigh
​
debounce_window_seconds
integer | null

Per-agent override for the turn-boundary debounce window (seconds). Leave blank to inherit from the template.

Required range: 0 <= x <= 2147483647
​
vapi_voice_id
string

Cartesia voice ID for inbound VAPI calls. When empty, the platform default voice is used.

Maximum string length: 255
​
purpose
enum<string>
  • production - Production
  • eval - Eval
  • dev - Dev
Available options:
production,
eval,
dev
​
parent
string<uuid> | null