Get assistant conversation thread

Returns the full message transcript for a single assistant conversation thread. The thread ID is available from the assistant conversations endpoint, or as the threadId query parameter appended to assistant link-mode deflection support URLs.

Authenticate with an admin API key.

Usage

Use this endpoint to fetch the full message transcript of a single assistant conversation as JSON. The response includes the ordered list of user and assistant messages, each with an ID, role, content, and timestamp.

Common uses:

Attach the conversation transcript to a support ticket when a user reaches out from the assistant.
Reconstruct a specific conversation for review, quality assurance, or offline analysis.

Getting a thread ID

You can obtain a threadId from either of the following sources:

The id field of any row returned by Get assistant conversations.
The threadId query parameter that Mintlify appends to the support URL when the assistant deflects to your support platform using link deflection.

Rate limits

This endpoint allows 100 requests per organization per hour. All analytics endpoints share this limit.

OpenAPI

analytics.openapi.json

openapi: 3.1.0
info:
  title: Mintlify Analytics Export API
  version: 1.0.0
  description: API for exporting documentation analytics data
servers:
  - url: https://api.mintlify.com
    description: Production
security: []
paths:
  /v1/analytics/{projectId}/assistant/threads/{threadId}:
    get:
      tags:
        - Analytics
      summary: Get an assistant conversation thread
      description: >-
        Returns the full message transcript for a single assistant conversation
        thread. The thread ID is available from the assistant conversations
        endpoint, or as the `threadId` query parameter appended to assistant
        link-mode deflection support URLs.


        Authenticate with an admin API key.
      parameters:
        - $ref: '#/components/parameters/projectId'
        - schema:
            type: string
            format: ulid
            description: Assistant conversation thread ID (ULID).
          required: true
          name: threadId
          in: path
      responses:
        '200':
          description: The conversation transcript
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssistantThreadResponse'
        '400':
          description: Invalid thread ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsErrorResponse'
        '404':
          description: Thread not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsErrorResponse'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsErrorResponse'
      security:
        - bearerAuth: []
components:
  parameters:
    projectId:
      schema:
        $ref: '#/components/schemas/projectId'
      required: true
      name: projectId
      in: path
  schemas:
    AssistantThreadResponse:
      type: object
      properties:
        threadId:
          type: string
          description: Assistant conversation thread identifier (ULID).
        createdAt:
          type: string
          description: Timestamp when the thread was created.
        messages:
          type: array
          description: Ordered list of messages exchanged in the thread.
          items:
            type: object
            properties:
              id:
                type: string
                description: Unique message identifier.
              role:
                type: string
                enum:
                  - user
                  - assistant
                description: Whether the message was sent by the user or the assistant.
              content:
                type: string
                description: The text content of the message.
              createdAt:
                type: string
                description: Timestamp when the message was sent.
            required:
              - id
              - role
              - content
              - createdAt
      required:
        - threadId
        - createdAt
        - messages
    AnalyticsErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error message describing what went wrong.
        details:
          type: array
          description: Additional details about the error.
          items:
            type: object
            properties:
              message:
                type: string
                description: Description of a specific validation or processing error.
            required:
              - message
      required:
        - error
    projectId:
      type: string
      description: >-
        Your project ID. Can be copied from the [API
        keys](https://app.mintlify.com/settings/organization/api-keys) page in
        your dashboard.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        The Authorization header expects a Bearer token. Use an admin API key.
        This is a server-side secret key. Generate one on the [API keys
        page](https://app.mintlify.com/settings/organization/api-keys) in your
        dashboard.

Usage

Getting a thread ID

Rate limits

OpenAPI

Related topics