Ventryx REST API

Base URL

https://api.ventryx.io/v1

All requests must be made over HTTPS. HTTP requests are rejected.

Request format

Pass Content-Type: application/json on all POST and PATCH requests. Authentication uses Bearer tokens in the Authorization header.

Authorization: Bearer vtx_live_your_key_here
Content-Type: application/json
Ventryx-Version: 2026-04-01

Response format

All responses return JSON with a consistent envelope:

{
  "data": { ... },
  "meta": {
    "total": 42,
    "page": 1,
    "per_page": 20
  }
}

{
  "error": {
    "code": "invalid_api_key",
    "message": "The API key provided is invalid or has been revoked.",
    "status": 401
  }
}

Rate limits

Rate limits are applied per API key. Limits vary by plan:

Rate limit headers are returned on every response:

X-RateLimit-Limit: 300
X-RateLimit-Remaining: 247
X-RateLimit-Reset: 1743591600

Endpoints

Workflows

Events

API Keys

HTTP status codes