APIAPI Reference
Agents
/agents
List agents for the organization
Authorization
apiKeyAuth AuthorizationBearer <token>
Backend API key for server-to-server calls. Format: sk_live_... or sk_test_...
In: header
Query Parameters
limit?integer
Default
20Range
1 <= value <= 100after?string
before?string
Response Body
application/json
curl -X GET "http://localhost:3002/v1/backend/agents"{
"data": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"goal": "string",
"available_modes": [
"string"
],
"default_mode": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"pagination": {
"has_more": true,
"next_cursor": "string",
"prev_cursor": "string"
}
}/agents/{id}
Get a single agent by ID
Authorization
apiKeyAuth AuthorizationBearer <token>
Backend API key for server-to-server calls. Format: sk_live_... or sk_test_...
In: header
Path Parameters
id*string
Format
uuidResponse Body
application/json
application/json
curl -X GET "http://localhost:3002/v1/backend/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"data": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"goal": "string",
"available_modes": [
"string"
],
"default_mode": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}{
"error": {
"code": "string",
"message": "string"
}
}