Skip to main content
The Vook API is a REST API that lets you interact with Vook resources over HTTPS. Every request you make targets a specific endpoint, sends or receives JSON, and is authenticated with an API key. Before you start building, familiarize yourself with how the API is structured — understanding these fundamentals will help you debug faster, handle errors gracefully, and write more resilient integrations.

​
Base URL

All API endpoints are relative to the following base URL: 
https://api.vook.ai/v1
Never hardcode full endpoint URLs in your application. Instead, store the base URL in an environment variable and construct paths relative to it. This makes it straightforward to adapt your code if the base URL ever changes. 
BASE_URL="https://api.vook.ai/v1"

​
Versioning

The Vook API is versioned using a URL path prefix. The current version is v1: 
https://api.vook.ai/v1/...
When Vook introduces a breaking change — such as renaming a field, removing an endpoint, or altering response structure — the version number increments to /v2, /v3, and so on. Non-breaking changes (new optional fields, new endpoints, new query parameters) are added to the current version without a version bump. You will always receive advance notice before a version is deprecated, giving you time to migrate your integration.

​
Request Format

All requests to the Vook API must be made over HTTPS. The API uses standard HTTP methods:
MethodUsage
GETRetrieve a resource or list
POSTCreate a new resource
PUTReplace a resource entirely
PATCHPartially update a resource
DELETEDelete a resource
For any request that sends a body (POST, PUT, PATCH), encode it as JSON and set the Content-Type header accordingly: 
curl https://api.vook.ai/v1/items \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "My Item"}'
GET and DELETE requests do not require a Content-Type header.

​
Response Format

Every response from the Vook API is JSON. Successful responses wrap the primary resource or collection in a data envelope: 
{
  "data": {
    "id": "item_01J8KZ2X",
    "name": "My Item",
    "created_at": "2024-11-01T12:00:00Z"
  },
  "meta": {
    "request_id": "req_abc123"
  }
}
Error responses use a different top-level structure with an error object and a human-readable message: 
{
  "error": {
    "code": "not_found",
    "message": "The requested resource could not be found.",
    "request_id": "req_xyz789"
  }
}
See the Responses and Errors pages for full details on status codes, envelopes, and error codes.

​
Rate Limiting

The Vook API enforces rate limits to ensure fair use and platform stability. Every response includes the following headers so you can track your current usage:
HeaderDescription
X-RateLimit-LimitThe maximum number of requests allowed in the current window
X-RateLimit-RemainingThe number of requests remaining in the current window
X-RateLimit-ResetUnix timestamp (UTC) when the current window resets
When you exceed your limit, the API returns a 429 Too Many Requests response. Use the Retry-After header included in that response to know how long to wait before retrying. 
# Example rate limit headers on a successful response
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 874
X-RateLimit-Reset: 1730462400
Rate limits are applied per API key. If you need a higher limit for a production workload, contact support@vook.ai.

​
Explore the Core Concepts

Requests

Learn how to structure headers, request bodies, query parameters, and idempotency keys.

Responses

Understand the response envelope, pagination, and HTTP status codes.

Errors

Explore error codes, response format, and how to handle failures gracefully.

API Reference

Browse the full list of endpoints, parameters, and response schemas.