Skip to main content

Base URL

All API requests should be made to:
https://api.enviaai.app/v1

Authentication

All API endpoints require authentication using a Bearer token. Include your API key in the Authorization header:
Authorization: Bearer your-api-key

Get your API key

Create and manage API keys in the Developer Portal

Request Format

  • All requests must include Content-Type: application/json header
  • Request bodies should be valid JSON
  • Phone numbers should be in international format without + or spaces (e.g., 5511999999999)

Response Format

All responses are JSON objects with the following structure:
Success Response
{
  "success": true,
  "data": { ... }
}
Error Response
{
  "success": false,
  "error": {
    "code": "error_code",
    "message": "Human-readable error message",
    "requestId": "req_abc123"
  }
}

HTTP Status Codes

StatusDescription
200Success
201Created
400Bad Request - Invalid parameters
401Unauthorized - Invalid or missing API key
403Forbidden - Insufficient permissions
404Not Found - Resource doesn’t exist
429Too Many Requests - Rate limit exceeded
500Internal Server Error

Rate Limits

Rate limits are applied per API key. Limits vary by plan:
PlanRequests/Minute
Free500
Starter2,000
Pro10,000
EnterpriseCustom
Rate limit information is included in response headers:
X-RateLimit-Limit: 10000
X-RateLimit-Remaining: 9999
X-RateLimit-Reset: 1706961600

API Endpoints

SDKs

We provide official SDKs for easier integration:

Versioning

The API is versioned using URL path (e.g., /v1/). When we make breaking changes, we release a new version while maintaining support for older versions.
The current API version is v1. We’ll notify you via email before deprecating any version.

Support

Need help? Contact us: