API reference

Run any workflow from your own code

Send one request with an API key and get the workflow's result back as JSON, or let it run in the background.

POSThttps://workflow.ubex.ai/api/v1/execute

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "workflow_id": "wf_abc123",
  "inputs": { "prompt": "Analyze this text..." },
  "async": false
}

200Response

{
  "success": true,
  "execution_id": "exec_789",
  "status": "completed",
  "output": { "result": "Analysis complete..." }
}

Reference

Everything a request needs

AuthenticationCreate, use and revoke the API keys that sign every request.Open Execute WorkflowRun a workflow with inputs and get its output, or start it in the background.Open API TriggerGive a workflow its own endpoint, with authentication and its own request body.Open Template SyntaxUse the request's inputs inside any node with variables, filters and loops.Open

API basics

API Overview

Integrate Ubex workflows into your applications.

Base URL

https://workflow.ubex.ai/api/v1

Authentication

All API requests require authentication via API key:

Authorization: Bearer YOUR_API_KEY

Rate Limits

Plan	Requests/minute
Free	10
Pro	100
Enterprise	Unlimited

Response Format

All responses are JSON:

{
  "success": true,
  "data": { ... },
  "error": null
}

Error Handling

Errors include a code and message:

{
  "success": false,
  "data": null,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "The provided API key is invalid"
  }
}

We update these pages often. Spotted something out of date? Tell us