Agent Flows

Manage conversational flows for agents. Use these APIs to create, update, retrieve, publish, list, and run draft flows. Ideal for designing, testing, and deploying multi-step agent behaviors.

Create Or Update Draft Flow Tool

post

路径参数

tool_idstring · uuid必填

Tool id

查询参数

tenant_idany of可选

Tenant Id

Example: 40d39c4b-9585-4123-8fd4-f1cc23a1184c

string可选

或

null可选

tenant_unit_idany of可选

Tenant Unit ID

Example: da114de3-d7e6-4161-bc55-0ce85dbee589

string可选

或

null可选

请求体

application/json

created_byany of可选

string可选

或

null可选

updated_byany of可选

string可选

或

null可选

created_by_roleany of可选

string可选

或

null可选

updated_by_roleany of可选

string可选

或

null可选

created_timeany of可选

string · date-time可选

或

null可选

updated_timeany of可选

string · date-time可选

或

null可选

owner_idany of可选

The ID of the flow this definition belongs to

Example: uuid-of-flow

string可选

或

null可选

owner_typeany of可选

Type of flow [flow, tool]

Example: flow

object可选

或

null可选

modeany of可选

Flow mode, e.g., chat or job

Example: job

string可选

或

null可选

versionany of可选

Version of the flow

Example: draft

string可选

或

null可选

graphobject · Graph可选

Flow graph

Default: {}Example: {}

featuresany of可选

Additional features for the flow

Example: {}

object可选

或

null可选

flow_variablesany of可选

Environment variables for the flow

Example: {}

object可选

或

null可选

conversation_variablesany of可选

Conversation variables for the flow

Example: {}

或

null可选

响应

201

Successful Response

application/json

422

Validation Error

application/json

post

/admin/api/v2/tools/{tool_id}/flows

HTTPcURLJavaScriptPython

POST /admin/api/v2/tools/{tool_id}/flows HTTP/1.1
Host: api.workfx.ai
Content-Type: application/json
Accept: */*
Content-Length: 12

{
  "graph": {}
}

{
  "created_by": "user123",
  "updated_by": "user124",
  "created_by_role": "text",
  "updated_by_role": "text",
  "created_time": "2026-03-18T05:42:39.846Z",
  "updated_time": "2026-03-18T05:42:39.846Z",
  "owner_id": "uuid-of-flow",
  "owner_type": "flow",
  "mode": "job",
  "version": "draft",
  "graph": {},
  "features": {},
  "flow_variables": {},
  "conversation_variables": {},
  "id": "uuid-of-definition",
  "tenant_id": "uuid-of-tenant",
  "tenant_unit_id": "tenant-unit-id"
}

Get Draft

get

Get the DRAFT version of a flow

路径参数

agent_idstring · uuid必填

查询参数

tenant_idany of可选

Tenant Id

Example: 40d39c4b-9585-4123-8fd4-f1cc23a1184c

string可选

或

null可选

tenant_unit_idany of可选

Tenant Unit ID

Example: da114de3-d7e6-4161-bc55-0ce85dbee589

string可选

或

null可选

响应

200

Successful Response

application/json

Full flow model with additional fields used for responses.

created_bystring必填

ID of the creator

Example: user123

updated_byany of可选

ID of the last updater

Example: user124

string可选

或

null可选

created_by_roleany of可选

string可选

或

null可选

updated_by_roleany of可选

string可选

或

null可选

created_timestring · date-time可选

Timestamp of creation

updated_timestring · date-time可选

Timestamp of last update

owner_idany of可选

The ID of the flow this definition belongs to

Example: uuid-of-flow

string可选

或

null可选

owner_typeany of可选

Type of flow [flow, tool]

Example: flow

string · enum可选可能的值:

或

null可选

modeany of可选

Flow mode, e.g., chat or job

Example: job

string可选

或

null可选

versionany of可选

Version of the flow

Example: draft

string可选

或

null可选

graphany of可选

Flow graph

Example: {}

object可选

或

null可选

featuresany of可选

Additional features for the flow

Example: {}

object可选

或

null可选

flow_variablesany of可选

Environment variables for the flow

Example: {}

object可选

或

null可选

conversation_variablesany of可选

Conversation variables for the flow

Example: {}

或

null可选

idstring必填

The ID of the created FlowDefinitionDO

Example: uuid-of-definition

tenant_idstring必填

Tenant ID

Example: uuid-of-tenant

tenant_unit_idstring必填

Tenant Unit ID

Example: tenant-unit-id

422

Validation Error

application/json

get

/admin/api/v2/agents/{agent_id}/flows/draft

HTTPcURLJavaScriptPython

GET /admin/api/v2/agents/{agent_id}/flows/draft HTTP/1.1
Host: api.workfx.ai
Accept: */*

{
  "created_by": "user123",
  "updated_by": "user124",
  "created_by_role": "text",
  "updated_by_role": "text",
  "created_time": "2026-03-18T05:42:39.846Z",
  "updated_time": "2026-03-18T05:42:39.846Z",
  "owner_id": "uuid-of-flow",
  "owner_type": "flow",
  "mode": "job",
  "version": "draft",
  "graph": {},
  "features": {},
  "flow_variables": {},
  "conversation_variables": {},
  "id": "uuid-of-definition",
  "tenant_id": "uuid-of-tenant",
  "tenant_unit_id": "tenant-unit-id"
}

