Authentication

Overview

The Nutalk API uses API keys to authenticate requests. API keys are scoped to your workspace and provide full access to all resources within that workspace. You can create multiple API keys for different applications or environments.

Using API Keys

Include your API key in the Authorization header as a Bearer token:

curl -X GET "https://dev.nutalk.ai/v1/agents" \
  -H "Authorization: Bearer sk_live_xxxxxxxxxxxxxxxx"

1. 1

   Navigate to Settings

   From your dashboard, click Settings in the sidebar.

2. 2

   Open API Keys

   Select the API Keys tab.

3. 3

   Generate New Key

   Click Generate New Key and enter a descriptive name (e.g., “Production App” or “Development”).

4. 4

   Copy Your Key

   Copy the key immediately—it won't be displayed again after you leave the page.

If you believe an API key has been compromised, or if it's no longer needed, revoke it immediately:

1. Go to Settings → API Keys
2. Find the key you want to revoke
3. Click the Revoke button
4. Confirm the revocation

Authentication Errors

When authentication fails, the API returns one of these errors:

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  }
}