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

# 음성 모델 조회

> 보이스 1건을 조회합니다. `options`에는 이 보이스에 쓸 수 있는 `language`·`model` 조합이 모두 들어 있으며, 조합 하나가 `GET /v3/models/voices` 응답 항목 하나에 해당합니다. 다른 워크스페이스의 비공개 보이스나 워크스페이스에서 허용하지 않은 provider의 보이스처럼 이 워크스페이스에서 볼 수 없는 보이스는 존재하지 않는 보이스와 동일하게 `404`를 반환합니다.



## OpenAPI

````yaml /api-reference/v3/openapi.json get /models/voices/{voice_id}
openapi: 3.1.0
info:
  title: vox.ai API
  description: >
    vox.ai API v3


    ### v3 공개 계약 규칙


    - 인증은 `Authorization: Bearer <token>` 헤더를 사용합니다. 워크스페이스 API 키를 Bearer 토큰으로
    전달합니다.

    - 요청과 응답 필드는 기본적으로 `snake_case`를 사용합니다.

    - `agent.data`는 에이전트 레지스트리와 호환되어야 하므로 `callSettings`, `toolIds`,
    `builtInTools`, `presetDynamicVariables` 같은 camelCase 필드를 유지합니다.

    - `_at`으로 끝나는 타임스탬프는 unix milliseconds입니다. 일부 입력값은 호환성을 위해 10~11자리 unix
    seconds도 허용하고 milliseconds로 정규화합니다.

    - 대량 발신 통화 가능 시간은 분 단위 정수(`start_min` / `end_min`)를 사용합니다. 알림 스케줄은 `HH:MM`
    문자열(`start_time` / `end_time`)을 사용합니다.

    - 응답 객체 자신의 식별자는 `id`입니다. 다른 리소스를 참조하는 필드와 path parameter는 `agent_id`,
    `call_id`, `telephone_line_id`처럼 명시적인 이름을 사용합니다.

    - 실패 응답은 `{ "error": { "code", "message", "details" } }` 형태입니다. 가능한 경우
    `details.field`, `details.reason`, `details.allowed_values`를 함께 제공합니다.
  version: 3.0.0
servers:
  - url: https://client-api.tryvox.co/v3
    description: 운영
security: []
paths:
  /models/voices/{voice_id}:
    get:
      tags:
        - Models
      summary: 음성 모델 조회
      description: >-
        보이스 1건을 조회합니다. `options`에는 이 보이스에 쓸 수 있는 `language`·`model` 조합이 모두 들어
        있으며, 조합 하나가 `GET /v3/models/voices` 응답 항목 하나에 해당합니다. 다른 워크스페이스의 비공개 보이스나
        워크스페이스에서 허용하지 않은 provider의 보이스처럼 이 워크스페이스에서 볼 수 없는 보이스는 존재하지 않는 보이스와
        동일하게 `404`를 반환합니다.
      operationId: getVoiceModel
      parameters:
        - name: voice_id
          in: path
          required: true
          schema:
            type: string
            description: 음성 식별자입니다. `GET /v3/models/voices` 응답 항목의 `id` 값을 사용합니다.
            title: Voice Id
          description: 음성 식별자입니다. `GET /v3/models/voices` 응답 항목의 `id` 값을 사용합니다.
      responses:
        '200':
          description: 성공 응답
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceModelDetailResponse'
        '400':
          description: 요청 검증 오류
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                validationError:
                  summary: 요청 검증 오류
                  value:
                    error:
                      code: VALIDATION_ERROR
                      message: Request validation failed.
                      details:
                        field: name
                        reason: must not be blank
        '401':
          description: 인증이 필요합니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                unauthorized:
                  summary: Bearer 토큰 누락 또는 오류
                  value:
                    error:
                      code: UNAUTHORIZED
                      message: Authentication is required.
                      details: {}
        '403':
          description: 권한이 없습니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                forbidden:
                  summary: 권한이 없습니다.
                  value:
                    error:
                      code: FORBIDDEN
                      message: Permission denied.
                      details: {}
        '404':
          description: 리소스를 찾을 수 없습니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                notFound:
                  summary: 보이스를 찾을 수 없습니다.
                  value:
                    error:
                      code: VOICE_NOT_FOUND
                      message: Voice 모델을 찾을 수 없습니다.
                      details:
                        voice_id: a0e99841-438c-4a64-b679-ae501e7d6091
        '409':
          description: 충돌이 발생했습니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                conflict:
                  summary: 상태 충돌이 발생했습니다.
                  value:
                    error:
                      code: CONFLICT
                      message: The requested operation conflicts with current state.
                      details:
                        current_status: draft
        '429':
          description: >-
            요청 한도를 초과했습니다. API 키 트래픽은 기본값으로 워크스페이스당 초당 5회·분당 120회, Supabase JWT
            트래픽은 기본값으로 사용자당 초당 10회·분당 240회로 제한되며, 워크스페이스 대시보드에는 기본 분당 2,400회의
            백스톱 한도가 적용됩니다. 한도는 운영자가 조정할 수 있고, 초과한 버킷의 실제 한도와 윈도우는 429 응답의
            X-RateLimit-Limit·X-RateLimit-Window 헤더로 알려 줍니다. 개별 경로 자체 리미터가 만든
            429 응답에는 이 헤더가 없을 수 있습니다.
          headers:
            Retry-After:
              description: >-
                초과한 공용 v3 인증 주체(auth-principal) 리미터 윈도우가 초기화될 때까지 남은 시간입니다. 단위는
                초입니다. 개별 경로 자체 리미터가 만든 429 응답에는 이 헤더가 없을 수 있습니다.
              schema:
                type: integer
                minimum: 1
            X-RateLimit-Limit:
              description: >-
                초과한 공용 v3 인증 주체(auth-principal) 리미터 윈도우의 최대 요청 수입니다. 개별 경로 자체
                리미터가 만든 429 응답에는 이 헤더가 없을 수 있습니다.
              schema:
                type: integer
                minimum: 1
            X-RateLimit-Window:
              description: >-
                초과한 공용 v3 인증 주체(auth-principal) 리미터 윈도우의 길이입니다. 단위는 초입니다. 개별 경로
                자체 리미터가 만든 429 응답에는 이 헤더가 없을 수 있습니다.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                rateLimited:
                  summary: 요청 한도를 초과했습니다.
                  value:
                    error:
                      code: RATE_LIMIT_EXCEEDED
                      message: Too many requests.
                      details:
                        limit: 10
                        window_seconds: 1
                        scope: user
        '500':
          description: 서버 내부 오류가 발생했습니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                internalError:
                  summary: 서버 내부 오류가 발생했습니다.
                  value:
                    error:
                      code: INTERNAL_ERROR
                      message: Internal server error.
                      details: {}
        '503':
          description: 서비스를 일시적으로 사용할 수 없습니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                serviceUnavailable:
                  summary: 서비스를 일시적으로 사용할 수 없습니다.
                  value:
                    error:
                      code: SERVICE_UNAVAILABLE
                      message: Service temporarily unavailable.
                      details: {}
      security:
        - BearerAuth: []
