Your first Ventryx integration

Prerequisites

Before you begin, make sure you have:

• A Ventryx account — request access here if you don't have one
• A working HTTP client (curl, Postman, or your preferred SDK)
• Basic familiarity with REST APIs and JSON

Step 1 — Create your API key

After logging in, navigate to Settings → API Keys and click New Key. Give it a descriptive name (e.g., dev-local) and select the scopes your integration needs.

Your key will look like this:

vtx_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6

Step 2 — Authenticate a request

Pass your API key in the Authorization header as a Bearer token on every request.

curl https://api.ventryx.io/v1/ping \
  -H "Authorization: Bearer vtx_live_your_key_here" \
  -H "Content-Type: application/json"

A successful response returns HTTP 200 with a JSON body:

{
  "status": "ok",
  "timestamp": "2026-04-02T10:00:00Z",
  "organization": "your-org-slug"
}

Step 3 — Make your first real request

Once authenticated, you can start interacting with platform resources. Here's how to list your active workflows:

curl https://api.ventryx.io/v1/workflows \
  -H "Authorization: Bearer vtx_live_your_key_here"

{
  "data": [
    {
      "id": "wf_01HXYZ",
      "name": "Invoice Approval",
      "status": "active",
      "created_at": "2026-03-15T08:22:00Z"
    }
  ],
  "meta": {
    "total": 1,
    "page": 1
  }
}

Base URL

All API requests are made to the following base URL:

https://api.ventryx.io/v1

SDKs

Official SDKs are available for the most common environments: