# Get Turn Credentials

> GET /api/v1/turn/credentials — request parameters and responses from the Menace Voice API schema.

`GET /api/v1/turn/credentials`

{/* Generated by scripts/sync_docs_api.mjs. Edit the API schema source to change the contract. */}

See [authentication](/api-reference/authentication) for workspace API access. Public embed and artifact endpoints use their documented session or access tokens.

## API contract for documentation tools

Generated from the OpenAPI schema. Do not infer a different parameter type from an example. Authentication headers are alternatives as explained in the authentication guide.

### Parameters

| Name | Location | Type | Required | Description and constraints |
| --- | --- | --- | --- | --- |
| authorization | header | string or null | no |  |
| X-API-Key | header | string or null | no |  |

### Response 200

Successful Response

application/json: TurnCredentialsResponse (object).

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| username | string | yes |  |
| password | string | yes |  |
| ttl | integer | yes |  |
| uris | array of string | yes |  |

### Response 404

Not found

### Response 422

Validation Error

application/json: HTTPValidationError (object).

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| detail | array of ValidationError (object) | no |  |

## OpenAPI

````yaml api-reference/openapi.json get /api/v1/turn/credentials
openapi: 3.1.0
info:
  title: Menace Voice API
  description: API for Menace Voice agents
  version: 1.0.0
servers:
  - url: https://voice.menaceui.com
    description: Production
  - url: http://localhost:8000
    description: Local development
paths:
  /api/v1/turn/credentials:
    get:
      tags:
        - main
        - turn
      summary: Get Turn Credentials
      description: |-
        Get time-limited TURN credentials for WebRTC connections.

        This endpoint generates ephemeral TURN credentials that are:
        - Valid for the configured TTL (default: 24 hours)
        - Cryptographically bound to the user via HMAC
        - Compatible with coturn's use-auth-secret mode

        Returns:
            TurnCredentialsResponse with username, password, ttl, and TURN URIs
      operationId: get_turn_credentials_api_v1_turn_credentials_get
      parameters:
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: "null"
            title: Authorization
        - name: X-API-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: "null"
            title: X-Api-Key
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TurnCredentialsResponse"
        "404":
          description: Not found
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: "#/components/schemas/ValidationError"
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    TurnCredentialsResponse:
      properties:
        username:
          type: string
          title: Username
        password:
          type: string
          title: Password
        ttl:
          type: integer
          title: Ttl
        uris:
          items:
            type: string
          type: array
          title: Uris
      type: object
      required:
        - username
        - password
        - ttl
        - uris
      title: TurnCredentialsResponse
      description: Response model for TURN credentials.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
````