Skip to content

Voki APIVideo Call Platform

Complete REST API and WebSocket documentation for integrating with the Voki v4.0 platform

Overview

The Voki API allows you to integrate and automate all features of the video call platform. Built on Elixir/Phoenix, the API provides:

  • JWT Authentication with MFA (TOTP) support
  • Multi-tenancy with complete tenant isolation
  • Full CRUD for all system entities
  • Real-time Analytics with materialized views
  • WebSocket for bidirectional communication
  • Asaas Webhooks for automated billing

Base URL

https://voki.avanter.com.br/api/

Response Format

All responses follow this pattern:

Success (object)

json
{
  "data": {
    "id": "uuid",
    "field": "value"
  }
}

Success (paginated list)

json
{
  "data": [...],
  "meta": {
    "current_page": 1,
    "page_size": 20,
    "total_pages": 5,
    "total_count": 100
  }
}

Validation error

json
{
  "errors": {
    "email": ["can't be blank"],
    "name": ["must be at least 2 characters"]
  }
}

Generic error

json
{
  "errors": {
    "detail": "Unauthorized"
  }
}

Rate Limiting

EndpointLimit
/api/auth/*5 requests/minute
Public endpoints30 requests/minute
Authenticated endpointsNo explicit limit

Documentação da API Voki v4.0