REST API

​

Authentication

curl https://api.zeroruntime.ai/v1/agents \
  -H "Authorization: <your-token>"

​

Agents, versions and deployments

​

Naming things

"llm": [{ "model": "openai/gpt-4o", "apiKey": "sk-proj-…" }]

• Read back masked. Responses never return a key in full. It comes back masked, with only the last four characters showing: "apiKey": "••••••••••••AbCd".
• Send the full key every time. On create and on update, every BYOK entry needs its full apiKey. A masked value is rejected with INVALID_TYPE, so after a GET, put the full keys back before you send the config.
• Changing a key doesn’t delete the old one, so older versions still run.

​

The config object

​

Knowledge bases

• One create endpoint. POST /v1/knowledge-bases takes files as multipart/form-data, or website pages or text as JSON.
• Website pages must all be on one domain. Exactly the pages you list are parsed. Use Discover pages to find them.
• Processing runs in the background. Poll Get knowledge base status until it’s ready.
• Edit the content with Edit knowledge base content. Each edit is a new version, selected automatically once it finishes indexing.
• Versions. A website’s auto-refresh adds a new version on every run. Agents read the current version, and you can roll back with Set current version.
• Folders group knowledge bases, up to 5 levels deep. Deleting a folder keeps the knowledge bases inside it.

curl -X POST https://api.zeroruntime.ai/v1/knowledge-bases \
  -H "Authorization: <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Help center: billing",
    "source": {
      "type": "url",
      "config": {
        "pages": [
          "https://help.example.com/billing",
          "https://help.example.com/plans"
        ]
      }
    }
  }'

​

Telephony

• sipRegion is one of auto, us002, in002. auto stores no region and lets us pick.
• mediaEncryption is enable or disable (default disable).
• transport is udp, tcp or tls (default tls).
• Numbers are always E.164, with the +.

​

Batch calls

• Before you start, you need a number with an outbound gateway, and an outbound routing rule on it that points at your agent. Pass the number as phoneNumber (E.164).
• The file is .csv, .xls or .xlsx, at most 5 MB, with a phone_number column. Every other column reaches the agent as metadata for that call.
• schedule, retry and webhook are JSON strings inside the form. Leave schedule out to start calling as soon as parsing finishes.
• Follow progress with Get batch call: parsing → scheduled or running → completed. A file that can’t be used ends in parse_failed, with the reason in parseError.

curl -X POST https://api.zeroruntime.ai/v1/batch-calls \
  -H "Authorization: <your-token>" \
  -F "file=@customers.csv" \
  -F "name=October renewals" \
  -F "phoneNumber=+14155550100"

​

Agent sessions

• One turn is one exchange. user and agent carry the transcript and speech times in Unix epoch milliseconds.
• Each stage is its own block: stt, llm, tts (or realtime for speech-to-speech models), eou and denoise, with the provider, model, latency and usage.
• A stage that didn’t run is null. The greeting has no stt or llm, and a turn where the user was cut off may have no llm or tts.
• The agent’s transcript is what it generated. If the user interrupted, it can be longer than what was actually heard; interrupted tells you when.

curl "https://api.zeroruntime.ai/v1/agents/sessions?roomId=kq1v-wa7n-p75u" \
  -H "Authorization: <your-token>"