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 · enumRequiredPossible values:

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

The ConversationsIssuesCluster object

{
  "object": "issues-cluster",
  "id": "text",
  "label": "text",
  "createdAt": "2025-08-26T23:19:07.272Z",
  "updatedAt": "2025-08-26T23:19:07.272Z",
  "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

or

Responses

204

Conversations ingested

post

HTTPcURLJavaScriptPython

POST /v1/orgs/{organizationId}/conversations HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 200

{
  "id": "text",
  "metadata": {
    "url": "text",
    "attributes": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "createdAt": "2025-08-26T23:19:07.272Z"
  },
  "subject": "text",
  "parts": [
    {
      "type": "message",
      "role": "user",
      "body": "text"
    }
  ]
}

204

Conversations ingested

No content