Skip to content
API Reference

API Reference

Version: unreleased · Docs: 3c6ab9f2Download Markdown

The full API reference lists the public endpoints, their required fields, response schemas and HTTP status codes. Download the OpenAPI schema to generate a client for your integration.

Start with the API quickstart to authenticate. Then use Direct AI Requests, Agent Runs or Workflow Runs.

The reference covers every supported endpoint. Other routes the Redbelt app uses can change without notice, so build only on the ones listed here.

  1. Find the operation and its HTTP method.
  2. Check path parameters, request fields, and required values.
  3. Review the response for the specific success status.
  4. Send an authenticated request to your deployment’s API base URL.

An example schema describes the response shape; it is not evidence that a live request succeeded. Background operations can return 202 before their work is complete. Follow the corresponding guide to verify the result.

Each API key belongs to one organization, and every request acts in it. You don’t need to send X-Redbelt-Organization-ID. If you do, it must match the key’s organization, or the request returns 403.

Hosted and self-hosted deployments can differ in available providers, models, and integration setup. Use the API URL and credentials for the deployment you are calling. For an endpoint or output-delivery contract not listed in the public reference, contact [email protected].