API reference

The workflow, execution and webhook resources of the intended FLOWTYPE API.

Demonstration example. FLOWTYPE ORCHESTRATE does not expose a live API yet, and the values below are placeholders.

Authentication

Send your API key in the Authorization header. Keys are scoped to a workspace.

Authorization headerDemo example

Authorization: Bearer YOUR_API_KEY

Workflow API

Method	Path	Description
GET	/v1/workflows	List workflows
GET	/v1/workflows/{id}	Get a workflow definition
POST	/v1/workflows/{id}/trigger	Start an execution

Trigger a workflowDemo example

POST /v1/workflows/customer-onboarding/trigger
Authorization: Bearer YOUR_API_KEY

{ "customer": "Northwind Traders", "plan": "business" }

Response · 202 AcceptedDemo example

{
  "status": "accepted",
  "execution_id": "demo_48291"
}

Execution API

Method	Path	Description
GET	/v1/executions	List executions, filter by workflow and status
GET	/v1/executions/{id}	Get an execution and its steps
POST	/v1/executions/{id}/retry	Retry from the failed step

Get an executionDemo example

GET /v1/executions/demo_48291
Authorization: Bearer YOUR_API_KEY

Response · 200 OKDemo example

{
  "execution_id": "demo_48291",
  "workflow": "customer-onboarding",
  "status": "success",
  "duration_ms": 1810,
  "steps": [
    { "id": "trigger", "status": "success", "duration_ms": 40 },
    { "id": "classify", "status": "success", "duration_ms": 820 }
  ]
}

Webhook API

Method	Path	Description
POST	/v1/webhooks	Register an endpoint for execution events
GET	/v1/webhooks	List registered endpoints
DELETE	/v1/webhooks/{id}	Remove an endpoint

Errors and limits

Standard HTTP status codes are intended: 400 for invalid input, 401 for missing credentials, 403 for insufficient permission, 404 for unknown resources and 429 when rate limits apply. Rate limits will be documented once defined.