Skip to content
Qomni

Agents

Create an agent, give it a voice and put it to work: REST for the calls and a WebSocket to talk to it in real time from your app.

Base URL
https://api.qomni.ai/agents/v1
Key
sk_agents_test_…
curl https://api.qomni.ai/agents/v1/calls \
  -H "Authorization: Bearer sk_agents_test_…"

What's new

Navigation

Create realtime session

Open a realtime voice conversation with an agent.

Returns a WebSocket url valid for 60 seconds. The long-lived API key never travels on the socket: the session does, and its prefix (rts_{cell}_) takes it to the workspace's cell.

POST
https://api.qomni.ai/agents/v1/realtime/sessions

Authorization

  • apiKeyHTTP Bearer (sk_agents_{live|test}_{cell}_{body}{checksum})Required

Request bodyJSONOptional

  • instructionsOptionalstring

    What the agent should do in this conversation.

    maxLength: 500

Returns

201

The session.

JSON
  • idstringRequired
    pattern: ^rts_[0-9a-z]+$
  • urlstringRequired

    Open within 60 s; speaks asyncapi.yaml.

    format: uri
  • client_secretstringRequired

    The session, for clients that build the URL themselves.

    pattern: ^rts_[a-z]{2}[0-9]+_
  • expires_atstringRequired

    Connect before this instant.

    format: date-time
  • max_duration_secondsintegerRequired
  • livemodebooleanRequired
  • cellstringRequired

401

Missing or invalid credentials (unauthenticated).
JSON
  • errorobjectRequired
    • codestringRequired

      Stable, machine-readable; each operation lists the codes it can return.

      pattern: ^[a-z][a-z0-9_]*$
    • messagestringRequired

      For people; may change at any time.

    • request_idOptionalstring
    • fieldsOptionalmap ofarray<string>

      Only for validation_failed, the messages per field.

403

Valid credentials that may not do this (insufficient_scope, api_key_wrong_product…).
JSON
  • errorobjectRequired
    • codestringRequired

      Stable, machine-readable; each operation lists the codes it can return.

      pattern: ^[a-z][a-z0-9_]*$
    • messagestringRequired

      For people; may change at any time.

    • request_idOptionalstring
    • fieldsOptionalmap ofarray<string>

      Only for validation_failed, the messages per field.

422

The request does not match the contract (validation_failed).
JSON
  • errorobjectRequired
    • codestringRequired

      Stable, machine-readable; each operation lists the codes it can return.

      pattern: ^[a-z][a-z0-9_]*$
    • messagestringRequired

      For people; may change at any time.

    • request_idOptionalstring
    • fieldsOptionalmap ofarray<string>

      Only for validation_failed, the messages per field.

429

Too many requests for this key (rate_limited); retry after Retry-After seconds.
JSON
  • errorobjectRequired
    • codestringRequired

      Stable, machine-readable; each operation lists the codes it can return.

      pattern: ^[a-z][a-z0-9_]*$
    • messagestringRequired

      For people; may change at any time.

    • request_idOptionalstring
    • fieldsOptionalmap ofarray<string>

      Only for validation_failed, the messages per field.

New

2 of 7 steps doneNext: the platform in production

Qomni is in private beta

The API and the app are not open yet. See what is done, what is left and how it opens, step by step until the first customer.

Type to search…

↑↓ move↵ openEsc to close