Get a flow execution - QX Labs Docs

GET

flows

{flow_id}

executions

{execution_id}

cURL

curl https://api.qxlabs.com/v1/flows/c71a5f0e1d2b4a7e9a513f6f0d2b8e10/executions/9b2e4d713a5c4f8bb6e21c7d9a0f3e58 \
  -H "Authorization: Bearer <YOUR_QX_API_KEY>"

import time

import requests

headers = {"Authorization": "Bearer <YOUR_QX_API_KEY>"}
url = "https://api.qxlabs.com/v1/flows/c71a5f0e1d2b4a7e9a513f6f0d2b8e10/executions/9b2e4d713a5c4f8bb6e21c7d9a0f3e58"

# Poll until the execution has finished
while True:
    execution = requests.get(url, headers=headers).json()
    if execution["status"] in ("completed", "error", "cancelled"):
        break
    time.sleep(3)
for node in execution["nodes"]:
    print(node["label"] or node["type"], node["status"], node["output"])

const headers = { Authorization: "Bearer <YOUR_QX_API_KEY>" };
const url = "https://api.qxlabs.com/v1/flows/c71a5f0e1d2b4a7e9a513f6f0d2b8e10/executions/9b2e4d713a5c4f8bb6e21c7d9a0f3e58";

// Poll until the execution has finished
let execution;
while (true) {
  execution = await (await fetch(url, { headers })).json();
  if (["completed", "error", "cancelled"].includes(execution.status)) break;
  await new Promise((resolve) => setTimeout(resolve, 3000));
}
for (const node of execution.nodes) {
  console.log(node.label ?? node.type, node.status, node.output);
}

{
  "execution_id": "9b2e4d713a5c4f8bb6e21c7d9a0f3e58",
  "flow_id": "c71a5f0e1d2b4a7e9a513f6f0d2b8e10",
  "status": "processing",
  "progress": {
    "finished_nodes": 1,
    "total_nodes": 3
  },
  "credits_consumed": 0,
  "nodes": [
    {
      "node_id": "UserInputNodex7q2m9ka4",
      "type": "UserInputNode",
      "label": "Company details",
      "status": "completed",
      "output": {
        "company_name": "Acme",
        "size": "51-500"
      },
      "credits_consumed": 0,
      "error": null
    },
    {
      "node_id": "LLMNodek3x9m2pqa1",
      "type": "LLMNode",
      "label": "Write summary",
      "status": "processing",
      "output": {},
      "credits_consumed": 0,
      "error": null
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "Read rate limit exceeded for flows endpoints"
}

Authorizations

Authorization

string

header

required

Your QX API key. The X-API-Key header works too

Path Parameters

flow_id

string

required

The flow's ID

execution_id

string

required

The execution's ID, from the execute endpoint or the app

Response

The execution

execution_id

string

flow_id

string

status

enum<string>

Available options:

initializing,

processing,

completed,

error,

paused,

cancelled

progress

object

finished_nodes counts completed nodes. Nodes on a branch that wasn't taken never execute, so finished_nodes can stay below total_nodes when the execution completes.

Show child attributes

credits_consumed

integer

Credits the execution has used so far

nodes

object[]

One entry per node that has started, in execution order. The Output node's output holds the flow's final values. A batch node's outputs are lists with one entry per item, and the list can grow while the node is processing. Export nodes output a file key, not the file.

Show child attributes

cURL

curl https://api.qxlabs.com/v1/flows/c71a5f0e1d2b4a7e9a513f6f0d2b8e10/executions/9b2e4d713a5c4f8bb6e21c7d9a0f3e58 \
  -H "Authorization: Bearer <YOUR_QX_API_KEY>"

import time

import requests

headers = {"Authorization": "Bearer <YOUR_QX_API_KEY>"}
url = "https://api.qxlabs.com/v1/flows/c71a5f0e1d2b4a7e9a513f6f0d2b8e10/executions/9b2e4d713a5c4f8bb6e21c7d9a0f3e58"

# Poll until the execution has finished
while True:
    execution = requests.get(url, headers=headers).json()
    if execution["status"] in ("completed", "error", "cancelled"):
        break
    time.sleep(3)
for node in execution["nodes"]:
    print(node["label"] or node["type"], node["status"], node["output"])

const headers = { Authorization: "Bearer <YOUR_QX_API_KEY>" };
const url = "https://api.qxlabs.com/v1/flows/c71a5f0e1d2b4a7e9a513f6f0d2b8e10/executions/9b2e4d713a5c4f8bb6e21c7d9a0f3e58";

// Poll until the execution has finished
let execution;
while (true) {
  execution = await (await fetch(url, { headers })).json();
  if (["completed", "error", "cancelled"].includes(execution.status)) break;
  await new Promise((resolve) => setTimeout(resolve, 3000));
}
for (const node of execution.nodes) {
  console.log(node.label ?? node.type, node.status, node.output);
}

{
  "execution_id": "9b2e4d713a5c4f8bb6e21c7d9a0f3e58",
  "flow_id": "c71a5f0e1d2b4a7e9a513f6f0d2b8e10",
  "status": "processing",
  "progress": {
    "finished_nodes": 1,
    "total_nodes": 3
  },
  "credits_consumed": 0,
  "nodes": [
    {
      "node_id": "UserInputNodex7q2m9ka4",
      "type": "UserInputNode",
      "label": "Company details",
      "status": "completed",
      "output": {
        "company_name": "Acme",
        "size": "51-500"
      },
      "credits_consumed": 0,
      "error": null
    },
    {
      "node_id": "LLMNodek3x9m2pqa1",
      "type": "LLMNode",
      "label": "Write summary",
      "status": "processing",
      "output": {},
      "credits_consumed": 0,
      "error": null
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "Read rate limit exceeded for flows endpoints"
}