Skip to main content

​
API Overview

The HubTalk AI REST API gives you programmatic access to the platform’s core capabilities: managing call campaigns, uploading audio recordings, submitting transcriptions, and retrieving processed call data.

​
Base URL

The base URL is provided during onboarding or by your system administrator. All API requests are made to this base URL. 
https://<your-base-url>

​
Two API Surfaces

HubTalk AI exposes two sets of endpoints:

​
1. WebAPI (External Endpoints)

These endpoints are prefixed with /external/ and use API Key authentication. They are designed for programmatic integration: All requests pass through the API Gateway with the prefix: 
/external/{path}
For example, if the backend endpoint is /api/v1/some-endpoint, the external URL is: 
/external/api/v1/some-endpoint

​
2. Data Upload API

These endpoints use Bearer token authentication and handle audio/transcription data:

​
Authentication

Two authentication methods are used depending on the endpoint:
MethodHeaderUsed For
API Keyx-cybernet-api-key: <API_KEY>WebAPI / external endpoints (campaigns, etc.)
Bearer TokenAuthorization: Bearer <TOKEN>Data upload endpoints (audio, transcriptions, calls)
See Authentication for full details.

​
Response Format

All endpoints return JSON. Successful responses follow this pattern: 
{
  "status": "success",
  "data": { ... }
}
Error responses include an error code and message: 
{
  "status": "error",
  "code": "ERROR_CODE",
  "message": "Human-readable description",
  "details": { ... }
}
See Errors & Troubleshooting for the full list of error codes.

​
Rate Limits & Constraints

ConstraintValue
One API key per firmA firm can only have one active API key
Max audio file size50 MB (single upload)
Max CSV/ZIP size50 MB (batch upload)
Presigned URL expiry1 hour (3600 seconds)
Phone number format7–15 digits, may start with +
Supported audio formats.wav, .mp3, .flac, .ogg, .aiff, .au
Archive format.zip only
Metadata format.csv or .xlsx