Skip to main content
POST
Create knowledge item

Body

application/json
type
enum<string>
required

Knowledge item types that can be created through the API. pdf and icon items require file uploads and are managed in the dashboard.

Available options:
text,
link,
memory
title
string
required
Required string length: 1 - 200
content
string

Text content. Required for text and memory items, not allowed for link items.

Required string length: 1 - 50000
url
string<uri>

URL to crawl and index. Required for link items, not allowed for other types.

excludePaths
string[]

Path patterns to exclude while crawling a link item, e.g. /blog/*

projectShortId
string

Target a specific project by its prefixed short ID (proj-slug_shortId or proj_shortId), as returned by the projects API. Required for organization-scoped API keys; project-scoped keys may only pass their own project's short ID.

Pattern: ^proj(-.+_.+|_.+)$

Response

200 - application/json

The request has succeeded.

success
boolean
required
item
object
required