Upcoming change: Onyx is moving to group-based permissions. Curator and Global Curator roles will be removed. See what's changing
curl --request GET \
--url https://cloud.onyx.app/api/agents \
--header 'Authorization: Bearer <token>'{
"items": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"tools": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"definition": {},
"display_name": "<string>",
"in_code_tool_id": "<string>",
"custom_headers": [
"<unknown>"
],
"passthrough_auth": true,
"mcp_server_id": 123,
"user_id": "<string>",
"oauth_config_id": 123,
"oauth_config_name": "<string>",
"enabled": true,
"chat_selectable": true,
"agent_creation_selectable": true,
"default_enabled": false
}
],
"starter_messages": [
{
"name": "<string>",
"message": "<string>"
}
],
"llm_relevance_filter": true,
"llm_filter_extraction": true,
"document_sets": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"cc_pair_summaries": [
{
"id": 123,
"name": "<string>",
"source": "ingestion_api",
"access_type": "public"
}
],
"is_up_to_date": true,
"is_public": true,
"users": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"groups": [
123
],
"federated_connector_summaries": [
{
"id": 123,
"name": "<string>",
"source": "federated_slack",
"entities": {}
}
]
}
],
"llm_model_version_override": "<string>",
"llm_model_provider_override": "<string>",
"uploaded_image_id": "<string>",
"icon_name": "<string>",
"is_public": true,
"is_visible": true,
"display_priority": 123,
"is_default_persona": true,
"builtin_persona": true,
"labels": [
{
"id": 123,
"name": "<string>"
}
],
"owner": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>"
}
}
],
"total_items": 123
}Paginated endpoint for listing agents available to the user.
Returns items for the requested page plus total count. Personas are ordered by display_priority (ASC, nulls last) then by ID (ASC).
NOTE: persona_ids filter is not supported with pagination. Use the non-paginated endpoint if filtering by specific IDs is needed.
curl --request GET \
--url https://cloud.onyx.app/api/agents \
--header 'Authorization: Bearer <token>'{
"items": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"tools": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"definition": {},
"display_name": "<string>",
"in_code_tool_id": "<string>",
"custom_headers": [
"<unknown>"
],
"passthrough_auth": true,
"mcp_server_id": 123,
"user_id": "<string>",
"oauth_config_id": 123,
"oauth_config_name": "<string>",
"enabled": true,
"chat_selectable": true,
"agent_creation_selectable": true,
"default_enabled": false
}
],
"starter_messages": [
{
"name": "<string>",
"message": "<string>"
}
],
"llm_relevance_filter": true,
"llm_filter_extraction": true,
"document_sets": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"cc_pair_summaries": [
{
"id": 123,
"name": "<string>",
"source": "ingestion_api",
"access_type": "public"
}
],
"is_up_to_date": true,
"is_public": true,
"users": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"groups": [
123
],
"federated_connector_summaries": [
{
"id": 123,
"name": "<string>",
"source": "federated_slack",
"entities": {}
}
]
}
],
"llm_model_version_override": "<string>",
"llm_model_provider_override": "<string>",
"uploaded_image_id": "<string>",
"icon_name": "<string>",
"is_public": true,
"is_visible": true,
"display_priority": 123,
"is_default_persona": true,
"builtin_persona": true,
"labels": [
{
"id": 123,
"name": "<string>"
}
],
"owner": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>"
}
}
],
"total_items": 123
}Documentation Index
Fetch the complete documentation index at: https://docs.onyx.app/llms.txt
Use this file to discover all available pages before exploring further.
Authorization header with Bearer token
Page number (0-indexed).
x >= 0Items per page.
1 <= x <= 1000If true, includes deleted personas.
If true, only returns editable personas.
If true, includes builtin/default personas.
Was this page helpful?