Explore how adaptive content transforms your docs into a dynamic, tailored experience for every user.
Read the docs
LogoLogo
ProductPricingLog inSign up
  • Documentation
  • Developers
  • Guides
  • Changelog
  • Help Center
  • Getting Started
    • Developer Documentation
    • Quickstart
    • Development
    • Publishing
  • Integrations
    • Introduction
    • Using the CLI
    • Configuration
    • ContentKit
      • Component reference
    • Integration runtime
  • Client library
  • Guides
    • Creating a custom unfurl action
    • Creating interactive blocks
    • Referencing your integration in Markdown
    • Working with HTTP requests
    • Using the CLI in CI/CD
  • GitBook API
    • Introduction
    • Authentication
    • API reference
      • Organizations
        • Organization members
        • Organization invites
        • Organization AI ask
      • Docs sites
        • Site share links
        • Site structure
        • Site auth
        • Site preview
        • Site customization
        • Site spaces
        • Site sections
        • Site section groups
        • Site redirects
        • Site MCP servers
        • Site ads
        • Site users
        • Site insights
        • Site AI ask
      • Collections
        • Collection users
        • Collection teams
      • Spaces
        • Space content
        • Space comments
        • Space embeds
        • Space users
        • Space teams
        • Space integrations
        • Git
      • Change requests
        • Change request content
        • Change request contributors
        • Change request reviewers
        • Change request comments
      • Translations
        • Glossary
      • Integrations
      • URLs
      • OpenAPI
        • OpenAPI spec versions
      • Conversations
      • Custom fonts
      • Subdomains
      • Users
      • Teams
        • Team members
      • SSO
      • Storage
      • Custom hostnames
      • System info
    • Rate limiting
    • Pagination
    • Errors
  • Marketplace
    • Overview
    • Submit your app for review
  • Resources
    • Concepts
    • Changelog
    • ContentKit playground
    • GitHub examples
Powered by GitBook
On this page
  1. GitBook API
  2. API reference

Conversations

Ingest knowledge for Conversations.

Was this helpful?

LogoLogo

Resources

  • Showcase
  • Enterprise
  • Status

Company

  • Careers
  • Blog
  • Community

Policies

  • Subprocessors
  • Terms of Service
CtrlK

Was this helpful?

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

  • The ConversationsIssuesCluster object
  • POSTIngest conversations

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

Ingest conversations

post
Authorizations
Path parameters
organizationIdstringRequired

The unique id of the organization

Body
one ofOptional
or
Responses
204

Conversations ingested

post
204

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"
    }
  ]
}