Skip to main content
The Knouds REST API lets you run deployed workflows, invoke individual registry models, manage workflow definitions, and poll async executions programmatically. Every request and response uses JSON over HTTPS.

Base URL

All endpoints are served from:
There is no version prefix in the URL. The current stable surface is the v4.13+ contract (Phase 11 capabilities + Phase 12 dashboard + Phase 13 async/webhooks). Additive changes (new optional fields, new capabilities, new endpoints) roll out continuously without versioning. Breaking changes ship with a major-version entry in the changelog.

Request format

Set Content-Type: application/json on every request that includes a body. Endpoints that accept no body (GET requests) ignore the header.

Authentication

Every API endpoint requires a valid API key passed in the x-api-key request header. Keys are generated in the Developer Dashboard (or Settings → API Keys, which redirects there).
See Authentication for the full guide on capabilities, presets, and how to handle 401 and 403 responses.

Response format

All responses — including errors — are JSON objects. Successful responses vary by endpoint. Error responses always include at minimum:
Some error codes include additional context fields. See Error codes for the complete reference.

Available endpoints

Capabilities below are the minimum required. A key with * (admin-only) passes everything.

Identity

Workflows

Models (Business+)

Executions (every tier)

Usage

Public

Account approval is required before any API access is granted. If your requests return 401 and your key is valid, check that your account is approved in addition to verifying the key.
Some session-only endpoints (/api/me, /api/credits/*, /api/api-keys/*, /api/business/admin/*) are not reachable with API keys by design (defense-in-depth on key + account management). Use the Developer Dashboard for those operations.