Skip to main content
GET
Get workflow details by slug or slug@version (runtime)

Authorizations

Authorization
string
header
required

User session JWT (Bearer ). Must be paired with the X-Team-ID request header on team-scoped endpoints so the server knows which team's resources to operate on.

Headers

X-Team-ID
string<uuid>

UUID of the team to scope the request to. Used by dual-auth endpoints (runtime + scoped management):

  • JWT callers MUST send it — a user may belong to multiple teams and the runtime cannot otherwise know which one to operate on. Missing header → 400.
  • Credential callers (sk-, dk-) can omit it because the team is derived from the credential row itself. Any value sent is ignored.
Example:

"019abc12-4567-7890-abcd-ef1234567891"

Path Parameters

workflowSlug
string
required

Workflow slug for runtime lookup. Use slug for the latest version or slug@version to reference an immutable workflow snapshot, e.g. text-to-image@2.

Maximum string length: 128
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*(?:@[1-9][0-9]*)?$
Example:

"text-to-image@2"

Response

Workflow details

Full workflow template details including the workflow JSON and parameter definitions. Note: workflow_json is not returned for API-Key authenticated requests.

id
string<uuid>
required

UUID of the workflow.

Example:

"019abc12-8901-7890-abcd-ef1234567895"

workflow_slug
string
required

Globally unique URL-friendly slug for the workflow.

Example:

"sd-portrait-v2"

display_name
string
required

Workflow name.

Example:

"SD 1.5 Portrait Generator"

version
integer
required

Auto-incrementing version number. Increases by 1 on each update.

Example:

3

workflow_status
enum<string>
required

Current workflow status:

  • active: Workflow can accept new task submissions.
  • disabled: New task submissions are rejected.
Available options:
active,
disabled
Example:

"active"

created_at
string<date-time>
required

When the workflow was created (ISO 8601).

Example:

"2025-01-20T10:00:00Z"

updated_at
string<date-time>
required

When the workflow was last updated (ISO 8601).

Example:

"2025-02-15T14:30:00Z"

description
string

Workflow description.

workflow_json
object

Complete tool-specific workflow definition. Not returned for API-Key authenticated requests.

parameters
object[]

Configurable parameter definitions.

required_labels
string[]

Labels required for agent matching.

Example:
task_timeout
integer

Maximum execution time in seconds after agent ACK. 0 means no timeout.

Example:

300

max_retries
integer

Maximum number of automatic retries on failure. 0 means no retry.

Example:

2

preferred_gpu
string

Preferred GPU type for agent matching.

Example:

"RTX_4090"

default_dispatch_target
enum<string>

Default compute source for tasks created from this workflow.

Available options:
agent,
comfy_cloud
Example:

"agent"

min_vram_gb
integer

Minimum GPU VRAM required (decimal GB). 0 means no requirement.

Example:

24

required_models
string[]

Model paths the workflow needs in an agent's cache.

Example:
tool_type
enum<string>

Tool runtime used by this workflow:

  • comfyui: ComfyUI API workflow JSON (default, backward compatible).
  • nerfstudio: Nerfstudio 3DGS pipeline spec.
Available options:
comfyui,
nerfstudio
Example:

"comfyui"