> ## Documentation Index
> Fetch the complete documentation index at: https://docs.threetone.in/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Conversation Summary

> Get a lightweight summary of a conversation: its title, the generated transcript summary, whether the call was successful, and — only when the conversation is short — the plain chat messages. Tool calls, tool results, and contextual updates are omitted so the response stays small. Use this instead of the full conversation endpoint when you only need the gist (e.g. an agent reading many conversations); use GET /v1/convai/conversations/{conversation_id} when you need the full transcript with tool calls and contextual updates.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/convai/conversations/{conversation_id}/summary
openapi: 3.1.0
info:
  title: Threetone API Documentation
  description: >-
    This is the documentation for the Threetone API. You can use this API to use
    our service programmatically with API keys sent in the x-api-key header. You
    can create and manage API keys in the dashboard at
    https://threetone.in/app/developers/api-keys.
  version: '1.0'
servers:
  - url: https://api.threetone.in
    description: Production
security: []
paths:
  /v1/convai/conversations/{conversation_id}/summary:
    get:
      tags:
        - Agents Platform
      summary: Get Conversation Summary
      description: >-
        Get a lightweight summary of a conversation: its title, the generated
        transcript summary, whether the call was successful, and — only when the
        conversation is short — the plain chat messages. Tool calls, tool
        results, and contextual updates are omitted so the response stays small.
        Use this instead of the full conversation endpoint when you only need
        the gist (e.g. an agent reading many conversations); use GET
        /v1/convai/conversations/{conversation_id} when you need the full
        transcript with tool calls and contextual updates.
      operationId: get_conversation_summary_route
      parameters:
        - name: conversation_id
          in: path
          required: true
          schema:
            type: string
            description: The id of the conversation you're taking the action on.
            examples:
              - 21m00Tcm4TlvDq8ikWAM
            embed: true
            title: Conversation Id
          description: The id of the conversation you're taking the action on.
        - name: max_messages
          in: query
          required: false
          schema:
            type: integer
            maximum: 200
            minimum: 1
            description: >-
              Maximum number of chat message turns to include inline. When the
              conversation has more than this, the messages are omitted and
              messages_omitted is set.
            default: 40
            title: Max Messages
          description: >-
            Maximum number of chat message turns to include inline. When the
            conversation has more than this, the messages are omitted and
            messages_omitted is set.
        - name: x-api-key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Your API key for programmatic access. Send it in the x-api-key
              header; you can create and manage keys from the Developers page.
            title: X-Api-Key
          description: >-
            Your API key for programmatic access. Send it in the x-api-key
            header; you can create and manage keys from the Developers page.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConversationSummaryResponseModel'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    GetConversationSummaryResponseModel:
      properties:
        conversation_id:
          type: string
          title: Conversation Id
        agent_id:
          type: string
          title: Agent Id
        status:
          type: string
          enum:
            - initiated
            - in-progress
            - processing
            - done
            - failed
          title: Status
        call_summary_title:
          anyOf:
            - type: string
            - type: 'null'
          title: Call Summary Title
          description: Short generated title for the conversation.
        transcript_summary:
          anyOf:
            - type: string
            - type: 'null'
          title: Transcript Summary
          description: Generated natural-language summary of the call.
        call_successful:
          anyOf:
            - $ref: '#/components/schemas/EvaluationSuccessResult'
            - type: 'null'
        message_count:
          type: integer
          title: Message Count
          description: Number of plain chat message turns in the conversation.
        messages:
          anyOf:
            - items:
                $ref: '#/components/schemas/ConversationSummaryMessageModel'
              type: array
            - type: 'null'
          title: Messages
          description: >-
            The plain chat messages (role and text only). Included only when
            message_count does not exceed the requested max_messages; otherwise
            null and messages_omitted is true.
        messages_omitted:
          type: boolean
          title: Messages Omitted
          description: >-
            True when the chat messages were omitted because the conversation
            was too long. Fetch the full transcript for the messages.
          default: false
        note:
          type: string
          title: Note
          description: Guidance telling the agent how to get the full transcript.
      type: object
      required:
        - conversation_id
        - agent_id
        - status
        - message_count
        - note
      title: GetConversationSummaryResponseModel
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    EvaluationSuccessResult:
      type: string
      enum:
        - success
        - failure
        - unknown
      title: EvaluationSuccessResult
    ConversationSummaryMessageModel:
      properties:
        role:
          type: string
          enum:
            - user
            - agent
          title: Role
        message:
          type: string
          title: Message
      type: object
      required:
        - role
        - message
      title: ConversationSummaryMessageModel
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````