GitBook Change Request Conversations API

openapi: 3.2.0
info:
  title: GitBook Change Request Conversations API
  description: The GitBook API
  termsOfService: https://policies.gitbook.com
  contact:
    name: API Support
    url: https://gitbook.com/support
    email: support@gitbook.com
  version: 0.0.1-beta
servers:
- url: '{host}/v1'
  variables:
    host:
      default: https://api.gitbook.com
security:
- user: []
- user-internal: []
- user-staff: []
- integration: []
- integration-installation: []
tags:
- name: change-request-conversations
paths:
  /spaces/{spaceId}/change-requests/{changeRequestId}/conversations:
    get:
      operationId: listChangeRequestConversations
      summary: List AI agent conversations associated with a change request
      description: Returns a paginated list of AI agent conversations that were created in the context of this change request. These conversations capture the AI-assisted editing sessions that contributed to the draft. Use this to review the history of AI interactions on a change request before merging.
      x-gitbook-mcp: true
      tags:
      - change-request-conversations
      security:
      - user: []
      - oauth:
        - space:read
      parameters:
      - $ref: '#/components/parameters/spaceId'
      - $ref: '#/components/parameters/changeRequestId'
      - $ref: '#/components/parameters/listPage'
      - $ref: '#/components/parameters/listLimit'
      responses:
        '200':
          description: A list of agent conversations
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/List'
                - type: object
                  required:
                  - items
                  properties:
                    items:
                      type: array
                      items:
                        $ref: '#/components/schemas/AgentConversation'
  /spaces/{spaceId}/change-requests/{changeRequestId}/conversations/{conversationId}:
    patch:
      operationId: updateChangeRequestConversation
      summary: Update an AI agent conversation on a change request
      description: Updates a specific AI agent conversation associated with a change request. Use this to rename the conversation.
      x-gitbook-mcp: true
      tags:
      - change-request-conversations
      security:
      - user: []
      - oauth:
        - space:write
      parameters:
      - $ref: '#/components/parameters/spaceId'
      - $ref: '#/components/parameters/changeRequestId'
      - $ref: '#/components/parameters/conversationId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - title
              properties:
                title:
                  type: string
                  description: The new title of the conversation.
      responses:
        '200':
          description: The updated conversation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentConversation'
    delete:
      operationId: deleteChangeRequestConversation
      summary: Delete an agent conversation
      tags:
      - change-request-conversations
      security:
      - user: []
      parameters:
      - $ref: '#/components/parameters/spaceId'
      - $ref: '#/components/parameters/changeRequestId'
      - $ref: '#/components/parameters/conversationId'
      responses:
        '205':
          description: The conversation has been deleted.
components:
  parameters:
    listLimit:
      name: limit
      in: query
      description: The number of results per page
      schema:
        type: number
        minimum: 0
        maximum: 1000
    conversationId:
      name: conversationId
      in: path
      required: true
      description: The unique ID of the agent conversation (its client-generated local id, or "default" for the default conversation)
      schema:
        type: string
    listPage:
      name: page
      in: query
      description: Identifier of the page results to fetch.
      schema:
        type: string
    spaceId:
      name: spaceId
      in: path
      required: true
      description: The unique id of the space
      schema:
        $ref: '#/components/schemas/EntityId'
    changeRequestId:
      name: changeRequestId
      in: path
      required: true
      description: The unique ID of the change request or its number identifier in the space
      schema:
        $ref: '#/components/schemas/EntityId'
  schemas:
    Timestamp:
      type: string
      format: date-time
    List:
      type: object
      properties:
        next:
          type: object
          properties:
            page:
              type: string
              description: Unique identifier to query the next results page
          required:
          - page
        count:
          type: number
          description: Total count of objects in the list
    EntityId:
      type: string
      pattern: ^[a-zA-Z0-9_-]+$
      description: A unique entity identifier
    AgentConversation:
      type: object
      properties:
        object:
          type: string
          description: Type of Object, always equals to "agent-conversation"
          enum:
          - agent-conversation
        id:
          type: string
          description: The unique ID of the conversation. This is the client-generated identifier used to address the conversation; for the default conversation of a change request it is "default".
        title:
          type: string
          description: The title of the conversation, generated from the first message. Absent until generated.
        shared:
          type: boolean
          description: Whether the conversation is shared with everyone who has access to its context, rather than only its creator. Conversations are shared by default; a private conversation is only ever visible to its creator and stays private for good.
        changeRequest:
          type: string
          description: The change request the conversation is currently editing in. Only set for organization agent conversations, which start without one and attach a change request the first time the agent needs to change content. Absent for change request conversations, whose change request is the conversation's context.
        createdAt:
          $ref: '#/components/schemas/Timestamp'
        updatedAt:
          $ref: '#/components/schemas/Timestamp'
      required:
      - object
      - id
      - shared
      - createdAt
      - updatedAt
  securitySchemes:
    user:
      type: http
      scheme: bearer
    user-internal:
      type: http
      scheme: bearer
    user-staff:
      type: http
      scheme: bearer
    integration:
      type: http
      scheme: bearer
    integration-installation:
      type: http
      scheme: bearer
    oauth:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://oauth.gitbook.com/authorize
          tokenUrl: https://oauth.gitbook.com/token
          scopes:
            user:read: Read your GitBook user profile.
            organization:read: Read the organizations you belong to, their settings and metadata, and their AI agent conversations.
            organization:write: Create organizations, and update organization settings and AI agent conversations.
            organization:members:read: Read organization members, teams, invites and link invites.
            organization:members:write: Manage organization members, teams, invites and link invites.
            organization:ask: Ask AI questions across an organization's content.
            organization:search: Search across an organization's content.
            space:read: Read spaces and their content, including pages, change requests and their reviews, comments, files and revision history.
            space:write: Create, update and delete spaces and their content, including change requests (create, edit, review), comments, and content imports and exports. Merging a change request also requires change-request:merge.
            space:permissions:read: Read the users and teams who have access to spaces and collections.
            space:permissions:write: Manage who has access to spaces and collections, including inviting users and teams.
            change-request:merge: Merge change requests, publishing their changes to the space. Creating, editing and reviewing change requests only requires space:write.
            site:read: Read sites and their settings, including navigation structure, linked spaces, customization, redirects, topics, AI configuration and documentation issues.
            site:write: Create, update and delete sites and their settings, including navigation structure (sections, linked spaces, external links), customization, redirects, topics and AI configuration.
            site:publish: Publish and unpublish sites, controlling their public exposure.
            site:permissions:read: Read the users and teams who have access to sites.
            site:permissions:write: Manage who has access to sites, including inviting users and teams.
            site:auth:read: Read how visitors authenticate on a site and its security configuration, including private share links.
            site:auth:write: Manage how visitors authenticate on a site and its security configuration, including private share links.
            site:insights:read: Read site analytics and insights, including the questions visitors asked Ask AI and the answers they received.
            site:ask: Ask AI questions across a site's content.
            site:search: Search across a site's content.
            integration:read: Read integrations, their status and where they are installed.
            integration:installations:read: Read integration installations and their configuration, which can include credentials for third-party services.
            integration:installations:write: Install and configure integrations on an organization, its spaces and its sites.
            integration:publish: Publish integrations, which can request their own permissions on your content, and route their events to a development tunnel.
            integration:delete: Unpublish integrations, permanently deleting them and every installation of them.
            openapi:read: Read OpenAPI specifications.
            openapi:write: Create, update and delete OpenAPI specifications.
x-provenance:
  method: harvested
  publisher: GitBook
  source: https://api.gitbook.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)