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

# Get live version

> See which version of an agent phone calls, website chats and emails use now

The live version is the latest publish, or an earlier version someone made live again with **Make this version active** in Studio. `live_version` is `null` for an agent that has never been published: its conversations use the draft.

A conversation on a published version records that version's ID in the variable `interaction.AGENT_VERSION_ID`, the same ID as `version_id` here, so you can match your conversations to a version. A conversation on the draft, such as **Talk** or the test **Chat**, records `draft`. Call, Chat and Email History in Studio show the same version as a tag such as **V3**. See [Version History](https://docs.squawkvoice.ai/build/ai-agents.md#version-history).


## OpenAPI

````yaml api-reference/openapi.yaml GET /api/v1/assistants/{assistantId}/live-version
openapi: 3.1.0
info:
  title: SquawkVoice API
  version: '1.0'
  description: >-
    Place on-demand campaign calls, and manage and publish an agent's
    guidelines, from your own systems. Every request is authenticated with an
    API key sent in the `X-API-Key` header.
servers:
  - url: https://api.squawkvoice.ai
security:
  - apiKey: []
tags:
  - name: on-demand-calls
    x-group: On-Demand Calls
    description: Place a campaign call for one contact, and cancel it before it is dialed.
  - name: agents
    x-group: Agents
    description: >-
      Read and replace an agent's guidelines, publish the agent, and see which
      version is live.
paths:
  /api/v1/assistants/{assistantId}/live-version:
    get:
      tags:
        - agents
      summary: Get live version
      description: >-
        Returns the version that phone calls, website chats and emails use now:
        the latest publish, or an earlier version made live again in Studio.
      operationId: getLiveVersion
      parameters:
        - $ref: '#/components/parameters/assistantId'
      responses:
        '200':
          description: The live version.
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    type: object
                    required:
                      - assistant_id
                      - live_version
                    properties:
                      assistant_id:
                        type: string
                        format: uuid
                        description: The agent's ID.
                      live_version:
                        $ref: '#/components/schemas/LiveVersion'
              examples:
                published:
                  summary: Published agent
                  value:
                    success: true
                    data:
                      assistant_id: 3c7e1a52-8d4f-4b9a-a0e6-5f2d9c8b1e74
                      live_version:
                        version_id: a71d3e95-2c8b-4f04-8d6a-9b1e5c7f2d38
                        version_number: 4
                        name: November pricing update
                        published_at: '2026-10-30T09:15:42.000Z'
                        activated_at: null
                neverPublished:
                  summary: Never published
                  value:
                    success: true
                    data:
                      assistant_id: 3c7e1a52-8d4f-4b9a-a0e6-5f2d9c8b1e74
                      live_version: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/AgentForbidden'
        '404':
          $ref: '#/components/responses/AgentNotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    assistantId:
      name: assistantId
      in: path
      required: true
      description: >-
        The agent's ID. Open the agent in Studio and select **Copy ID** in its
        header.
      schema:
        type: string
        format: uuid
  schemas:
    LiveVersion:
      description: >-
        The version phone calls, website chats and emails use now. `null` when
        the agent has never been published: its conversations use the draft.
      oneOf:
        - type: object
          required:
            - version_id
            - version_number
            - name
            - published_at
            - activated_at
          properties:
            version_id:
              type: string
              format: uuid
              description: >-
                The version's ID. A conversation on a published version records
                that version's ID in the variable
                `interaction.AGENT_VERSION_ID`. A conversation on the draft,
                such as **Talk** or the test **Chat**, records `draft`.
            version_number:
              type: integer
              description: >-
                The version's number, as **Version History** in Studio shows it
                (V1, V2, and so on).
            name:
              type:
                - string
                - 'null'
              description: The version's name, or `null` when it has none.
            published_at:
              type: string
              format: date-time
              description: When this version was published.
            activated_at:
              type:
                - string
                - 'null'
              format: date-time
              description: >-
                When this version was last made live again with **Make this
                version active** in Studio, or `null` if never.
        - type: 'null'
    Error:
      type: object
      description: >-
        Most errors have `success: false` and a readable `error`. Some agent
        errors and rate-limit errors carry `message` instead.
      properties:
        success:
          type: boolean
          const: false
        error:
          type: string
          description: What went wrong.
        details:
          description: More detail, when there is any.
        message:
          type: string
          description: What went wrong, on errors that don't use `error`.
        data:
          type: object
          description: >-
            Extra detail on a few errors, such as the live version when there is
            nothing to publish, or the running publish on a `409`.
  responses:
    Unauthorized:
      description: >-
        The API key is missing, unknown, revoked or expired. The reply is the
        same in every case.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            error: 'Unauthorized: Invalid credentials'
    AgentForbidden:
      description: The agent isn't in your account.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: 'Forbidden: Workspace does not belong to your account.'
    AgentNotFound:
      description: Agent not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: Assistant not found.
    TooManyRequests:
      description: >-
        Too many requests. Wait for the number of seconds in the `Retry-After`
        header, then retry.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
                const: error
              message:
                type: string
          example:
            status: error
            message: Too many requests, please try again later.
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        An API key from **Manage → API Keys** in Studio. See
        [Authentication](/api-reference/authentication).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.