Quickstart

This guide takes about five minutes. You need an Eclatira account and one agent. You can create an agent in the dashboard.

1. Get an API key

Open the API keys page

Create a key

Click Create Key. The key starts with ek_.

Save it

The key is shown only once. Store it in a secret manager or an environment variable. If you lose it, revoke it and create a new one.

Keep the key on your server. A key has full access to your workspace. Never put it in browser code. See Authentication.

2. Make your first request

Send the key as a bearer token. This request lists your batches:

curl https://app.eclatira.com/api/v1/batches \
  -H "Authorization: Bearer ek_your_api_key_here"

If the key is wrong or missing, you get a 401:

{
  "error": {
    "type": "authentication_error",
    "code": "unauthorized",
    "message": "Missing or invalid API key. Use 'Authorization: Bearer ek_...'",
    "param": null,
    "request_id": "..."
  }
}

Every API error uses this same shape.

3. Talk to your agent

Place a phone call
Talk in the browser

You need the agent_id of an agent in your workspace. Replace the phone number with your own.

curl -X POST https://app.eclatira.com/api/v1/calls \
  -H "Authorization: Bearer ek_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_id": "your-agent-id",
    "to_number": "+15551234567",
    "provider": "twilio"
  }'

The call starts right away. The response tells you it was accepted:

{
  "call_id": "CAc29a9cb3a1dc3e077f4a9a25f5161e4d",
  "call_sid": "CAc29a9cb3a1dc3e077f4a9a25f5161e4d",
  "agent_id": "your-agent-id",
  "to_number": "+15551234567",
  "status": "initiated",
  "provider": "twilio",
  "warnings": []
}

Your phone should ring. To check the result later, call GET /api/v1/calls/{call_id}. You can also get the result pushed to you with a webhook.

The fastest way is the embed widget. It needs no API key and no backend. Paste this into any HTTPS page:

<script>
  window.eclatiraSettings = {
    widget_id: "YOUR_AGENT_ID",
  };
</script>
<script src="https://app.eclatira.com/widget.js" defer></script>

A button appears in the corner of the page. Click it and start talking.To build your own UI instead, follow Voice in the browser. It takes three parts:

A small endpoint on your server that creates a session with your API key.
The @eclatira/realtime library on your page.
A button that calls session.start().

Next steps

Phone calls

Personalize calls with variables and call a list of numbers.

Web sessions

Learn how browser sessions work before you build one.

Webhooks

Get the transcript and summary when a call ends.

API reference

Browse every endpoint.

Get started

Web sessions

Phone calls

Help

1. Get an API key

2. Make your first request

3. Talk to your agent

Next steps

Phone calls

Web sessions

Webhooks

API reference

​1. Get an API key

​2. Make your first request

​3. Talk to your agent

​Next steps

Phone calls

Web sessions

Webhooks

API reference

1. Get an API key

2. Make your first request

3. Talk to your agent

Next steps