Conversations

Ingest knowledge for Conversations.

The Conversations endpoints let you ingest, manage, and monitor Conversations in GitBook to be processed by Docs Agents.

objectstring · enumrequired

Available options:

idstringrequired

The ID of the conversations issues cluster

labelstringrequired

The label of the conversations issues cluster

createdAtstring · date-timerequired

updatedAtstring · date-timerequired

iconstring · icon · max: 50required

Name of the icon

Example: gear

summarystringrequired

The summary of the conversations issues cluster

weeklyPulsenumber[] · min: 13 · max: 13required

The weekly pulse of the conversations issues cluster for the past 3 months

sourcesobjectrequired

statsobjectrequired

The stats of the conversations issues cluster

urlsobjectrequired

URLs associated with the conversations issues cluster

Ingest conversations

post

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

Body

one ofoptional

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.gitbook.com/v1/orgs/{organizationId}/conversations' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "metadata": {
      "url": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "createdAt": "2025-05-28T22:46:16.762Z"
    },
    "subject": "text",
    "parts": [
      {
        "type": "message",
        "role": "user",
        "body": "text"
      }
    ]
  }'

204

204

No body

Conversations ingested