API Reference

​

Base URL

All API requests should be made to:

https://api.verbalisai.com/api

​

Request Format

The VerbalisAI API uses REST principles with JSON for most endpoints. File uploads use multipart/form-data.

​

Headers

Most endpoints require the following headers:

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

For file uploads:

Authorization: Bearer YOUR_API_KEY
Content-Type: multipart/form-data

​

Response Format

All API responses follow a consistent structure:

​

Success Response

{
  "success": true,
  "data": {
    // Response data here
  }
}

​

Error Response

{
  "success": false,
  "error": "Error Type",
  "message": "Detailed error message"
}

​

HTTP Status Codes

The API uses standard HTTP status codes:

​

Rate Limiting

The API implements rate limiting to ensure fair usage:

Rate limit headers are included in responses:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640995200

​

Pagination

List endpoints support pagination using query parameters:

GET /v1/transcript/user?page=1&limit=20

Paginated responses include metadata:

{
  "success": true,
  "data": {
    "items": [...],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 150,
      "pages": 8,
      "hasNext": true,
      "hasPrev": false
    }
  }
}

​

Filtering and Sorting

Many list endpoints support filtering and sorting:

​

Filtering

GET /v1/transcript/user?status=completed&language=en

​

Sorting

GET /v1/transcript/user?sort=created_at&order=desc

​

Webhooks

VerbalisAI supports webhooks for real-time notifications. Configure webhook URLs in your dashboard to receive events for:

• Transcription completed
• Transcription failed
• Credit balance low
• Payment processed

Webhook payloads follow this format:

{
  "event": "transcription.completed",
  "data": {
    // Event-specific data
  },
  "timestamp": "2024-01-15T10:30:00Z"
}

​

SDKs and Libraries

Official SDKs are available for popular programming languages:

npm install @verbalisai/sdk

pip install verbalisai-sdk

composer require verbalisai/sdk

go get github.com/verbalisai/go-sdk

​

Testing

Use our sandbox environment for testing:

https://sandbox-api.verbalisai.com/api