Skip to main content

Authentication

HubTalk AI uses two authentication methods depending on the endpoint type.

Bearer Token (JWT)

Used for data upload endpoints (audio, transcriptions, calls) and API key management.
curl -X GET "https://<base-url>/api/v1/calls" \
  -H "Authorization: Bearer YOUR_TOKEN"
Obtain your token from your system administrator. Include it in the Authorization header of every request.
Keep your Bearer token secret. Do not expose it in client-side code or public repositories.

API Key

Used for all WebAPI / external endpoints (call campaigns, campaign details).
curl -X GET "https://<base-url>/external/api/v1/some-endpoint" \
  -H "x-cybernet-api-key: YOUR_API_KEY"
API keys are generated through the API Key management endpoints and have the format {firm_prefix}${hashed_part}.

API Key Authentication Flow

Key Properties

PropertyDetails
One key per firmEach firm can have only one active and enabled key
Admin permissionsAPI keys have the same access rights as an ADMIN user for the associated firm
Non-recoverableThe full key is shown only once at creation. If lost, you must create a new one (the old one is deactivated)
Activity loggingAll operations are logged, including last_used timestamp

API Key Errors

HTTP CodeMeaning
401 UnauthorizedKey not provided or invalid format
403 ForbiddenKey is inactive, deleted, or not found

Which Method to Use

Endpoint PatternAuth MethodHeader
/external/api/v1/api-key (management)Bearer TokenAuthorization: Bearer <JWT>
/external/api/v1/call-campaign/*API Keyx-cybernet-api-key: <KEY>
/api/v1/audio/*Bearer TokenAuthorization: Bearer <JWT>
/api/v1/calls/*Bearer TokenAuthorization: Bearer <JWT>