Skip to content

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, with every param.

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.

workflow_id
required
Workflow Id
string

Successful Response

Media typeapplication/json
Response Get Workflow Api Workflows Workflow Id Get
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"
}
]
}