Skip to content
FlixMLFlixML Docs

Get Workflow

GET
/api/workflows/{workflow_id}
curl --request GET \
  --url https://example.com/api/workflows/example \
  --header 'Authorization: Bearer <token>'

One workflow’s complete record — every param, and the rest of the route.

This is what to read once GET /api/workflows has told you which workflow you want. params gives each input’s type, whether it is required, its default, and what the value does; requirements.notes carries what this workflow measured on real hardware. Both are long because driving a workflow well needs them.

next names every call left between here and a finished job — where to check the nodes, list checkpoints, upload a source image, submit, and poll. Nothing in the Studio UI reads this route, so it can say as much as an agent needs.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workflow_id
required
Workflow Id
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response Get Workflow Api Workflows Workflow Id Get
object
key
additional properties
any
Examplegenerated
{}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}