flows

Create a flow

Creates a flow and, optionally, its whole task graph in one call. A task's after references other tasks by index in this request, so the dependency chain arrives with the flow rather than in follow-up calls. Cycles are refused outright.

post/v1/flows

Request

  • Base URL: https://api.flowral.app
  • URL: https://api.flowral.app/v1/flows
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (client credentials, token URL https://api.flowral.app/v1/oauth/token, scopes: flows:write)

Request body

namestring required
descriptionstring
dueDatestring

ISO 8601. Used by the schedule and report endpoints to answer "is this on track".

tasksobject[]

Tasks to create, in order. Each: { name, description?, estimateHours?, assigneeId?, after?: [index] }, where after holds indexes into this same array.

Response

CREATED

idstring required
namestring required
descriptionstring nullable
archivedboolean required
publicboolean

Whether this flow is published — readable by anyone with its link, with no account. Assignees, comments and files are never included in the public view.

publicUrlstring nullable

The published link, or null when the flow is private.

dueDatestring date-time

The date the flow is meant to land, if one is set.

taskCountinteger
doneCountinteger
readyCountinteger

Tasks that can be started right now.

createdAtstring date-time
updatedAtstring date-time

Example response

{
  "id": "flw_2b8e10",
  "publicUrl": "https://platform.flowral.app/public/flow/flw_2b8e10",
  "tasks": [
    {
      "id": "tsk_9f2c41"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.