Skip to main content
GET
/
api
/
v1
/
custom-agents
/
agents
/
{agent_id}
{
  "role": "<string>",
  "goal": "<string>",
  "backstory": "<string>",
  "system_prompt": "<string>",
  "id": "<string>",
  "user_id": "<string>",
  "tasks": [
    {
      "description": "<string>",
      "tools": [
        "<string>"
      ],
      "mcp_servers": [],
      "expected_output": "<any>",
      "id": 123
    }
  ],
  "deployment_url": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "deployment_status": "<string>",
  "visibility": "private"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
agent_id
string
required

Response

Successful Response

​
role
string
required
​
goal
string
required
​
backstory
string
required
​
system_prompt
string
required
​
id
string
required
​
user_id
string
required
​
tasks
Task · object[]
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
deployment_status
string | null
required
​
deployment_url
string | null
​
visibility
enum<string>
Available options:
private,
public,
shared