Skip to content
Everruns Everruns

create_client_secret

POST
/v1/sessions/{session_id}/voice/client-secret
 
curl --request POST \
  --url https://app.everruns.com/api/v1/sessions/example/voice/client-secret \
  --header 'Content-Type: application/json' \
  --data '{ "instructions": "Always confirm before placing an order.", "model": "gpt-realtime", "reasoning_effort": "medium", "voice": "alloy" }'

Create an ephemeral client secret for the voice channel.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
session_id
required
string

Request Body required

Section titled “Request Body required ”
Media type application/json

Request body for voice client secret.

object
instructions

Extra system instructions appended to the realtime session prompt.

string | null
Example 
Always confirm before placing an order.
model

Provider-side realtime model identifier. When omitted the server picks the agent’s configured default.

string | null
Example 
gpt-realtime
reasoning_effort

Reasoning effort hint passed through to the realtime model. One of low, medium, high. When omitted the server picks the provider’s default.

string | null
Example 
medium
voice

Realtime voice preset (provider-specific). When omitted the server picks the agent’s configured default.

string | null
Example 
alloy

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Realtime client secret created

Media type application/json

Response body for voice client secret.

object
client_secret
required

Provider-specific ephemeral credential payload the client uses to authenticate the realtime connection.

expires_at
required

Timestamp when the client secret expires (RFC 3339). The client must establish the realtime connection before this.

string format: date-time
model
required

Provider-side model identifier used for the realtime session.

string
provider
required

Realtime provider routing this connection (e.g. openai).

string
reasoning_effort
required

Reasoning effort tier for thinking-capable models (none, minimal, low, medium, high).

string
voice
required

Realtime voice preset selected for the connection (provider-specific).

string
voice_connection_id
required

Prefixed public identifier of the voice connection. See ID Schema.

string
Example generated
{
  "client_secret": "example",
  "expires_at": "2026-04-15T12:00:00Z",
  "model": "example",
  "provider": "example",
  "reasoning_effort": "example",
  "voice": "example",
  "voice_connection_id": "example"
}