API Documentation

Loading documentation...

Failed to load documentation

There was a problem loading the documentation. Please try again.

Quick Start

Learn how to integrate the Vantio API into your application in less than 5 minutes.

1
Get your API Key

Go to the API Keys section and create a new key. Store it securely - you won't be able to see it again.

2
Make your first request

Use the following code to send your first message to the chat API:

bash
curl -X POST https://api.vantio.pro/v1/chat \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Hello, how does this work?"
  }'
3
Receive the response

The API will respond with a JSON object like this:

json
{
  "ok": true,
  "answer": "Hello! I'm the Vantio assistant...",
  "meta": {
    "conversation_id": "conv-uuid-123",
    "rag_used": false,
    "tokens_used": 145
  }
}
Base URL

All API requests use this base URL: https://api.vantio.pro/v1

Authentication

The Vantio API uses API keys to authenticate requests. Include your API key in the Authorization header of every request.

Authorization: Bearer YOUR_API_KEY
Keep your API key secure

Never expose your API key in client-side code or public repositories. Use environment variables to store it securely.

API Key Format

Vantio API keys follow this format:

  • vdek_prod_* - Production keys
  • vdek_dev_* - Development/sandbox keys

Rate Limits

API requests are rate limited based on your subscription plan:

Plan Requests/minute Requests/day
Free 10 1,000
Pro 50 50,000
Business 200 500,000
Enterprise Custom Unlimited

Rate limit headers are included in every response:

  • X-RateLimit-Limit - Maximum requests allowed
  • X-RateLimit-Remaining - Requests remaining
  • X-RateLimit-Reset - Unix timestamp when limit resets

Error Handling

The API uses standard HTTP status codes and returns error details in JSON format:

json
{
  "ok": false,
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Rate limit exceeded. Try again in 60 seconds."
  }
}

Common Error Codes

HTTP Status Error Code Description
400 invalid_request The request was malformed or missing required fields
401 unauthorized Invalid or missing API key
403 forbidden The API key doesn't have permission for this action
429 rate_limit_exceeded Too many requests - slow down
500 internal_error Something went wrong on our end

Next Steps