API Overview

Introduction

The Veya API allows you to programmatically interact with the platform. Send messages, manage contacts, and build custom integrations.

Base URL

All API requests should be made to:

https://api.veya.cloud/api

Interactive Documentation

Explore our API interactively at:

api.veya.cloud/api-docs

Request Format

All requests should:

• Use HTTPS
• Include authentication header
• Send JSON body for POST/PUT/PATCH requests
• Accept JSON responses

Example Request

curl -X POST https://api.veya.cloud/api/messages \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+1234567890",
    "type": "text",
    "text": "Hello from API!"
  }'

Response Format

All responses are JSON with consistent structure:

Success Response

{
  "success": true,
  "data": {
    "id": "msg_123",
    "status": "sent"
  }
}

Error Response

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Phone number is required"
  }
}

HTTP Status Codes

Rate Limits

API requests are rate limited:

• Standard: 100 requests/minute
• Messages: 50 messages/second

Rate limit headers:

• X-RateLimit-Limit: Total allowed
• X-RateLimit-Remaining: Remaining requests
• X-RateLimit-Reset: Reset timestamp

SDKs & Libraries

Currently, we provide a REST API with OpenAPI specification. Use any HTTP client or generate SDKs from our OpenAPI spec.

Next Steps

• Authentication - Set up API access
• Interactive Docs - Try the API