Create realtime client secret | ElevenLabs Documentation

{
  "value": "ek_realtime_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0",
  "expires_at": 1735689600,
  "session": {
    "type": "realtime",
    "model": "eleven_realtime_v1_mini",
    "instructions": "You are a helpful customer support assistant. Be concise and friendly in your responses.",
    "output_modalities": [
      "audio",
      "text"
    ],
    "audio": {
      "input": {
        "format": {
          "type": "audio/pcm",
          "rate": 24000
        },
        "transcription": {
          "language": "en"
        },
        "turn_detection": {
          "type": "semantic_vad",
          "eagerness": "medium",
          "create_response": true,
          "interrupt_response": true,
          "threshold": 0.5,
          "prefix_padding_ms": 300,
          "silence_duration_ms": 500,
          "turn_timeout": -1
        },
        "pacing": "realtime"
      },
      "output": {
        "format": {
          "type": "audio/pcm"
        },
        "voice": "brian"
      }
    },
    "tools": [
      {
        "type": "function",
        "name": "get_order_status",
        "description": "Retrieves the current status of a customer order by order ID.",
        "parameters": {}
      }
    ],
    "tool_choice": "auto",
    "temperature": 0.7,
    "max_response_output_tokens": "inf",
    "max_duration_seconds": 600,
    "tracing": "auto"
  }
}

Create an ephemeral client secret for authenticating browser-based Realtime API sessions.

Request

This endpoint expects a nullable object.

sessionobject or nullOptional

expires_afterobject or nullOptional

Response

Successful Response

valuestring

expires_atinteger

sessionobject or nullOptional

Errors

422

Unprocessable Entity Error

Headers

Request

Response

Errors