Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-08-062711471.0 MB
Flows

Get flow details

Returns flow metadata. Pass includeNodes=true to include graph nodes.

get/public/v1/agents/{agentId}/flows/{flowId}

Path parameters

agentIdstring required
Example:uuid-xxxx-xxxx
flowIdnumber nullable
Example:101

Query parameters

boolean
OR
string
Example:example
boolean
OR
string
Example:example

Response

Flow details

idnumber required
namestring required
descriptionstring nullable required
status'ACTIVE' | 'SUSPENDED' | 'DELETED' | 'DRAFT' required
createdAtstring required
updatedAtstring required
runCountnumber required
assistantIdstring required
isDefaultboolean required
liveSnapshotIdstring nullable required
draftSnapshotIdstring nullable required

Example response

{
  "id": 101,
  "name": "Order Retrieval",
  "description": "Extracts order info from DB",
  "status": "ACTIVE",
  "createdAt": "2024-01-01T12:00:00Z",
  "updatedAt": "2024-01-01T12:00:00Z",
  "runCount": 450,
  "assistantId": "550e8400-e29b-41d4-a716-446655440000",
  "liveSnapshotId": "64f1c2e6a75f2d4a9a2f1234",
  "draftSnapshotId": "64f1c2e6a75f2d4a9a2f1234",
  "nodes": [
    {
      "nodeId": "node_550e8400-e29b-41d4-a716-446655440000",
      "alias": "Start",
      "name": "Start",
      "position": {
        "positionX": 1,
        "positionY": 1
      },
      "type": "START",
      "data": {
        "type": "TRIGGER_INTENT",
        "agenticRouting": "example",
        "intentIds": [
          1
        ],
        "intents": [
          {
            "id": 1,
            "name": "example",
            "description": "example",
            "createdAt": "example",
            "updatedAt": "example",
            "status": "ACTIVE",
            "assistantId": "example",
            "phrases": [
              {
                "id": 1,
                "phrase": "example"
              }
            ],
            "flowId": 1
          }
        ]
      },
      "workflowId": "example",
      "handles": [
        {
          "handleId": "example",
          "sourceEdge": {
            "from": "example",
            "fromHandleId": "example",
            "to": "example",
            "toHandleId": "example"
          },
          "text": "example"
        }
      ],
      "targetEdges": [
        {
          "from": "example",
          "fromHandleId": "example",
          "to": "example",
          "toHandleId": "example"
        }
      ],
      "createdAt": "example",
      "updatedAt": "example"
    }
  ]
}