Sign in

v1

latestOpenAPI 3.0.32026-07-24707482.9 KB
Flow Sessions

Create a new Flow App session

Starts a new session for the specified Flow App. Optionally target a specific app version and/or a declared start step (multi-start-step apps).

post/flow/sessions

Request body

appIdstring required

ID of the Flow App to instantiate

versionstring

Semver version. Defaults to latest active version.

launchContextobject

Arbitrary context passed to the app's start step render

startStepIdstring

Entry point step ID. Must be a declared start step when the app declares any. Defaults to the app's first declared start step.

Response

Session created

sessionIdstring required
appIdstring required
appVersionstring required
status'active' | 'complete' | 'expired' required
stateVersioninteger required
completeboolean required

Example response

{
  "stepSpec": {
    "payment": {
      "currency": "USDC",
      "chain": "base",
      "recipient": "0xAbCd1234AbCd1234AbCd1234AbCd1234AbCd1234",
      "tokenAddress": "0xAbCd1234AbCd1234AbCd1234AbCd1234AbCd1234"
    }
  }
}