Skip to main content
POST
Create Persona

Authorizations

Authorization
string
header
required

Authorization header with Bearer token

Body

application/json
name
string
required
description
string
required
document_set_ids
integer[]
required
tool_ids
integer[]
required
system_prompt
string
required
task_prompt
string
required
datetime_aware
boolean
required
is_public
boolean | null
default_model_configuration_id
integer | null
starter_messages
StarterMessage · object[] | null
users
string<uuid>[] | null
groups
integer[] | null
remove_image
boolean | null
uploaded_image_id
string | null
icon_name
string | null
search_start_date
string<date-time> | null
label_ids
integer[] | null
display_priority
integer | null
user_file_ids
string[] | null
hierarchy_node_ids
integer[]
document_ids
string[]
replace_base_system_prompt
boolean
default:false

Response

Successful Response

id
integer
required
name
string
required
description
string
required
is_public
boolean
required
uploaded_image_id
string | null
required
icon_name
string | null
required
user_file_ids
string[]
required
display_priority
integer | null
required
builtin_persona
boolean
required
starter_messages
StarterMessage · object[] | null
required
tools
ToolSnapshot · object[]
required
labels
PersonaLabelSnapshot · object[]
required
owner
MinimalUserSnapshot · object | null
required
users
MinimalUserSnapshot · object[]
required
groups
integer[]
required
document_sets
DocumentSetSummary · object[]
required
system_prompt
string | null
replace_base_system_prompt
boolean
default:false
task_prompt
string | null
datetime_aware
boolean
default:true
is_listed
boolean
default_model_configuration_id
integer | null
hierarchy_nodes
HierarchyNodeSnapshot · object[]
attached_documents
AttachedDocumentSnapshot · object[]
sharing_status
enum<string>
Available options:
PRIVATE,
SHARED,
PUBLIC
public_permission
enum<string>
Available options:
EDITOR,
VIEWER