🎉 50% OFF on all plans — Expires Jun 30 Claim now
Getting Started

Authentication

3 minutes integration Skill: beginner

Authenticating Your Requests

The AISoule REST API enforces secure, modern key authentication. Every outbound network query must provide a valid Bearer API Key in its headers.

Generating an API Key

  1. Log in to your commercial AISoule Dashboard (https://app.aisoule.com).
  2. Navigate to the sidebar settings gear: Settings → Developer API Keys.
  3. Click the "Generate New Token" button.
  4. Add a descriptive label (e.g., Staging Server, Production Dialer).
  5. Copy the secure secret key immediately.

!WARNING For security, API keys are shown only once at generation time. Store them in a secure environment variables configuration vaults (like HashiCorp Vault or AWS Secrets Manager).

Authentication Header Format

All REST requests must include your key in the standard HTTP Authorization header exactly as shown:

Authorization: Bearer YOUR_API_KEY

Troubleshooting Authentication Errors

If your API key is misconfigured or has been revoked, the request returns a standard 401 Unauthorized code:

Status CodeError CodeReason
401 UnauthorizedunauthorizedThe Authorization header is missing, malformed, or the token has been revoked.
403 ForbiddenforbiddenThe token has correct auth but lacks the required permissions scope to query the resource.

Related Doc Resources

IntroductionRate limits
Integration Playground 
# Authenticate request via Authorization Header
curl -X GET "https://api.aisoule.com/v1/profile" \
  -H "Authorization: Bearer YOUR_API_KEY"
Replace `YOUR_API_KEY` in the headers with your real dashboard secrets token!