Get Started

Authentication

View as Markdown

All public API endpoints require an API key in the Authorization header.

1Authorization: Bearer YOUR_API_KEY

Create an API key

1

Open the dashboard

Open your FormantAI dashboard.

2

Go to API Keys

Open Developer -> API Keys from the sidebar.

3

Create a key

Give the key a recognizable name, such as production-crm-sync or batch-calls-worker.

4

Store it securely

Copy the key once and store it in your backend secret manager. Do not expose it in browsers or mobile apps.

Example request

$curl "https://api.voice.formantai.com/v1/conversations?limit=10" \
>  -H "Authorization: Bearer $FORMANT_API_KEY"

Security recommendations

  • Store API keys in a server-side secret manager.
  • Use separate keys for production and local development.
  • Rotate keys when employees leave or integrations are retired.
  • Disable unused keys from the dashboard.
  • Never put API keys in frontend code, Git repositories, screenshots, or support tickets.

Authentication errors

Invalid or missing API keys return:

1{
2  "error": {
3    "message": "invalid or missing api key",
4    "type": "authentication_error"
5  }
6}