Conversations

Ingest knowledge for Conversations.

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

The ConversationsIssuesCluster object

Attributes

objectstring · enumrequiredAvailable 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

The ConversationsIssuesCluster object

{
  "object": "issues-cluster",
  "id": "text",
  "label": "text",
  "createdAt": "2025-06-01T20:37:37.612Z",
  "updatedAt": "2025-06-01T20:37:37.612Z",
  "icon": "gear",
  "summary": "text",
  "weeklyPulse": [
    1
  ],
  "sources": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "stats": {
    "issues": 1,
    "conversations": 1,
    "tasksTotal": 1,
    "tasksBacklog": 1,
    "tasksStarted": 1,
    "tasksCompleted": 1,
    "tasksCancelled": 1
  },
  "urls": {
    "location": "https://example.com",
    "app": "https://example.com"
  }
}

Ingest conversations

post

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

Body

one ofoptional

Responses

post

cURLJavaScriptPythonHTTP

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-06-01T20:37:37.612Z"
    },
    "subject": "text",
    "parts": [
      {
        "type": "message",
        "role": "user",
        "body": "text"
      }
    ]
  }'

204

204

No Content

Conversations ingested