v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-25173140700.7 KB

Assistant

Create an assistant

Create an assistant from a JSON payload.

post/assistants/

Query parameters

cookie_namestring nullable

Request body

namestring required

Display name of the assistant.

modelstring nullable

Name of the LLM model the assistant uses; defaults to the tenant default.

avatarstring nullable

Avatar image reference for the assistant.

descriptionstring nullable

Short description of what the assistant does.

description_show_in_chatboolean

Whether to show the description inside the chat UI.

predefined_promptsstring[] nullable

Suggested starter prompts shown to users.

instructionsstring nullable

System instructions steering the assistant's behavior.

temperaturenumber nullable

Sampling temperature for the assistant's LLM.

similarity_top_knumber nullable

Number of top similar chunks to retrieve for context.

input_type'prompt' | 'form'

Example request

{
  "name": "Support Bot",
  "model": "gpt-4o",
  "avatar": "avatars/support.png",
  "description": "Answers product support questions.",
  "predefined_prompts": [
    "How do I reset my password?"
  ],
  "instructions": "You are a helpful support agent.",
  "temperature": 0.5,
  "similarity_top_k": 5
}

Response

Successful Response

statestring nullable

Current lifecycle state of the record.

state_reasonstring nullable

Optional explanation for the current state.

state_changed_atstring date-time nullable

UTC timestamp when the state last changed.

idinteger nullable

Primary key for the assistant.

tenant_idinteger required

ID of the tenant that owns the assistant.

created_atstring date-time

Timestamp when the assistant was created.

updated_atstring date-time nullable

Timestamp when the assistant was last updated.

creator_user_idinteger required

ID of the user who created the assistant.

namestring required

Name of the assistant.

avatarstring nullable

Avatar image (URL or encoded data) for the assistant.

descriptionstring nullable

Optional description of the assistant.

description_show_in_chatboolean

Whether the assistant description is shown in the chat UI.

instructionsstring nullable

System instructions guiding the assistant's behavior.

llm_catalog_idinteger nullable

ID of the LLM catalog entry used by the assistant.

temperaturenumber nullable

Sampling temperature used by the assistant.

similarity_top_kinteger nullable

Number of top similar documents to retrieve for the assistant.

input_typestring

Input type for the assistant (e.g. prompt or form).

Example response

{
  "state": "NEW",
  "state_reason": "Processing failed: timeout",
  "state_changed_at": "2026-01-16T08:00:00Z",
  "id": 1,
  "tenant_id": 1,
  "created_at": "2026-06-23T12:00:00Z",
  "updated_at": "2026-06-23T12:00:00Z",
  "creator_user_id": 1,
  "name": "Research Assistant",
  "avatar": "https://cdn.example.com/avatar.png",
  "description": "Helps research and summarize documents",
  "predefined_prompts": [
    "Summarize this",
    "List key points"
  ],
  "instructions": "You are a concise research assistant.",
  "llm_catalog_id": 1,
  "temperature": 0.7,
  "similarity_top_k": 5,
  "input_type": "PROMPT",
  "form_fields": [
    {
      "key": "topic",
      "label": "Topic",
      "type": "text"
    }
  ]
}