Skip to main content
POST
Create a Semantic Layer document
An API key writes as the person who created it, checked on every request. So a key may create a document exactly where its creator may: Demote the creator and every key they minted narrows on the next call: there is nothing to revoke separately.
Mentions are parsed out of content for you and returned in the read-only mentions field; the document is indexed for semantic search right after it is written.
Whatever its creator’s role, an API key cannot write the folder tree, so folder has to name one that already exists: create folders in the app. Deleting a document is not available to a key either and returns 403.

Authorizations

x-api-key
string
header
required

API Key authentication. Format: 'x-api-key: api_key'

Body

name
string
required
Maximum string length: 255
content
string
folder
string<uuid> | null

Folder to place the document in. Omit or send null to put it at the root.

Response

201 - application/json
id
string<uuid>
required
read-only
name
string
required
Maximum string length: 255
mentions
any
required
order
integer | null
required
read-only

Manual position among its siblings; NULL falls back to created_at ordering.

created_by
integer
required
read-only

Created by (Expandable)

created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
content
string
folder
string<uuid> | null

Folder to place the document in. Omit or send null to put it at the root.