Assistants¶

An assistant is an AI agent you configure and deploy. Each assistant belongs to a project and can be used in multiple conversation threads.

Creating an Assistant¶

1. Navigate to Assistants in the sidebar.
2. Click New Assistant.
3. Fill in:
4. Name — a human-readable label (e.g., "Customer Support Bot").
5. Configuration — model, system prompt, tools, and access settings (see below).
6. Public — whether the assistant appears in the public gallery.
7. Click Create.

Configuration Options¶

The assistant's config object controls its behavior. Key settings:

Model¶

Choose which AI model powers the assistant. Supported models include:

• GPT-4o / GPT-4
• Claude 3 (Sonnet, Opus, Haiku)

Set via the model field in config (e.g., "gpt-4", "claude-3").

System Prompt¶

The system prompt defines the assistant's personality and instructions. This is the text that tells the AI how to behave — for example:

"You are a helpful customer support agent for Acme Corp. Be concise and friendly."

Temperature¶

Controls response creativity on a scale from 0.0 (deterministic) to 1.0 (creative). Default is typically 0.7.

Tools¶

Enable integrations the assistant can use during conversations (e.g., web search, calculator, custom tools). Available tools are listed on the Tools page in the dashboard.

File Attachments (RAG)¶

Upload documents to give the assistant domain-specific knowledge. When a user asks a question, the assistant searches your uploaded files and includes relevant passages in its response. See Files & Knowledge Base for details.

Access Modes¶

Access modes control who can interact with your assistant. They are set via the config key type==agent/access_mode:

Using Public Access¶

To embed an assistant in an external platform (like Typebot or a website widget):

1. Set type==agent/access_mode to public_token or public_no_auth in the assistant config.
2. If using public_token, set type==agent/public_token to a secret string of your choice.
3. External clients call the public run endpoint (POST /runs/public) with the assistant ID and token.

When an assistant is configured for public access, it is automatically marked as public.

Managing Assistants¶

• Edit — update the name, config, or public flag at any time. Changes apply to new runs immediately.
• Move to another project — reassign an assistant to a different project.
• Delete — permanently removes the assistant and its uploaded files. Existing threads that used this assistant will no longer be able to create new runs.

API Reference¶

See the full API documentation at /docs#Assistants.

Related Pages¶

• Overview
• Threads & Runs
• Files & Knowledge Base
• Authentication (Integration)