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

Ask the demo to call

The website's "Llámame": the demo agent calls the visitor's phone from Qomni's demo number, in test mode, for at most max_duration_seconds. No key: Cloudflare Turnstile proves a person asked (turnstile_token), and the limits are the demo session's per IP plus one call per number a day and the same daily budget. Only numbers of Colombia, Mexico, Brazil and the US/Canada (+57, +52, +55, +1).

POST
https://api.qomni.ai/agents/v1/demo_calls

Request bodyJSONRequired

  • phonestringRequired

    The number to call, E.164.

    pattern: ^\+(57|52|55|1)[0-9]{7,12}$
  • turnstile_tokenstringRequired

    The token Cloudflare Turnstile gave the website's form.

    maxLength: 2048
  • nameOptionalstring

    How the agent greets the person; optional.

    maxLength: 80
  • languageOptionalesorenorpt-br
    default: "en"
  • agentOptionalreceptionorschedulingorqualificationorsupportorcollectionsorreminders

    Which demo agent answers - a receptionist, appointment booking, lead qualification, first-level support, collections or appointment reminders.

    default: "reception"

Returns

202

The call is being placed; the phone rings within seconds.

JSON
  • callstringRequired
    pattern: ^call_[0-9a-z]+$
  • max_duration_secondsintegerRequired

403

Turnstile did not confirm a person (captcha_failed), or the request came from another site (origin_not_allowed).
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

This address or this number has used the demo (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.

503

The demo has used today's minutes, or places no calls in this environment (demo_unavailable).
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