Knowledge Base API

Manage knowledge base entries that inform the AI assistant's responses.

2 min read

Knowledge Base API

Manage knowledge base entries that provide context to the AI assistant. Knowledge entries are automatically referenced by the AI when answering questions, making responses more accurate and project-specific.

List Knowledge Entries

GET /api/v1/knowledge

Retrieve all knowledge base entries for the current project.

Response

dataKnowledgeEntry[]
Array of knowledge base entries.
data[].idstring
Unique entry identifier.
data[].titlestring
Entry title used for display and search matching.
data[].typestring
Entry type: `"document"`, `"url"`, or `"faq"`.
data[].updatedAtnumber
Unix timestamp (ms) of the last update.

Create Knowledge Entry

POST /api/v1/knowledge

Add a new entry to the knowledge base. The AI assistant will reference this entry when generating content or answering questions.

Request Body

titlestringrequired
A descriptive title for the knowledge entry. Used for search matching when the AI retrieves relevant context.
contentstringrequired
The knowledge content in markdown or plain text format.
typestring
Entry type: `"document"` (general reference material), `"url"` (external resource content), or `"faq"` (question-answer pairs).

Response

data.idstring
The ID of the newly created knowledge entry.
data.titlestring
The entry title.
data.typestring
The entry type.
data.updatedAtnumber
Creation timestamp (ms).
Tip
Add your brand voice guidelines, product documentation, and frequently asked questions to the knowledge base. The AI will use these entries to produce content that matches your brand's tone and is factually accurate about your product.
Note
Knowledge entries are project-scoped. Each project maintains its own knowledge base, and entries are not shared across projects.
Was this helpful?

Command Palette

Search for a command to run...