Get a data flow and its operation references – GET /v1/data-flows/{dataFlowId}

GET/v1/data-flows/{dataFlowId}

betaapiKeyworkspace

When to use

Read a flow’s operation references, edges, and revision.

For agents

Fetch operations and their code separately as needed. Use the numeric flow revision for the next graph command.

Example

typescript

import { PermuteClient } from '@permute/sdk';

const orgClient = new PermuteClient({
  apiKey: process.env.PERMUTE_API_KEY!,
});

const client = orgClient.withWorkspace(process.env.PERMUTE_WORKSPACE_ID!);

const result = await client.dataFlows.get('oper_flow123');

Response

json

{
  "data": {
    "operation": {
      "id": "oper_flow123",
      "name": "Revenue flow",
      "kind": "dataFlow",
      "instructions": "Sum revenue by customer.",
      "dataSourceIds": [
        "data_abc123"
      ],
      "parentDataFlowId": null,
      "status": "draft",
      "codeStale": false,
      "draft": null,
      "published": null
    },
    "revision": 2,
    "draftVersion": 2,
    "publishedVersion": null,
    "operationIds": [
      "oper_revenue123"
    ],
    "sourceIds": [
      "data_abc123"
    ],
    "edges": [
      {
        "id": "data_abc123->oper_revenue123",
        "fromNodeId": "data_abc123",
        "toNodeId": "oper_revenue123"
      }
    ]
  }
}