Quickstart

Quickstart

From creating a token to your first flow created by a program. The examples use curl; any language that can make an HTTP request will do.

1Create a token

In the application, open Settings › App options › My API tokens, then “Create a token”. Give it a name, tick the rights your program needs, choose how long it lasts.

Open the API tokens

The token is shown only once: copy it at once and keep it like a password. For a program that must outlive its author, an admin can create an organisation token.

2First call

Every request carries the token in the Authorization header. Start by asking the API who you are:

Command
curl https://beta.unwind-app.com/api/v1/me \
  -H "Authorization: Bearer saw_pat_…"
Answer
{
  "id": 42,
  "name": "Camille Martin",
  "kind": "user",
  "organisation_id": null,
  "scopes": ["read", "write"]
}

3Read your flows

Your binders and flows live in spaces; “me” is your own. List what it holds, then read the steps of a flow:

Command
# What sits at the root of your space
curl https://beta.unwind-app.com/api/v1/spaces/me \
  -H "Authorization: Bearer saw_pat_…"

# The steps of flow 128, in order
curl https://beta.unwind-app.com/api/v1/flows/128/steps \
  -H "Authorization: Bearer saw_pat_…"

The API uses the words of the application: flow, binder.

4Create a flow

With the “Edit” right. The flow is born offline, with one empty first step in its draft.

Command
curl -X POST https://beta.unwind-app.com/api/v1/flows \
  -H "Authorization: Bearer saw_pat_…" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: onboarding-2026-10-05" \
  -d '{"name": "Welcoming a newcomer"}'

The Idempotency-Key header is optional: sent again with the same key, the request does not run twice. Then fill in the steps, link them with buttons, publish and put online — two separate gestures, both asking for the “Publish” right.

5When something goes wrong

An error always comes back in the same shape: “code” is meant for your program, “detail” for you. Here the token may not publish:

Answer
{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "",
  "scope": "publish"
}

An id the account may not open answers exactly like an id that does not exist: 404 not_found.

What next

API reference — every route, its parameters and its errors.

Connect an assistant — the same access, without writing code.

planner_banner_ad_pt