Quickstart

This guide shows the shape of a typical Orbitali integration.

1. Create an API key

Create an API key from the dashboard settings page. Use it as a bearer token for programmatic requests.

curl https://api.orbitali.ai/v1/agents \
  -H "Authorization: Bearer $ORBITALI_API_KEY"

2. Configure your Server URL

Your Server URL is the HTTPS endpoint Orbitali calls when the agent needs dynamic context or tool execution.

https://example.com/orbitali/webhook

The endpoint should accept JSON POST requests and return JSON responses.

3. Create an agent

An agent has a name, language, voice, prompt behavior, and optional tool definitions.

{
  "name": "Receptionist",
  "language": "en",
  "voice": "default",
  "prompt": {
    "type": "static",
    "text": "You are a helpful receptionist. Keep answers concise."
  },
  "server_url": "https://example.com/orbitali/webhook"
}

4. Add tools

Tools describe what the model can ask your backend to do during a call.

{
  "name": "check_availability",
  "description": "Check whether an appointment slot is available.",
  "parameters": {
    "type": "object",
    "properties": {
      "date": { "type": "string" },
      "time": { "type": "string" }
    },
    "required": ["date", "time"]
  }
}

5. Link a phone number

Assign a claimed phone number to the agent. Incoming calls to that number will use the agent's prompt and tools.

6. Test a call

Call the assigned number and watch the call history in the dashboard. Tool calls and transcript events appear on the call detail page.