curl --request GET \
--url https://cloud.onyx.app/api/persona/{persona_id} \
--header 'Authorization: Bearer <token>'
{
"id": 123,
"name": "<string>",
"description": "<string>",
"is_public": true,
"is_visible": true,
"icon_shape": 123,
"icon_color": "<string>",
"uploaded_image_id": "<string>",
"user_file_ids": [
123
],
"user_folder_ids": [
123
],
"display_priority": 123,
"is_default_persona": true,
"builtin_persona": true,
"starter_messages": [
{
"name": "<string>",
"message": "<string>"
}
],
"tools": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"definition": {},
"display_name": "<string>",
"in_code_tool_id": "<string>",
"custom_headers": [
"<any>"
],
"passthrough_auth": true
}
],
"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,
"search_start_date": "2023-11-07T05:31:56Z",
"prompts": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"system_prompt": "<string>",
"task_prompt": "<string>",
"include_citations": true,
"datetime_aware": true,
"default_prompt": true
}
],
"llm_relevance_filter": false,
"llm_filter_extraction": false
}
curl --request GET \
--url https://cloud.onyx.app/api/persona/{persona_id} \
--header 'Authorization: Bearer <token>'
{
"id": 123,
"name": "<string>",
"description": "<string>",
"is_public": true,
"is_visible": true,
"icon_shape": 123,
"icon_color": "<string>",
"uploaded_image_id": "<string>",
"user_file_ids": [
123
],
"user_folder_ids": [
123
],
"display_priority": 123,
"is_default_persona": true,
"builtin_persona": true,
"starter_messages": [
{
"name": "<string>",
"message": "<string>"
}
],
"tools": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"definition": {},
"display_name": "<string>",
"in_code_tool_id": "<string>",
"custom_headers": [
"<any>"
],
"passthrough_auth": true
}
],
"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,
"search_start_date": "2023-11-07T05:31:56Z",
"prompts": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"system_prompt": "<string>",
"task_prompt": "<string>",
"include_citations": true,
"datetime_aware": true,
"default_prompt": true
}
],
"llm_relevance_filter": false,
"llm_filter_extraction": false
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Successful Response
The response is of type object
.
Was this page helpful?