Skip to main content
POST
/
v2
/
call
/
web
Initiate AI Web Call
curl --request POST \
  --url https://api.voice-agents.miraiminds.co/v2/call/web \
  --header 'Content-Type: application/json' \
  --header 'workspace: <workspace>' \
  --header 'x-private-key: <api-key>' \
  --header 'x-public-key: <api-key>' \
  --data '
{
  "assistant": "<string>"
}
'
{
  "success": true,
  "token": "<string>",
  "error": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.miraiminds.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-public-key
string
header
required
x-private-key
string
header
required

Headers

x-public-key
string
required
x-private-key
string
required
workspace
string
required

Body

application/json
assistant
string
required

Assistant ID

systemPrompt
string

Optional system prompt to override the default assistant prompt.

payload
object

Payload structure depends on the assistant variant.

metadata
object

Response

Web Call Initiated

success
boolean
token
string

LiveKit token for joining the web call.

error
object