Get started

Build decisions into your product.

Define a flow. Publish a fixed version. Start a process with your own data, then follow every decision through the API.

01 — 03

From definition to decision.

How it works

Quickstart: link an approval group → create a designer flow → publish its draft → start a run with the published version ID → read its overview and history. Replace example IDs before sending requests.

JSON over HTTP under /v1. Local API: http://localhost:4000. Production API hosting is not provisioned by this sprint. Response examples are excerpts; OpenAPI describes the full contract.

Schema v2 supports typed fields, conditions, sequential approval groups and terminal outcomes. Schema v1 purchase flows remain supported. External approval links are supported. Outbound lifecycle webhooks are configured under Organization → Webhooks. Automatic requester-manager approval is supported with assignment=requester_manager. Parallel gates and automatic HR assignment are not available yet.

Request essentials

Authorization: Bearer $FLOWG8_API_KEY
X-Organization-Id: Your workspace UUID

Have an implementation question?Ask about this endpoint. Answers include source references.

curl -X POST "https://api.flowg8.io/v1/flow-runs" \ -H "authorization: Bearer $FLOWG8_API_KEY" \ -H "x-organization-id: 10000000-0000-4000-8000-000000000001" \ -H "idempotency-key: example-start-run-001" \ -H "content-type: application/json" \ --data-raw '{ "flowVersionId": "10000000-0000-4000-8000-000000000003", "referenceId": "deployment-example-001", "data": { "environment": "production" } }'

Get started

Build decisions into your product.

Define a flow. Publish a fixed version. Start a process with your own data, then follow every decision through the API.

01 — 03

From definition to decision.

How it works

JSON over HTTP under /v1. Local API: http://localhost:4000. Production API hosting is not provisioned by this sprint. Response examples are excerpts; OpenAPI describes the full contract.

Request essentials

Authorization: Bearer $FLOWG8_API_KEY
X-Organization-Id: Your workspace UUID

Have an implementation question?Ask about this endpoint. Answers include source references.

Build decisions into your product.

From definition to decision.

How it works

Request essentials

Ask the docs

Build decisions into your product.

From definition to decision.

How it works

Request essentials

Ask the docs