Skip to main content
GET
/
admin
/
agents
Get Agents Admin Paginated
curl --request GET \
  --url https://cloud.onyx.app/api/admin/agents \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "is_public": true,
      "is_visible": true,
      "uploaded_image_id": "<string>",
      "icon_name": "<string>",
      "user_file_ids": [
        "<string>"
      ],
      "display_priority": 123,
      "is_default_persona": true,
      "builtin_persona": true,
      "starter_messages": [
        {
          "name": "<string>",
          "message": "<string>"
        }
      ],
      "llm_relevance_filter": true,
      "llm_filter_extraction": true,
      "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
        }
      ],
      "labels": [
        {
          "id": 123,
          "name": "<string>"
        }
      ],
      "owner": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "<string>"
      },
      "users": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "email": "<string>"
        }
      ],
      "groups": [
        123
      ],
      "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_provider_override": "<string>",
      "llm_model_version_override": "<string>",
      "num_chunks": 123,
      "system_prompt": "<string>",
      "replace_base_system_prompt": false,
      "task_prompt": "<string>",
      "datetime_aware": true
    }
  ],
  "total_items": 123
}

Documentation Index

Fetch the complete documentation index at: https://danswer-mintlify-deep-research-1773355783.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Authorization header with Bearer token

Query Parameters

​
page_num
integer
default:0

Page number (0-indexed).

Required range: x >= 0
​
page_size
integer
default:10

Items per page.

Required range: 1 <= x <= 1000
​
include_deleted
boolean
default:false

If true, includes deleted personas.

​
get_editable
boolean
default:false

If true, only returns editable personas.

​
include_default
boolean
default:true

If true, includes builtin/default personas.

Response

Successful Response

​
items
PersonaSnapshot · object[]
required
​
total_items
integer
required