Get Flow

GET

/api/v1/ai-agents/{id}/flow

Returns the agent's draft (default) or live flow. The response is shaped so you can edit it and send it back to Update Flow: keep the node ids and send toolIds. tools and providerTools are for reading only.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Query Params

Responses

🟢200Success

application/json

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠429Too Many Requests

🔴502Bad Gateway

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://apigw.klinkcx.com/api/v1/ai-agents/6ad97ee52845b4f2c8daca55/flow?version=draft' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "requestId": "string",
    "data": {
        "id": "string",
        "status": "draft",
        "version": "string",
        "model": "string",
        "savedAt": "string",
        "nodes": [
            {
                "id": "string",
                "type": "startingPoint",
                "label": "string",
                "position": {
                    "x": 0,
                    "y": 0
                },
                "instruction": "string",
                "toolIds": [
                    "string"
                ],
                "tools": [
                    {
                        "id": "string",
                        "name": "string",
                        "description": "string"
                    }
                ],
                "providerTools": [
                    {
                        "id": "string",
                        "name": "string"
                    }
                ],
                "knowledgeSourceIds": [
                    "string"
                ],
                "vectorStoreIds": [
                    "string"
                ],
                "correction": true,
                "correctionGroupIds": [
                    "string"
                ],
                "waitSeconds": 0
            }
        ],
        "edges": [
            {
                "id": "string",
                "source": "string",
                "target": "string",
                "sourceHandle": "string",
                "targetHandle": "string"
            }
        ]
    }
}

Modified at 2026-10-23 02:08:30

Delete

List Versions