Skip to main content
POST
Create a knowledge base

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Body

application/json
name
string
required

Unique in the workspace

Required string length: 1 - 200
description
string | null

What it holds: a worker reads it to know when to search it

Maximum string length: 2000
stella
boolean
default:false

Whether Stella, the assistant in the app, searches it

Response

201 - application/json

Successful Response

created_at
string
required

ISO 8601 UTC

documents
DocumentCounts · object
required

Its documents, by indexing status

id
string
required
name
string
required
source
string
required

Where its documents come from: api (pushed through this API), upload (files uploaded in the app), team_answers (articles the team approved in the app), or the connector that syncs it (intercom, zendesk, notion, google_drive, sharepoint, website)

stella
boolean
required

Whether Stella, the assistant in the app, searches it

updated_at
string
required

ISO 8601 UTC: when the knowledge base itself last changed

workers
KnowledgeBaseWorker · object[]
required

The digital workers set to search it when they answer, whatever their status

writable
boolean
required

Whether this API may add, change and delete its documents: true for api and upload knowledge bases, false for a connector's (its sync overwrites an edit and never removes a document)

description
string | null