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

Quickstart

Check your Agents key and have an agent call a number in five minutes, from the terminal, Python or TypeScript.

By the end of this guide you will have checked your key and created a call with the Agents API. Everything runs in test mode: no number is dialed and nothing is billed.

Before you begin

You need:

  • A Qomni account (14-day free trial, no card).
  • A terminal with curl, or Python 3.9 or later, or Node.js 18 or later.
  1. Create a test key

    Sign up at qomni.ai. In Settings → API keys of your workspace, create a test key: it starts with sk_agents_test_. Store it in an environment variable of your shell:

    export QOMNI_KEY="sk_agents_test_…"

    The examples on this page read it from QOMNI_KEY. Do not write it in your code or push it to a repository.

  2. Install what you need

    With cURL you need nothing else. In Python we use requests; Node.js already ships fetch, and tsx runs TypeScript without compiling it.

  3. Check the key

    Ask the API for your key’s context. Save the code as ping.py or ping.mts, or paste the cURL command into your terminal:

    Run it:

    A 200 carries your workspace and livemode: false, because the key is a test key. The response may carry more fields: ignore the ones you do not know.

    200 OKjson
    {
      "product": "agents",
      "tenant": "acme",
      "cell": "co1",
      "region": "co",
      "livemode": false
    }

    A 401 means the key is missing or not valid: the error’s code field tells you which of the two. See Errors.

  4. Create a call

    Ask an agent to call a number. In test mode, +15005550001 is a magic number that always ends completed. Save the code as create_call.py or create_call.mts and run it as in the previous step:

    The API responds 201 with the call:

    201 Createdjson
    {
      "id": "call_01k8x2m4v7q9r3t5w8y1z0a2b4",
      "to": "+15005550001",
      "status": "completed",
      "livemode": false,
      "cell": "co1",
      "region": "co",
      "created_at": "2026-10-21T15:04:05+00:00"
    }

You should see

The call exists, with status completed, and no phone rang: that is how test mode works. You have just made the two calls every integration with Agents makes: check the key and create a call. GET /calls returns them, most recent first.

If in step 3 you saw 401, the code field says why: api_key_missing if the header is missing, api_key_malformed if the key was copied wrong, api_key_invalid if it was revoked.

Next step

Swap the test key for a real one (sk_agents_live_…) and the same code makes real calls. Before that, get the agent talking to your app:

Site navigation

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