Documentation
Concepts and a quickstart for building with FLOWTYPE ORCHESTRATE. These pages describe the intended developer experience.
Demonstration example. FLOWTYPE ORCHESTRATE does not expose a live API yet, and the values below are placeholders.
Introduction
FLOWTYPE ORCHESTRATE is designed so that everything you can do in the workspace can also be done through an API: define workflows, trigger them, read executions and receive events.
- API: create, trigger and inspect workflows and executions
- Webhooks: start workflows from events and receive execution events
- SDK: a typed client that wraps the API (roadmap)
Concepts
| Term | Meaning |
|---|---|
| Workflow | A versioned definition of a trigger and steps. |
| Execution | One run of a workflow, identified by an execution ID. |
| Step | A unit of work inside a workflow: rules, AI, connector, approval. |
| Trigger | What starts an execution: webhook, schedule or API call. |
Quickstart
- Create a workspace and an API key (placeholder flow).
- Choose a workflow, for example customer-onboarding.
- Send a trigger request with your payload.
- Read the execution to see its status and steps.
Trigger a workflowDemo example
POST /v1/workflows/customer-onboarding/trigger
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
{
"customer": "Northwind Traders",
"plan": "business"
}Response · 202 AcceptedDemo example
{
"status": "accepted",
"execution_id": "demo_48291"
}Authentication
Requests are intended to be authenticated with a workspace-scoped API key sent as a bearer token. Keys would be created and revoked in workspace settings and never displayed again after creation.
Errors
Errors are intended to return a JSON body with a code, a message and a request ID you can quote to support.
Error response (illustrative)Demo example
{
"error": {
"code": "workflow_not_found",
"message": "No workflow with that ID exists in this workspace.",
"request_id": "req_demo_7f3a"
}
}