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

# Get Conversation by ID

> Retrieves detailed information about a specific conversation including call logs, performance metrics, and associated voice agent configuration.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/voice-agents/conversation/{conversationId}
openapi: 3.0.1
info:
  title: Hamsa API
  description: Trying out our transcription and media-to-text APIs
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.tryhamsa.com
security: []
paths:
  /v1/voice-agents/conversation/{conversationId}:
    get:
      summary: Get Conversation by ID.
      description: >-
        Retrieves detailed information about a specific conversation including
        call logs, performance metrics, and associated voice agent
        configuration.
      parameters:
        - in: path
          name: conversationId
          required: true
          description: UUID of the conversation to retrieve.
          schema:
            type: string
            format: uuid
            example: 849e77c6-5cb3-479a-a985-7fab630e2c78
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConversationResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
        '403':
          description: Forbidden - Not authorized to access this conversation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
        '404':
          description: Conversation not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
        '500':
          description: Server Side Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    GetConversationResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        message:
          type: string
          example: Success
        data:
          $ref: '#/components/schemas/ConversationDetail'
    ErrorSchema:
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
    ConversationDetail:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: UUID of the conversation.
          example: 849e77c6-5cb3-479a-a985-7fab630e2c78
        model:
          type: string
          description: AI model used for the conversation.
          example: gpt-4
          nullable: true
        agentDetails:
          type: object
          description: Detailed configuration of the voice agent used in this conversation.
          nullable: true
        jobResponse:
          type: object
          description: Response data from the job execution.
          nullable: true
        status:
          type: string
          enum:
            - PENDING
            - IN_PROGRESS
            - COMPLETED
            - NO_ANSWER
            - FAILED
          description: Current status of the conversation.
          example: COMPLETED
        type:
          type: string
          description: Type of job (should be VOICE_AGENTS).
          example: VOICE_AGENTS
        processingType:
          type: string
          description: Type of processing used for the conversation.
          example: real-time
          nullable: true
        voiceAgentId:
          type: string
          format: uuid
          description: UUID of the voice agent.
          example: d949f13f-40d2-4e48-ac86-b66633070603
          nullable: true
        apiKeyId:
          type: string
          format: uuid
          description: UUID of the API key used.
          example: d949f13f-40d2-4e48-ac86-b66633070603
          nullable: true
        createdAt:
          type: string
          format: date-time
          description: Timestamp when the conversation was created.
          example: '2024-01-15T10:30:00Z'
        updatedAt:
          type: string
          format: date-time
          description: Timestamp when the conversation was last updated.
          example: '2024-01-15T10:35:00Z'
        title:
          type: string
          description: Title or name of the conversation.
          example: Customer Support Call
          nullable: true
        mediaUrl:
          type: string
          format: uri
          description: Signed URL for accessing the call recording (if available).
          example: https://storage.example.com/recordings/123.mp3
          nullable: true
        callParams:
          type: object
          description: Parameters related to the call (e.g., phone numbers, settings).
          nullable: true
          properties:
            userNumber:
              type: string
              description: Phone number of the user.
              example: '+1234567890'
        callDuration:
          type: number
          description: Duration of the call in seconds.
          example: 125
          nullable: true
        channelType:
          type: string
          description: Channel through which the conversation took place.
          example: TELEPHONE
          nullable: true
        callAnalysis:
          type: object
          description: >-
            Analysis data for the call (may include error messages if call
            failed).
          nullable: true
        voiceAgent:
          type: object
          description: Voice agent configuration and associated resources.
          nullable: true
          properties:
            voiceAgentWebTools:
              type: array
              description: Web tools configured for the voice agent.
              items:
                type: object
                properties:
                  webTool:
                    type: object
                    description: Web tool details.
            webTools:
              type: object
              description: Legacy web tools configuration.
              nullable: true
            voiceAgentKnowledgeBases:
              type: array
              description: Knowledge bases associated with the voice agent.
              items:
                type: object
                properties:
                  knowledgeBaseItem:
                    type: object
                    description: Knowledge base item details.
        logs:
          type: array
          description: Detailed conversation logs retrieved from Agent Analytics service.
          items:
            $ref: '#/components/schemas/ConversationLog'
        performanceMetrics:
          type: object
          description: >-
            Performance metrics for the conversation retrieved from Agent
            Analytics service.
          additionalProperties: true
    ConversationLog:
      type: object
      properties:
        id:
          type: string
          description: Log entry ID.
          example: log_123
        timestamp:
          type: string
          format: date-time
          description: Timestamp of the log entry.
          example: '2024-01-15T10:30:15Z'
        payload:
          type: object
          description: Log payload data (parsed from JSON).
          additionalProperties: true
        createdAt:
          type: string
          format: date-time
          description: When the log was created.
          example: '2024-01-15T10:30:15Z'
        updatedAt:
          type: string
          format: date-time
          description: When the log was last updated.
          example: '2024-01-15T10:30:15Z'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Pass the API key in the Authorization header, You need to put Token
        keyword before the API key. e.g. 'Authorization: Token <api-key>'

````