{
  "opencollection": "1.0.0",
  "info": {
    "name": "Prefect Cloud Account Billing Flow Runs API",
    "version": "0.8.4"
  },
  "items": [
    {
      "info": {
        "name": "Flow Runs",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create Flow Run",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a flow run. If a flow run with the same flow_id and\nidempotency key already exists, the existing flow run will be returned.\n\nIf no state is provided, the flow run will be created in a PENDING state.\n\nRequired workspace scopes: `run_flows`"
        },
        {
          "info": {
            "name": "Read Flow Runs",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/filter",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Query for flow runs.\n\nRequired workspace scopes: `see_flows`"
        },
        {
          "info": {
            "name": "Read Flow Runs Minimal",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/filter-minimal",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "A flow runs filter that excludes full state data -- and possibly other\ndata in the future -- for improved performance.\n\nNote that the state name, state type, and state ID are all still available.\n\nRequired workspace scopes: `see_flows`"
        },
        {
          "info": {
            "name": "Read Flow Run",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/:id",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The flow run id"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get a flow run by id.\n\nRequired workspace scopes: `see_flows`"
        },
        {
          "info": {
            "name": "Update Flow Run",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/:id",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The flow run id"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a flow run.\n\nRequired workspace scopes: `run_flows`"
        },
        {
          "info": {
            "name": "Delete Flow Run",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/:id",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The flow run id"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Delete a flow run by id.\n\nRequired workspace scopes: `manage_flows`"
        },
        {
          "info": {
            "name": "Count Flow Runs",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/count",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Query for flow runs.\n\nRequired workspace scopes: `see_flows`"
        },
        {
          "info": {
            "name": "Average Flow Run Lateness",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/lateness",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Query for average flow-run lateness in seconds.\n\nRequired workspace scopes: `see_flows`"
        },
        {
          "info": {
            "name": "Flow Run History",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/history",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Query for flow run history data across a given range and interval.\n\nRequired workspace scopes: `see_flows`"
        },
        {
          "info": {
            "name": "Read Flow Run Graph V1",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/:id/graph",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The flow run id"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get a task run dependency map for a given flow run.\n\nRequired workspace scopes: `see_flows`"
        },
        {
          "info": {
            "name": "Read Flow Run Graph V2",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/:id/graph-v2",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The flow run id"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "since",
                "value": "",
                "type": "query",
                "description": "Only include runs that start or end after this time."
              }
            ]
          },
          "docs": "Get a graph of the tasks and subflow runs for the given flow run\n\nRequired workspace scopes: `see_flows`"
        },
        {
          "info": {
            "name": "Get Flow Run Artifacts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/:id/artifacts",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The flow run id"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "depth",
                "value": "",
                "type": "query",
                "description": "Optional depth limit for recursion (0 = flow run only)"
              },
              {
                "name": "since",
                "value": "",
                "type": "query",
                "description": "Only return artifacts created on or after this timestamp"
              },
              {
                "name": "until",
                "value": "",
                "type": "query",
                "description": "Only return artifacts created on or before this timestamp"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Sort order by creation time (asc or desc)"
              }
            ]
          },
          "docs": "Get all artifacts created within a flow run, including artifacts from\ntask runs and subflow runs (recursively).\n\nRequired workspace scopes: `see_flows`"
        },
        {
          "info": {
            "name": "Resume Flow Run",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/:id/resume",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The flow run id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Resume a paused flow run.\n\nRequired workspace scopes: `run_flows`"
        },
        {
          "info": {
            "name": "Bulk Delete Flow Runs",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/bulk_delete",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Bulk delete flow runs using a filter.\n\nThis endpoint soft-deletes flow runs matching the provided filter criteria.\nFor small numbers of flow runs (5 or fewer), cleanup is performed synchronously.\nFor larger batches, cleanup is queued as a background job.\n\nRequired workspace scopes: `manage_flows`"
        },
        {
          "info": {
            "name": "Bulk Set Flow Run State",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/bulk_set_state",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Bulk set state on flow runs matching a filter.\n\nThis endpoint attempts to set the specified state on all flow runs\nmatching the filter criteria. Each flow run is processed through\norchestration rules (unless force=True), so individual transitions\nmay be accepted, rejected, aborted, or waited.\n\nThe response body contains detailed per-run results indicating\nthe outcome for each flow run.\n\nRequired workspace scopes: `run_flows`"
        },
        {
          "info": {
            "name": "Set Flow Run State",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/:id/set_state",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The flow run id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Set a flow run state, invoking any orchestration rules.\n\nRequired workspace scopes: `run_flows`"
        },
        {
          "info": {
            "name": "Create Flow Run Input",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/:id/input",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The flow run id"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a key/value input for a flow run.\n\nRequired workspace scopes: `run_flows`"
        },
        {
          "info": {
            "name": "Filter Flow Run Input",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/:id/input/filter",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The flow run id"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Filter flow run inputs by key prefix\n\nRequired workspace scopes: `see_flows`"
        },
        {
          "info": {
            "name": "Read Flow Run Input",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/:id/input/:key",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The flow run id"
              },
              {
                "name": "key",
                "value": "",
                "type": "path",
                "description": "The input key"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Create a value from a flow run input\n\nRequired workspace scopes: `see_flows`"
        },
        {
          "info": {
            "name": "Delete Flow Run Input",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/:id/input/:key",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The flow run id"
              },
              {
                "name": "key",
                "value": "",
                "type": "path",
                "description": "The input key"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Delete a flow run input\n\nRequired workspace scopes: `manage_flows`"
        },
        {
          "info": {
            "name": "Paginate Flow Runs",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/paginate",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Pagination query for flow runs.\n\nRequired workspace scopes: `see_flows`"
        },
        {
          "info": {
            "name": "Update Flow Run Labels",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/:id/labels",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The flow run id"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\nRequired workspace scopes: `run_flows`"
        },
        {
          "info": {
            "name": "Get Flow Run Materializations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/:id/assets/materializations",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The flow run id"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "depth",
                "value": "",
                "type": "query",
                "description": "Optional depth limit based on execution hierarchy. depth=0: only the root flow run. depth=1: root + direct children (tasks and subflows). None: unlimited depth (default)."
              },
              {
                "name": "since",
                "value": "",
                "type": "query",
                "description": "Only return materializations on or after this timestamp"
              },
              {
                "name": "until",
                "value": "",
                "type": "query",
                "description": "Only return materializations on or before this timestamp"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Sort order by occurred time (asc or desc)"
              }
            ]
          },
          "docs": "Get all asset materializations within a flow run, including materializations\nfrom descendant task runs and subflow runs.\n\nReturns a historical snapshot of materializations as they occurred, with asset\nproperties captured at materialization time (not current state).\n\nRequired workspace scopes: `see_assets`"
        },
        {
          "info": {
            "name": "Get Flow Run References",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/flow_runs/:id/assets/references",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The flow run id"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "depth",
                "value": "",
                "type": "query",
                "description": "Optional depth limit based on execution hierarchy. depth=0: only the root flow run. depth=1: root + direct children (tasks and subflows). None: unlimited depth (default)."
              },
              {
                "name": "since",
                "value": "",
                "type": "query",
                "description": "Only return references on or after this timestamp"
              },
              {
                "name": "until",
                "value": "",
                "type": "query",
                "description": "Only return references on or before this timestamp"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Sort order by occurred time (asc or desc)"
              }
            ]
          },
          "docs": "Get all asset references within a flow run, including references from\ndescendant task runs and subflow runs.\n\nReturns a historical snapshot of asset references as they occurred, with asset\nproperties captured at reference time (not current state).\n\nRequired workspace scopes: `see_assets`"
        },
        {
          "info": {
            "name": "Read Flow Run History",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/ui/flow_runs/history",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\nRequired workspace scopes: `see_flows`"
        },
        {
          "info": {
            "name": "Read Flow Run History V2",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/ui/flow_runs/history-v2",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\nRequired workspace scopes: `see_flows`"
        },
        {
          "info": {
            "name": "Count Task Runs By Flow Run",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/accounts/:account_id/workspaces/:workspace_id/ui/flow_runs/count-task-runs",
            "headers": [
              {
                "name": "x-prefect-api-version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Get task run counts by flow run id.\n\nRequired workspace scopes: `see_flows`"
        }
      ]
    }
  ],
  "bundled": true
}