Skip to content

List Workflows

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

Every workflow an agent can request, without their params.

A list, and it stays a list — Studio’s own workflows sidebar reads this route, so the shape it returns does not move. Each entry carries what choosing between workflows needs: what it makes, what it needs to run, how long it took here, one thing it produced, and a details link. Follow details for the workflow you chose — that response has its params and every remaining call.

Pass ?view=full to get every workflow’s params in this response instead of fetching them one at a time.

run_time holds measured run times per node from this install’s recent completed jobs, or null if the workflow has never finished here. Times reflect the params those jobs used; longer videos and bigger sizes take longer.

example is one output this install made with that workflow — the file tagged showcase, or else the newest one — so a catalog can show what a workflow makes rather than describe it. Null until the workflow has produced something here.

source is shipped for the workflows FlixML ships and documents, or local for one the operator dropped into workflows/local/ on their own install. Nothing in the docs or on flixml.com describes a local workflow: read its params rather than assuming it behaves like the shipped one whose name it resembles.

view
Any of:
string

Successful Response

Media typeapplication/json
Response List Workflows Api Workflows Get
Array<object>
object
key
additional properties
any
Examplegenerated
[
{}
]

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"
}
]
}