Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

Azure AD access token obtained via MSAL

Body

application/json
id
string
required
type
enum<string>

Set to 'group' to create a flow group

Available options:
group
name
string
title
string

Required for flow groups

scope
enum<string>
Available options:
personal,
shared

Response

Flow or flow group created

Complete Flow Designer flow definition (graph + execution settings + ACL)

id
string
required

Flow ID (UUID)

name
string
required
nodes
FlowNode · object[]
required
edges
FlowEdge · object[]
required
version
string
required
status
enum<string>
required

FLOW_STATUS

Available options:
published,
archived
scope
enum<string>

Access control model

Available options:
personal,
shared
createdBy
string

UPN of the creator

isPublic
boolean

Allow public read access

owners
object[]
contributors
object[]
users
object[]
inheritEntitlements
hideFromCatalog
boolean

Hide entity from user-facing recommendations and catalog/search surfaces (still accessible to owners/contributors/admins)

createdAt
string

ISO-8601 creation timestamp

updatedBy
string
updatedAt
string

ISO-8601 update timestamp

description
string
parentId
string

FK to parent flow group (undefined = root)

isEnabled
boolean

Whether this flow is enabled (default: true)

tags
string[]
flowType
enum<string>

FLOW_TYPE — 'general' (default) or 'retriever' (headless, for RAG pipeline)

Available options:
general,
retriever
metadata
object
origin
enum<string>

builtIn = bootstrapped (not deletable), admin = user-created

Available options:
builtIn,
admin
executionConfig
object

Execution settings

userId
string

Cosmos DB partition key

_ts
integer

Cosmos DB last-modified timestamp (epoch seconds)