Publish

post

Publish the current DRAFT version as a formal version

路径参数

agent_idstring · uuid必填

查询参数

tenant_idany of可选

Tenant Id

Example: 40d39c4b-9585-4123-8fd4-f1cc23a1184c

string可选

或

null可选

tenant_unit_idany of可选

Tenant Unit ID

Example: da114de3-d7e6-4161-bc55-0ce85dbee589

string可选

或

null可选

响应

200

Successful Response

application/json

Response model for the created FlowDefinitionDO.

created_bystring必填

ID of the creator

Example: user123

updated_byany of可选

ID of the last updater

Example: user124

string可选

或

null可选

created_by_roleany of可选

string可选

或

null可选

updated_by_roleany of可选

string可选

或

null可选

created_timestring · date-time可选

Timestamp of creation

updated_timestring · date-time可选

Timestamp of last update

owner_idany of可选

The ID of the flow this definition belongs to

Example: uuid-of-flow

string可选

或

null可选

owner_typeany of可选

Type of flow [flow, tool]

Example: flow

string · enum可选可能的值:

或

null可选

modeany of可选

Flow mode, e.g., chat or job

Example: job

string可选

或

null可选

versionany of可选

Version of the flow

Example: draft

string可选

或

null可选

graphany of可选

Flow graph

Example: {}

object可选

或

null可选

featuresany of可选

Additional features for the flow

Example: {}

object可选

或

null可选

flow_variablesany of可选

Environment variables for the flow

Example: {}

object可选

或

null可选

conversation_variablesany of可选

Conversation variables for the flow

Example: {}

或

null可选

idstring必填

The ID of the created FlowDefinitionDO

Example: uuid-of-definition

tenant_idstring必填

Tenant ID

Example: uuid-of-tenant

tenant_unit_idstring必填

Tenant Unit ID

Example: tenant-unit-id

422

Validation Error

application/json

post

/admin/api/v2/agents/{agent_id}/flows/publish

HTTPcURLJavaScriptPython

POST /admin/api/v2/agents/{agent_id}/flows/publish HTTP/1.1
Host: api.workfx.ai
Accept: */*

{
  "created_by": "user123",
  "updated_by": "user124",
  "created_by_role": "text",
  "updated_by_role": "text",
  "created_time": "2026-03-18T05:42:39.846Z",
  "updated_time": "2026-03-18T05:42:39.846Z",
  "owner_id": "uuid-of-flow",
  "owner_type": "flow",
  "mode": "job",
  "version": "draft",
  "graph": {},
  "features": {},
  "flow_variables": {},
  "conversation_variables": {},
  "id": "uuid-of-definition",
  "tenant_id": "uuid-of-tenant",
  "tenant_unit_id": "tenant-unit-id"
}

List Versions

get

Get a list of all versions for a specific flow

路径参数

agent_idstring · uuid必填

Agent id

查询参数

page_numinteger可选

Current page number

Default: 1

page_sizeinteger可选

Items per page

Default: 20

tenant_idany of可选

Tenant Id

Example: 40d39c4b-9585-4123-8fd4-f1cc23a1184c

string可选

或

null可选

tenant_unit_idany of可选

Tenant Unit ID

Example: da114de3-d7e6-4161-bc55-0ce85dbee589

string可选

或

null可选

响应

200

Successful Response

application/json

Response model for the created flowDefinition.

page_numinteger必填

Current page number

page_sizeinteger必填

Number of items per page

total_countinteger必填

Total number of flows

has_next_pageboolean必填

Whether there is a next page

dataobject[]必填

List of flow_definitions

422

Validation Error

application/json

get

/admin/api/v2/agents/{agent_id}/flows

HTTPcURLJavaScriptPython

GET /admin/api/v2/agents/{agent_id}/flows HTTP/1.1
Host: api.workfx.ai
Accept: */*

{
  "page_num": 1,
  "page_size": 1,
  "total_count": 1,
  "has_next_page": true,
  "data": [
    {}
  ]
}

Run Draft Workflow

post

Run the draft version of the workflow

路径参数

agent_idstring · uuid必填Example: 22a976a1-4f6d-4357-a167-26684daa60c5

查询参数

tenant_idany of可选

Tenant Id

Example: 40d39c4b-9585-4123-8fd4-f1cc23a1184c

string可选

或

null可选

tenant_unit_idany of可选

Tenant Unit ID

Example: da114de3-d7e6-4161-bc55-0ce85dbee589

string可选

或

null可选

请求体

application/json

或

响应

200

Successful Response

application/json

string可选

422

Validation Error

application/json

post

/admin/api/v2/agents/{agent_id}/flows/draft/runs

HTTPcURLJavaScriptPython

POST /admin/api/v2/agents/{agent_id}/flows/draft/runs HTTP/1.1
Host: api.workfx.ai
Content-Type: application/json
Accept: */*
Content-Length: 142

{
  "query": "",
  "inputs": {
    "var1": "1",
    "var2": 2
  },
  "streaming": false,
  "files": [
    "text"
  ],
  "response_type": "wfx",
  "wfx_context": {},
  "conversation_id": "text"
}

text