Skip to main content
GET
/
api
/
v1
/
custom-agents
/
agents
List Agents
curl --request GET \
  --url https://api.example.com/api/v1/custom-agents/agents \
  --header 'Authorization: Bearer <token>'
[
  {
    "role": "<string>",
    "goal": "<string>",
    "backstory": "<string>",
    "system_prompt": "<string>",
    "id": "<string>",
    "user_id": "<string>",
    "tasks": [
      {
        "description": "<string>",
        "tools": [
          "<string>"
        ],
        "expected_output": "<unknown>",
        "id": 123,
        "mcp_servers": []
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deployment_status": "<string>",
    "deployment_url": "<string>",
    "visibility": "private"
  }
]

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
include_public
boolean
default:true
​
include_shared
boolean
default:true

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>
default:private
Available options:
private,
public,
shared