Skip to main content
GET
/
persona
List Personas
curl --request GET \
  --url https://cloud.onyx.app/api/persona \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 123,
    "name": "<string>",
    "description": "<string>",
    "tools": [
      {
        "id": 123,
        "name": "<string>",
        "description": "<string>",
        "definition": {},
        "display_name": "<string>",
        "in_code_tool_id": "<string>",
        "custom_headers": [
          "<any>"
        ],
        "passthrough_auth": true
      }
    ],
    "starter_messages": [
      {
        "name": "<string>",
        "message": "<string>"
      }
    ],
    "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_shape": 123,
    "icon_color": "<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>"
    }
  }
]

Authorizations

Authorization
string
header
required

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

Query Parameters

include_deleted
boolean
default:false
persona_ids
integer[]

Response

Successful Response

id
integer
name
string
description
string
tools
ToolSnapshot · object[]
starter_messages
StarterMessage · object[] | null
document_sets
DocumentSetSummary · object[]
llm_model_version_override
string | null
llm_model_provider_override
string | null
uploaded_image_id
string | null
icon_shape
integer | null
icon_color
string | null
is_public
boolean
is_visible
boolean
display_priority
integer | null
is_default_persona
boolean
builtin_persona
boolean
labels
PersonaLabelSnapshot · object[]
owner
object | null
I