Skip to main content
GET
/
flows
/
runs
/
{flow_run_uid}
Get flow run by UUID
curl --request GET \
  --url https://api.edges.run/v1/flows/runs/{flow_run_uid} \
  --header 'X-API-Key: <api-key>'
{
  "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspace_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "last_error": {
    "label": "<string>",
    "message": "<string>"
  },
  "callback": {
    "url": "<string>"
  },
  "status": "CREATED",
  "output_count": 0,
  "scheduled_flow_run_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workflow": {
    "uid": "<string>",
    "metadata": {
      "account_rotation": true
    },
    "steps": [
      {
        "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "status": "CREATED",
        "started_at": "<string>",
        "finished_at": "<string>",
        "error": {
          "label": "<string>",
          "message": "<string>"
        }
      }
    ]
  },
  "started_at": "<string>",
  "finished_at": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://flows-docs.edges.run/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve detailed information about a specific flow run using its unique identifier (UID). This endpoint provides complete status information, timing details, error messages, and workflow metadata for a single flow run. Use Cases:
  • Check the current status of a flow run you started
  • Monitor progress of long-running flows
  • Retrieve error details when a flow fails
  • Get timing information (started_at, finished_at) for performance analysis
We recommend using callbacks instead of polling this endpoint. Callbacks are highly available, have higher success rates, and are rate-limited for reliability. Polling is not super efficient and can be rate-limited.When you create a flow run, configure a callback URL to receive results automatically. You can monitor callback delivery using the List Callbacks endpoint if you need additional monitoring.

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
flow_run_uid
string<uuid>
required

Flow Run UUID

Query Parameters

​
with_run_step_status
boolean
default:false

Whether to include the run step status in the response

Response

Returns the flow run

Returns the flow run

​
uid
string<uuid>

Flow Run UUID

​
user_uid
string<uuid>

Member/User UUID

​
workspace_uid
string<uuid>

Workspace UUID

​
last_error
object

Last error message

​
callback
object

Callback

​
status
enum<string> | null

Flow Run status

Available options:
CREATED,
INVALID,
QUEUED,
SCHEDULED,
BLOCKED,
STOPPED,
RUNNING,
FAILED,
PARTIAL_SUCCEEDED,
SUCCEEDED
​
output_count
integer | null
default:0

Number of outputs generated by the flow run (only available when the flow run is finished)

​
scheduled_flow_run_uid
string<uuid> | null

If the flow run is scheduled, this field indicates the scheduled flow run UUID.

​
workflow
object

Workflow schema

​
started_at
string | null

Started at

​
finished_at
string | null

Finished at

​
created_at
string

Created at

​
updated_at
string | null

Updated at