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>'
import requests

url = "https://cloud.onyx.app/api/admin/agents"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://cloud.onyx.app/api/admin/agents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://cloud.onyx.app/api/admin/agents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://cloud.onyx.app/api/admin/agents"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://cloud.onyx.app/api/admin/agents")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://cloud.onyx.app/api/admin/agents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "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>"
            }
          ],
          "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
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

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