Skip to main content

API

ORQO provides an API for programmatic access. Use it to trigger workflows, receive callbacks, and integrate ORQO into your automation pipelines.

Authentication​

API requests are authenticated using API tokens. Generate a token from Settings → API Tokens in the dashboard.

Include the token in the Authorization header:

Authorization: Bearer your-api-token

Trigger a Workflow​

Start a workflow run programmatically:

POST /api/v1/trigger
Content-Type: application/json
Authorization: Bearer your-api-token

{
  "workflow_id": 42,
  "input": "Process the latest customer feedback data"
}

This creates a new workflow run and returns the run ID. The workflow executes asynchronously.

Callbacks​

When a workflow run completes, ORQO can notify your system via a callback:

POST /api/v1/callback

Configure callback URLs on your workflow or trigger to receive notifications when runs complete, fail, or produce output.

Use Cases​

  • CI/CD integration — Trigger a review workflow when a PR is opened.
  • Monitoring — Kick off an analysis workflow when an alert fires.
  • Scheduled automation — Use an external scheduler to trigger workflows with dynamic input.
  • Chaining — One workflow's output triggers another workflow via the API.
note

A full OpenAPI specification is planned. The Redocusaurus integration is pre-configured and will be enabled when the spec is ready.