components:
  schemas:
    VoiceModelDetailResponse:
      properties:
        id:
          type: string
          title: Id
          description: 공급사 내 음성 식별자. 에이전트 설정의 `data.voice.id`에 지정하는 값입니다.
        name:
          type: string
          title: Name
          description: 사람이 읽는 음성 이름.
        provider:
          type: string
          title: Provider
          description: TTS 공급사.
        gender:
          anyOf:
            - type: string
              enum:
                - male
                - female
            - type: 'null'
          title: Gender
          description: provider가 제공하는 경우 포함되는 음성 gender 메타데이터입니다.
        is_public:
          type: boolean
          title: Is Public
          description: 공개 카탈로그 보이스 여부입니다.
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: 사람이 읽을 수 있는 설명입니다.
        sample_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Sample Url
          description: 사용 가능한 경우 제공되는 sample audio clip URL입니다.
        options:
          items:
            $ref: '#/components/schemas/VoiceModelOption'
          type: array
          title: Options
          description: >-
            이 보이스에서 고를 수 있는 `language`·`model` 조합 목록입니다. 조합 하나가 `GET
            /v3/models/voices` 응답 항목 하나에 해당합니다.
      type: object
      required:
        - id
        - name
        - provider
        - is_public
        - options
      title: VoiceModelDetailResponse
      description: 보이스 1건과 이 보이스에서 고를 수 있는 `language`·`model` 조합입니다.
    ErrorResponse:
      type: object
      required:
        - error
      title: ErrorResponse
      description: 모든 실패 응답에서 사용하는 v3 error envelope입니다.
      examples:
        - error:
            code: VALIDATION_ERROR
            message: Request validation failed.
            details:
              field: name
              reason: must not be blank
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: 오류 payload입니다.
    VoiceModelOption:
      properties:
        language:
          type: string
          title: Language
          description: >-
            BCP-47 locale code입니다. 이 조합을 고를 때 `agent.data.voice.language`에 이 값을
            사용합니다.
        model:
          anyOf:
            - type: string
            - type: 'null'
          title: Model
          description: TTS 공급사 내 모델명입니다. 이 조합을 고를 때 `agent.data.voice.model`에 이 값을 사용합니다.
        capabilities:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Capabilities
          description: 지원되는 속도나 볼륨 범위 같은 voice parameter capability hint입니다.
      type: object
      required:
        - language
      title: VoiceModelOption
      description: 보이스 하나의 카탈로그 항목(`language`·`model` 조합 하나)입니다.
    ErrorDetail:
      type: object
      required:
        - code
        - message
        - details
      title: ErrorDetail
      description: 기계가 읽을 수 있는 v3 오류 상세 정보입니다.
      examples:
        - code: VALIDATION_ERROR
          message: Request validation failed.
          details:
            field: name
            reason: must not be blank
      properties:
        code:
          type: string
          title: Code
          description: 기계가 읽을 수 있는 오류 code입니다. message parsing 대신 이 값을 사용합니다.
          examples:
            - VALIDATION_ERROR
        message:
          type: string
          title: Message
          description: 사용자에게 표시할 수 있는 오류 메시지입니다. 프로그램 처리는 `code`를 사용합니다.
          examples:
            - Request validation failed.
        details:
          type: object
          title: Details
          additionalProperties: true
          description: 구조화된 context입니다. 주로 `field`, `reason`, `allowed_values`를 포함합니다.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Organization API key
      description: '워크스페이스 API 키를 `Authorization: Bearer <token>` 형식으로 보냅니다.'

````

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