Veezoo API
The Veezoo API allows you to interact programmatically with Veezoo, enabling you to integrate Veezoo into your own applications and workflows.
Authentication
All API requests require authentication using an API key. Include your API key in the X-Api-Key request header:
X-Api-Key: <Api-Key>
You can create and manage API keys in Veezoo Admin on the API Keys page.
Knowledge Graph
API endpoints which access a Knowlede Graph require the kgId query parameter to specify the ID of the Knowledge
Graph to use. You can find the ID of a Knowledge Graph on its Configuration page in
Veezoo Studio or in the id query parameter in your browser's address bar when
working with the Knowledge Graph in Veezoo or Veezoo Studio.
Rate Limiting
API requests are rate-limited. If you exceed the rate limit, you will receive a 429 Too Many Requests error
response. The following table shows the effective rate limits:
| Type | Max. requests / second | Description |
|---|---|---|
| Global rate limit | 25 | Rate limit across all API endpoints |
| Per-endpoint rate limit | 10 | Rate limit per individual API endpoint |
API Request IDs
Veezoo assigns each API request a unique request ID and returns it in the X-Request-Id header of the response.
When encountering a problem, you can include this request ID when contacting Veezoo support for assistance.
Authentication
- API Key: ApiKeyAuth
API requests are authenticated using an API key, which is included in the X-Api-Key request header
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | X-Api-Key |