Skip to main content
POST
/
persona
Create Persona
curl --request POST \
  --url https://cloud.onyx.app/api/persona \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "document_set_ids": [
    123
  ],
  "num_chunks": 123,
  "is_public": true,
  "recency_bias": "favor_recent",
  "llm_filter_extraction": true,
  "llm_relevance_filter": true,
  "tool_ids": [
    123
  ],
  "system_prompt": "<string>",
  "task_prompt": "<string>",
  "datetime_aware": true,
  "llm_model_provider_override": "<string>",
  "llm_model_version_override": "<string>",
  "starter_messages": [
    {
      "name": "<string>",
      "message": "<string>"
    }
  ],
  "users": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "groups": [
    123
  ],
  "remove_image": true,
  "uploaded_image_id": "<string>",
  "icon_name": "<string>",
  "search_start_date": "2023-11-07T05:31:56Z",
  "label_ids": [
    123
  ],
  "is_default_persona": false,
  "display_priority": 123,
  "user_file_ids": [
    "<string>"
  ],
  "replace_base_system_prompt": false
}
'
{
  "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
}

Authorizations

Authorization
string
header
required

Authorization header with Bearer token

Body

application/json
name
string
required
description
string
required
document_set_ids
integer[]
required
num_chunks
number
required
is_public
boolean
required
recency_bias
enum<string>
required
Available options:
favor_recent,
base_decay,
no_decay,
auto
llm_filter_extraction
boolean
required
llm_relevance_filter
boolean
required
tool_ids
integer[]
required
system_prompt
string
required
task_prompt
string
required
datetime_aware
boolean
required
llm_model_provider_override
string | null
llm_model_version_override
string | null
starter_messages
StarterMessage · object[] | null
users
string<uuid>[]
groups
integer[]
remove_image
boolean | null
uploaded_image_id
string | null
icon_name
string | null
search_start_date
string<date-time> | null
label_ids
integer[] | null
is_default_persona
boolean
default:false
display_priority
integer | null
user_file_ids
string[] | null
replace_base_system_prompt
boolean
default:false

Response

Successful Response

id
integer
required
name
string
required
description
string
required
is_public
boolean
required
is_visible
boolean
required
uploaded_image_id
string | null
required
icon_name
string | null
required
user_file_ids
string[]
required
display_priority
integer | null
required
is_default_persona
boolean
required
builtin_persona
boolean
required
starter_messages
StarterMessage · object[] | null
required
llm_relevance_filter
boolean
required
llm_filter_extraction
boolean
required
tools
ToolSnapshot · object[]
required
labels
PersonaLabelSnapshot · object[]
required
owner
MinimalUserSnapshot · object
required
users
MinimalUserSnapshot · object[]
required
groups
integer[]
required
document_sets
DocumentSetSummary · object[]
required
llm_model_provider_override
string | null
required
llm_model_version_override
string | null
required
num_chunks
number | null
required
system_prompt
string | null
replace_base_system_prompt
boolean
default:false
task_prompt
string | null
datetime_aware
boolean
default:true