Skip to main content
Welcome to the Vook API reference. This section covers every available endpoint, explains how requests and responses are structured, and gives you everything you need to start integrating Vook into your application. Whether you’re querying resources, handling webhooks, or building an automated workflow, you’ll find the technical details you need here.

​
Base URL

All API requests are made over HTTPS to the following base URL: 
https://api.vook.ai/v1
Prefix every endpoint path with this URL. For example, a health-check request goes to https://api.vook.ai/v1/.

​
API Versioning

The current stable version of the Vook API is v1, reflected in the /v1 path prefix. When Vook introduces breaking changes — such as removed fields, changed response shapes, or new required parameters — those changes ship under a new version prefix (e.g., /v2). Your existing /v1 integrations continue working without modification until you choose to migrate. Non-breaking additions, such as new optional fields or new endpoints, may be added to the current version at any time. Build your integration to tolerate unknown JSON keys in responses.

​
Request Format

Every request to the Vook API must meet these requirements:
  • Protocol: HTTPS only. HTTP requests are rejected.
  • Content-Type: Include Content-Type: application/json on all requests that send a body (POST, PATCH, PUT).
  • Encoding: Request bodies must be valid JSON encoded in UTF-8.
  • Authentication: Include your API key on every request. See Authentication for details.

​
Response Format

All responses from the Vook API are JSON-encoded. The top-level structure depends on the outcome of the request:
  • Successful responses wrap the primary payload in a data key:
{
  "data": {
    "id": "res_abc123",
    "created_at": "2024-01-15T10:30:00Z"
  }
}
  • List responses return an array under data, along with pagination metadata:
{
  "data": [...],
  "meta": {
    "total": 142,
    "page": 1,
    "per_page": 20
  }
}
  • Error responses use a separate error envelope. See Errors for the full structure.

​
SDKs and Tools

The Vook API is a standard REST API — you can call it from any HTTP client or language. Common options include:
  • curl — great for quick testing from the terminal
  • Postman — import the OpenAPI spec from https://api.vook.ai/openapi.json to auto-generate a collection
  • JavaScript / TypeScript — use the native fetch API or libraries like axios
  • Python — use the requests or httpx libraries
  • Any language — if it can make an HTTPS request and parse JSON, it works with the Vook API

​
API Status

Check real-time uptime, view incident history, and subscribe to status updates at: https://status.vook.ai If you encounter unexpected errors, always check the status page before opening a support ticket — the issue may be a known incident already being addressed.

​
Where to Go Next

Authentication

Learn how to pass your API key and manage key scopes.

Errors

Understand every error code, HTTP status, and how to handle failures.

Endpoints

Browse all available endpoints organized by resource.