Getting Started
What is Vook?
What is Vook?
Vook is a modern REST API service that lets you integrate powerful features into your applications with minimal setup. It provides a consistent, developer-friendly interface with JSON responses, clear error codes, and predictable behavior so you can ship faster and with confidence.
How do I sign up?
How do I sign up?
Create a free account at https://app.vook.ai. Once you’ve signed up, you can generate your first API key and start making requests right away.
Do I need a credit card to get started?
Do I need a credit card to get started?
No. Vook offers a free tier that you can access without providing a credit card. You can explore the API, test integrations, and build your application before deciding to upgrade. A credit card is only required when you choose a paid plan.
Where do I find my API key?
Where do I find my API key?
Log in to your dashboard at https://app.vook.ai, then navigate to Settings → API Keys. From there you can view, create, and manage all of your API keys.
Authentication
How do I authenticate my API requests?
How do I authenticate my API requests?
Pass your API key as a Bearer token in the All requests must be made over HTTPS. Requests without a valid authorization header will receive a
Authorization header of every request:401 Unauthorized response.Can I have multiple API keys?
Can I have multiple API keys?
Yes. You can create as many API keys as you need. We recommend creating separate keys for each environment (development, staging, production) and each third-party integration. This makes it easy to revoke a single key without affecting the rest of your systems.
What should I do if my API key is compromised?
What should I do if my API key is compromised?
Act quickly — revoke the compromised key immediately from Settings → API Keys in your dashboard. Then generate a new key and update any integrations that were using the old one. Revoking a key takes effect instantly, so any further requests using that key will be rejected.
How do I rotate my API key?
How do I rotate my API key?
Follow these steps to rotate a key with zero downtime:
- Go to Settings → API Keys and generate a new API key.
- Update all of your applications and integrations to use the new key.
- Verify that your integrations are working correctly with the new key.
- Revoke the old key.
Rate Limits & Usage
What are the rate limits?
What are the rate limits?
Rate limits vary depending on your plan. Check the rate limits guide for a full breakdown of the limits that apply to your account. You can also inspect the rate limit headers returned with every API response to monitor your current usage in real time.
What happens when I exceed my rate limit?
What happens when I exceed my rate limit?
When you exceed your rate limit, the API returns a
429 Too Many Requests response. The response includes a Retry-After header that tells you how many seconds to wait before sending your next request. Build retry logic with this header into your integration to handle bursts gracefully.How can I increase my rate limits?
How can I increase my rate limits?
Upgrade to a higher plan from your dashboard at https://app.vook.ai. Each plan tier comes with higher rate limits. If you have high-volume needs that exceed standard plan limits, contact support@vook.ai to discuss a custom arrangement.
Troubleshooting
I'm getting a 401 error
I'm getting a 401 error
A
401 Unauthorized error means your request is missing a valid API key or the key was not formatted correctly. Check the following:- Your
Authorizationheader is present and uses the formatBearer YOUR_API_KEY. - You are using the correct API key for the environment you’re targeting.
- The key has not been revoked.
I'm getting a 403 error
I'm getting a 403 error
A
403 Forbidden error means your API key was recognized, but it doesn’t have permission to perform the requested action. Review the scopes assigned to your key in Settings → API Keys and ensure the key has the necessary permissions for the endpoint you’re calling.My request is returning unexpected results
My request is returning unexpected results
Every API response includes an
X-Request-ID header with a unique identifier for that request. Copy this value before reaching out — including it when you contact support allows us to look up the exact request in our logs and diagnose the issue much faster.How do I contact support?
How do I contact support?
Email us at support@vook.ai. To help us resolve your issue as quickly as possible, include the following in your message:
- The
request_idfrom theX-Request-IDresponse header. - The full request URL and HTTP method you used.
- Any relevant request or response bodies (redact your API key before sending).