Skip to main content
GET
/
api
/
cloud
/
agents
/
{id}
cURL
curl --request GET \
  --url https://api.bedrock.orinlabs.org/api/cloud/agents/{id}/ \
  --header 'Authorization: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "model": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "product": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "adapters": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "timezone": "<string>",
  "system_prompt": "<string>",
  "sleep_until": "2023-11-07T05:31:56Z",
  "email_alias": "<string>",
  "status": "running",
  "run_started_at": "2023-11-07T05:31:56Z",
  "max_turns": -1,
  "summarizer_model": "<string>"
}

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

​
id
string<uuid>
required

A UUID string identifying this Agent.

Response

200 - application/json
​
id
string<uuid>
required
​
name
string
required
Maximum string length: 255
​
model
string
required
Maximum string length: 255
​
created_at
string<date-time>
required
​
product
string<uuid>
required
​
adapters
string<uuid>[]
​
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
Available options:
running,
sleeping
​
run_started_at
string<date-time> | null
​
max_turns
integer
Required range: -2147483648 <= x <= 2147483647
​
summarizer_model
string
Maximum string length: 50