Skip to main content
POST
Create a new assistant

Authorizations

Authorization
string
header
required

Use JWT token for authentication

Body

application/json
name
string
required

Assistant name

Example:

"Customer Support Assistant"

description
string

Assistant description

presets
string

System prompt / instructions

model
string

Default LLM model

provider
string

Default LLM provider

imgUrl
string

Image URL for the assistant

state
enum<string>

Assistant state

Available options:
active,
inactive,
coming_soon
availableToolsGroupsUids
string[]

Tool group UIDs the assistant can use

enabledTools
string[]

Explicit subset of enabled tool names

accessConfiguration
object

Access configuration

widgetConfiguration
object

Widget configuration

memoryDocuments
object[]

Memory documents for RAG

structuredOutput
object

Structured output JSON schema configuration

guardrailsConfiguration
object

Guardrails configuration

codeSnippetIds
string[]

Code snippet IDs

availableSkillIds
string[]

Skill IDs the assistant can use

subagentsIds
string[]

Subagent IDs the assistant can invoke

maxChatMessages
integer

Maximum chat messages in context

maxToolResponseInputTokens
integer

Maximum input tokens for tool responses

contextManagement
object

Context depth control: summarize older turns to reduce the token footprint sent to the model.

Response

Assistant created successfully

_id
string

Assistant ID

identifier
string

Unique identifier

name
string

Assistant name

description
string

Assistant description

presets
string

System prompt / instructions

model
string

Default LLM model

provider
string

Default LLM provider

imgUrl
string

Image URL

state
string

Assistant state

availableToolsGroupsUids
string[]
enabledTools
string[]
accessConfiguration
object
widgetConfiguration
object
memoryDocuments
object[]
structuredOutput
object
guardrailsConfiguration
object
codeSnippetIds
string[]
availableSkillIds
string[]
subagentsIds
string[]
maxChatMessages
integer
maxToolResponseInputTokens
integer
contextManagement
object

Context depth control: summarize older turns to reduce the token footprint sent to the model.

creationTimestampMs
integer

Creation timestamp in milliseconds

lastEditTimestampMs
integer

Last edit timestamp in milliseconds