A valid request URL is required to generate request examples{
"id": "<string>",
"name": "<string>",
"nodes": [
{
"id": "<string>",
"type": "agent",
"position": {
"x": 123,
"y": 123
},
"data": {
"label": "<string>",
"description": "<string>",
"config": {},
"isConfigured": true,
"errors": [
"<string>"
]
}
}
],
"edges": [
{
"id": "<string>",
"source": "<string>",
"target": "<string>",
"sourceHandle": "<string>",
"targetHandle": "<string>",
"data": {
"condition": "<string>",
"label": "<string>"
}
}
],
"version": "<string>",
"status": "published",
"scope": "personal",
"createdBy": "<string>",
"isPublic": true,
"owners": [
{
"id": "<string>",
"type": "group",
"displayName": "<string>",
"mail": "<string>",
"securityEnabled": true,
"mailEnabled": true,
"groupTypes": [
"<string>"
],
"groupType": "<string>",
"userPrincipalName": "<string>",
"jobTitle": "<string>",
"department": "<string>",
"officeLocation": "<string>"
}
],
"contributors": [
{
"id": "<string>",
"type": "group",
"displayName": "<string>",
"mail": "<string>",
"securityEnabled": true,
"mailEnabled": true,
"groupTypes": [
"<string>"
],
"groupType": "<string>",
"userPrincipalName": "<string>",
"jobTitle": "<string>",
"department": "<string>",
"officeLocation": "<string>"
}
],
"users": [
{
"id": "<string>",
"type": "group",
"displayName": "<string>",
"mail": "<string>",
"securityEnabled": true,
"mailEnabled": true,
"groupTypes": [
"<string>"
],
"groupType": "<string>",
"userPrincipalName": "<string>",
"jobTitle": "<string>",
"department": "<string>",
"officeLocation": "<string>"
}
],
"inheritEntitlements": true,
"hideFromCatalog": true,
"createdAt": "<string>",
"updatedBy": "<string>",
"updatedAt": "<string>",
"description": "<string>",
"parentId": "<string>",
"isEnabled": true,
"tags": [
"<string>"
],
"isFeatured": true,
"flowType": "general",
"metadata": {},
"origin": "builtIn",
"executionConfig": {
"timeout": 123,
"retryPolicy": {
"maxRetries": 123,
"retryDelay": 123
},
"errorHandling": "stop",
"maxParallelism": 123,
"maxIterations": 123,
"enableCheckpointing": true,
"checkpointTtlSeconds": 123,
"enableParallelFanOut": true,
"nodeTimeoutMs": 123,
"errorRecovery": {
"allowContinue": true,
"allowRestart": true
}
},
"userId": "<string>",
"_ts": 123
}Update a flow (full replace)
Replaces the flow configuration. Only owners can modify ACL fields.
A valid request URL is required to generate request examples{
"id": "<string>",
"name": "<string>",
"nodes": [
{
"id": "<string>",
"type": "agent",
"position": {
"x": 123,
"y": 123
},
"data": {
"label": "<string>",
"description": "<string>",
"config": {},
"isConfigured": true,
"errors": [
"<string>"
]
}
}
],
"edges": [
{
"id": "<string>",
"source": "<string>",
"target": "<string>",
"sourceHandle": "<string>",
"targetHandle": "<string>",
"data": {
"condition": "<string>",
"label": "<string>"
}
}
],
"version": "<string>",
"status": "published",
"scope": "personal",
"createdBy": "<string>",
"isPublic": true,
"owners": [
{
"id": "<string>",
"type": "group",
"displayName": "<string>",
"mail": "<string>",
"securityEnabled": true,
"mailEnabled": true,
"groupTypes": [
"<string>"
],
"groupType": "<string>",
"userPrincipalName": "<string>",
"jobTitle": "<string>",
"department": "<string>",
"officeLocation": "<string>"
}
],
"contributors": [
{
"id": "<string>",
"type": "group",
"displayName": "<string>",
"mail": "<string>",
"securityEnabled": true,
"mailEnabled": true,
"groupTypes": [
"<string>"
],
"groupType": "<string>",
"userPrincipalName": "<string>",
"jobTitle": "<string>",
"department": "<string>",
"officeLocation": "<string>"
}
],
"users": [
{
"id": "<string>",
"type": "group",
"displayName": "<string>",
"mail": "<string>",
"securityEnabled": true,
"mailEnabled": true,
"groupTypes": [
"<string>"
],
"groupType": "<string>",
"userPrincipalName": "<string>",
"jobTitle": "<string>",
"department": "<string>",
"officeLocation": "<string>"
}
],
"inheritEntitlements": true,
"hideFromCatalog": true,
"createdAt": "<string>",
"updatedBy": "<string>",
"updatedAt": "<string>",
"description": "<string>",
"parentId": "<string>",
"isEnabled": true,
"tags": [
"<string>"
],
"isFeatured": true,
"flowType": "general",
"metadata": {},
"origin": "builtIn",
"executionConfig": {
"timeout": 123,
"retryPolicy": {
"maxRetries": 123,
"retryDelay": 123
},
"errorHandling": "stop",
"maxParallelism": 123,
"maxIterations": 123,
"enableCheckpointing": true,
"checkpointTtlSeconds": 123,
"enableParallelFanOut": true,
"nodeTimeoutMs": 123,
"errorRecovery": {
"allowContinue": true,
"allowRestart": true
}
},
"userId": "<string>",
"_ts": 123
}Authorizations
Azure AD access token obtained via MSAL
Path Parameters
Body
Complete Flow Designer flow definition (graph + execution settings + ACL)
Flow ID (UUID)
Show child attributes
Show child attributes
Show child attributes
Show child attributes
FLOW_STATUS
published, archived Access control model
personal, shared UPN of the creator
Allow public read access
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Hide entity from user-facing recommendations and catalog/search surfaces (still accessible to owners/contributors/admins)
ISO-8601 creation timestamp
ISO-8601 update timestamp
FK to parent flow group (undefined = root)
Whether this flow is enabled (default: true)
FLOW_TYPE — 'general' (default) or 'retriever' (headless, for RAG pipeline)
general, retriever Show child attributes
Show child attributes
builtIn = bootstrapped (not deletable), admin = user-created
builtIn, admin Execution settings
Show child attributes
Show child attributes
Cosmos DB partition key
Cosmos DB last-modified timestamp (epoch seconds)
Response
Flow updated
Complete Flow Designer flow definition (graph + execution settings + ACL)
Flow ID (UUID)
Show child attributes
Show child attributes
Show child attributes
Show child attributes
FLOW_STATUS
published, archived Access control model
personal, shared UPN of the creator
Allow public read access
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Hide entity from user-facing recommendations and catalog/search surfaces (still accessible to owners/contributors/admins)
ISO-8601 creation timestamp
ISO-8601 update timestamp
FK to parent flow group (undefined = root)
Whether this flow is enabled (default: true)
FLOW_TYPE — 'general' (default) or 'retriever' (headless, for RAG pipeline)
general, retriever Show child attributes
Show child attributes
builtIn = bootstrapped (not deletable), admin = user-created
builtIn, admin Execution settings
Show child attributes
Show child attributes
Cosmos DB partition key
Cosmos DB last-modified timestamp (epoch seconds)
Was this page helpful?