
How It Works
When you open the Chat home screen, category pills appear below the input box. Each pill represents a prompt category. Clicking a category opens a panel with all available prompts in that category.Choose a category
Click on one of the category pills below the input box (e.g., Write, Learn, Code).A floating panel opens with the list of prompts available in that category.
Preview a prompt
Hover over any prompt in the list. The first line of the prompt template is previewed directly in the input box, so you can see what it will send before committing.
Default Categories
The Prompt Library ships with the following default categories, each containing ready-to-use templates. The list is shared per deployment and can be customized through the Category Management API below — translate the labels, add a new pill, or remove one you don’t want.Write
Professional writing and communication: executive summaries, client emails, meeting notes, business proposals, release notes.
Learn
Knowledge extraction and understanding: explain a concept, summarize a document, compare options, industry briefs, Q&A generation.
Code
Software development assistance: code review, debugging, API design, SQL query building, test case generation.
Coach
Professional guidance and mentoring: constructive feedback, presentation prep, difficult conversations, career strategy, interview preparation.
Brainstorm
Ideation and creative problem solving: idea generation, SWOT analysis, user stories, name generation, risk assessment.
Prompt Scopes
Prompts can live at three different scopes. Users always see the union of the scopes that apply to them.| Scope | Visible to | Editable by | Use case |
|---|---|---|---|
| Global | Everyone on the platform | Platform administrators only | Curated, expert-crafted templates shipped with the product |
| Organization | All users in that organization | Organization administrators | Org-specific prompts (internal style guides, company processes) |
| Agent | Users interacting with that specific agent | Agent owners | Prompts that only make sense for one agent (e.g. an HR-onboarding agent’s intake questions) |
Prompt Template Structure
Each prompt template includes:| Field | Description |
|---|---|
| Name | Unique slug used to identify the prompt (e.g. write-executive-summary) |
| Title | Short, descriptive name shown in the category panel |
| Description | Brief explanation of what the prompt does |
| Content | The full prompt text, crafted with expert instructions for the AI |
| Arguments | Placeholders you can fill in (e.g., topic, context, code) |
| Category | The category pill it appears under |
| Tags | Searchable keywords for discovery |
| Scope | Which agents or organization the prompt belongs to |
Example: Using a Prompt Template
Here’s a typical workflow using the Write > Executive Summary prompt:- Click the Write category pill
- Click Executive Summary in the panel
- The input box fills with the prompt template
- Replace the placeholder with your topic or paste your document content
- Press Enter to get a professional executive summary
Agents Using Prompts as Tools
Beyond the Chat home screen, agents themselves can call the Prompt Library at runtime. The library exposes aprompt_library tool that an agent can use to:
- Search for relevant prompts by keywords or category
- Fetch a specific prompt by name
- Apply the prompt’s expert guidance to its own answer
- The user’s organization prompts
- Global prompts
- The current agent’s own prompts (if any)
For Administrators
The Prompt Library is fully manageable through a public REST API. Each operation is authenticated and scoped to the caller’s organization.List & search
Paginated listing with filters by category and agent. Returns total count, page, and limit.
Create
Add a new prompt scoped to your organization, optionally pinned to a specific agent.
Update
Edit any field of an organization prompt — title, content, arguments, category, tags, or enabled state.
Delete
Remove an organization prompt. Global prompts cannot be deleted via the API.
Endpoints
| Method | Path | Action |
|---|---|---|
GET | /v1/prompts | List prompts (with page, limit, category, agent_id filters) |
POST | /v1/prompts | Create a new prompt |
GET | /v1/prompts/:name | Fetch a single prompt by name |
PATCH | /v1/prompts/:name | Update fields on an existing prompt |
DELETE | /v1/prompts/:name | Delete a prompt |
Permissions
| Operation | Global prompts | Organization prompts | Other org’s prompts |
|---|---|---|---|
| Read (list / get) | Visible | Visible | Not visible |
| Create | Not allowed (admin-seeded only) | Allowed | Not allowed |
| Update | Not allowed | Allowed | Not allowed |
| Delete | Not allowed | Allowed | Not allowed |
Use Cases
Internal Style Guide
Create org-wide prompts that enforce your company’s tone, formatting, and terminology in every generated email or document.
Per-Agent Specialization
Pin prompts to a specific support, HR, or sales agent so they only appear when users interact with that agent.
Compliance Templates
Provide vetted templates for regulated workflows (legal disclosures, customer notifications) that users can run in one click.
Bulk Onboarding
Seed a new agent with a curated set of prompts at creation time, scoped to that agent only.
Prompt and category management are entirely driven by the REST API documented on this page. There is no dedicated admin UI today — call the endpoints from your own tooling, scripts, or an HTTP client.
Category Management
The category pills shown on the chat home screen are read from the deployment’s configured category list. Administrators can list them, rename them (for example to translate the default English labels), add new ones, or remove ones they don’t want.List & inspect
Read the current category list with
GET /v1/categories. Each item is a string used both as the slug stored on prompts and as the label rendered in the UI.Rename
Use
PATCH /v1/categories/:value to replace a category by its translated label (e.g. rename write to Écrire).Add
Use
POST /v1/categories with { "value": "<string>" } to append a new category to the list.Remove
Use
DELETE /v1/categories/:value to remove an entry from the list.Category Endpoints
| Method | Path | Action |
|---|---|---|
GET | /v1/categories | List configured categories (returns { items: string[], total }) |
POST | /v1/categories | Add a new category. Body: { "value": "<string>" }. 409 if already present |
GET | /v1/categories/:value | Fetch a single category. 404 if unknown |
PATCH | /v1/categories/:value | Rename a category. Body: { "value": "<new>" }. 404 if unknown, 409 if the new value is already taken by another entry |
DELETE | /v1/categories/:value | Remove a category. 404 if unknown. 204 No Content on success |
Example: translate the default categories
To switch a deployment from the default English labels to French, do it one category at a time so users never see a half-translated UI:- Pick one category (e.g.
write). PATCH /v1/prompts/:nameon every prompt that hascategory: writeto set the new value (e.g.Écrire).PATCH /v1/categories/writeto rename the pill itself.- Move on to the next category.
/v1/prompts updates first and the /v1/categories updates after, there is a window where users click the old pill (write) and see nothing because every prompt has already moved to Écrire. Doing it per category, or during a low-traffic window, avoids that.
Permissions
GETendpoints (list / single) accept any authenticated caller (user session or workspace API key).POST,PATCH,DELETErequire a workspace API key (Authorization: Bearer <workspace-api-key>). User sessions are rejected with403, even for admin users, because the configured list is shared across the whole deployment and must be managed by a service credential.- Concurrent mutations are serialized: a second admin call that arrives while another mutation is in flight is rejected with
429. Retry after a few seconds. In practice this only matters if you script bulk renames in parallel.
Privacy & Security
Prompts are stored in a secured library with strict scoping rules:- A user only sees prompts that belong to their organization, or globals shared with everyone.
- An organization cannot read or modify prompts of another organization.
- An agent’s prompts are only visible when interacting with that agent.