Skip to main content

Authentication

Learn how to authenticate with the VoiceByAuribus API.

Overview

VoiceByAuribus API uses OAuth 2.0 Client Credentials grant for machine-to-machine authentication.

Authentication Flow

  1. Exchange your credentials for an access token
  2. Include the token in the Authorization header
  3. Tokens expire after 1 hour

Getting Credentials

Contact support@auribus.io to receive your API credentials.

Obtaining an Access Token

curl -X POST https://auth.auribus.io/oauth2/token \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "grant_type=client_credentials" \
-d "client_id=YOUR_CLIENT_ID" \
-d "client_secret=YOUR_CLIENT_SECRET" \
-d "scope=voice-by-auribus-api/base"

Using the Access Token

Include the token in all API requests:

curl -X GET https://api.auribus.io/api/v1/voices \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Token Expiration

Tokens expire after 1 hour. Implement automatic token refresh in your application.

Check Your Token and Scopes

Use the built-in auth endpoints to verify your token without hitting business APIs:

# Is my token valid right now?
curl -X GET https://api.auribus.io/api/v1/auth/status \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

# What scopes/claims are on this token?
curl -X GET https://api.auribus.io/api/v1/auth/current-user \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
  • auth/status returns whether the request is authenticated/authorized.
  • auth/current-user echoes the client id, scopes, and is_admin flag so you can troubleshoot scope issues quickly.