Conversations
Ingest knowledge for Conversations.
Was this helpful?
Ingest knowledge for Conversations.
Was this helpful?
Was this helpful?
The Conversations endpoints let you ingest, manage, and monitor Conversations in GitBook to be processed by Docs Agents.
The ID of the conversations issues cluster
The label of the conversations issues cluster
Name of the icon
gear
The summary of the conversations issues cluster
The weekly pulse of the conversations issues cluster for the past 3 months
Conversations ingested
No content
{
"object": "issues-cluster",
"id": "text",
"label": "text",
"createdAt": "2025-08-26T20:44:16.148Z",
"updatedAt": "2025-08-26T20:44:16.148Z",
"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"
}
}
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-26T20:44:16.148Z"
},
"subject": "text",
"parts": [
{
"type": "message",
"role": "user",
"body": "text"
}
]
}