Skip to main content
POST
/
public
/
knowledge-base
/
batch
Batch upload knowledge base sources
curl --request POST \
  --url https://web-api.clerk.chat/public/knowledge-base/batch \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <api-key>' \
  --data '
{
  "sources": [
    {
      "title": "RCS Overview",
      "content": "RCS is a revolutionary customer support tool..."
    }
  ],
  "upsert": false
}
'
{
  "data": [
    {
      "id": 123,
      "title": "<string>",
      "status": "processing"
    }
  ],
  "total": 1
}

Authorizations

apiKey
string
header
required

Body

application/json
sources
object[]
required

The list of sources to upload

upsert
boolean

If true, updates existing sources with matching titles. If false, creates new sources (default: false)

Example:

false

Response

Batch upload initiated successfully

data
object[]
required
total
number
required

The total number of sources uploaded

Example:

1