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

# Get macro translations

> See one macro's translation into each chosen language: its status and the translated title, body, and option labels. Read-only generated copies.

## Statuses

Each item is one chosen language:

* `ready` — translated, and made from the macro as it is now.
* `pending` — being translated, or the macro changed since the last translation. It becomes `ready` by itself.
* `failed` — could not be translated. Use [Retranslate a macro](./retranslate) to try again.

`title` and `content` are empty and `options` is an empty list until the item is `ready`. `source_language` is the language the macro is written in, or `null` until it has been detected. It gets no translation of its own. `items` is empty when no translation languages are chosen.

Translations are generated copies and cannot be edited: edit the macro itself and they refresh.


## OpenAPI

````yaml get /macros/{id}/translations
openapi: 3.1.0
info:
  title: OpenCX API
  description: >

    OpenCX is an AI-powered, all-in-one platform for customer support and
    outbound communications.


    Use this API to manage your OpenCX organization's AI agents, actions,
    conversations, contacts, and more.


    To get started, generate a new API key from the dashboard.


    ## Authentication

    All API endpoints require authentication using a Bearer token. You can
    generate an API key from your OpenCX dashboard.


    ## Rate Limiting

    API requests are rate limited to ensure fair usage. The current limits are:

    - 100 requests per minute for standard endpoints

    - 1000 requests per minute for streaming endpoints


    ## Error Handling

    The API uses standard HTTP status codes and returns detailed error messages
    in the response body.
  version: 1.0-beta
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: http://localhost:8080
    description: Development
  - url: https://api.open.cx
    description: Production
security:
  - bearerAuth: []
paths:
  /macros/{id}/translations:
    get:
      summary: Get macro translations
      description: >-
        One org-wide macro's translation into each selected language: its
        `status` (`ready`, `pending` while it is being translated or after the
        macro changed, or `failed`) and the translated `title`, `content` and
        option labels, which are empty until the translation is ready.
        `source_language` is the language the macro itself is written in, which
        gets no translation. Translations are read-only generated copies: edit
        the macro and they refresh. Personal macros are not included.
      operationId: getMacroTranslations
      parameters:
        - schema:
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
          in: path
          name: id
          required: true
          description: Macro ID
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MacroTranslationsDto'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
components:
  schemas:
    MacroTranslationsDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/MacroTranslationsDto'
      type: object
      properties:
        saved_reply_id:
          type: string
        source_language:
          anyOf:
            - type: string
            - type: 'null'
        items:
          type: array
          items:
            type: object
            properties:
              language:
                type: string
              status:
                type: string
                enum:
                  - pending
                  - ready
                  - failed
              title:
                type: string
              content:
                type: string
              options:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    label:
                      type: string
                  required:
                    - id
                    - label
                  additionalProperties: false
              updated_at:
                type: string
                format: date-time
            required:
              - language
              - status
              - title
              - content
              - options
              - updated_at
            additionalProperties: false
      required:
        - saved_reply_id
        - source_language
        - items
      additionalProperties: false
    ErrorDto:
      type: object
      properties:
        statusCode:
          type: integer
        message:
          type: string
        error:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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