Skip to main content
GET
/
workflows
/
{workflowId}
Get workflow details
curl --request GET \
  --url https://core.cyberun.cloud/api/v1/workflows/{workflowId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "019abc12-8901-7890-abcd-ef1234567895",
  "workflow_slug": "sd-portrait-v2",
  "display_name": "SD 1.5 Portrait Generator",
  "version": 3,
  "workflow_status": "active",
  "created_at": "2025-01-20T10:00:00Z",
  "updated_at": "2025-02-15T14:30:00Z",
  "description": "<string>",
  "workflow_json": {},
  "parameters": [
    {
      "key": "prompt",
      "label": "Positive Prompt",
      "node_id": "6",
      "field": "text",
      "target_path": "train.max_num_iterations",
      "description": "<string>",
      "required": true,
      "default": "<unknown>",
      "min": 123,
      "max": 123,
      "options": [
        "<string>"
      ],
      "accept": [
        "<string>"
      ],
      "source_key": "input_image"
    }
  ],
  "required_labels": [
    "gpu",
    "sd15"
  ],
  "task_timeout": 300,
  "max_retries": 2,
  "preferred_gpu": "RTX_4090",
  "default_dispatch_target": "agent",
  "min_vram_gb": 24,
  "required_models": [
    "checkpoints/sdxl-base.safetensors"
  ],
  "tool_type": "comfyui"
}

Documentation Index

Fetch the complete documentation index at: https://docs.cyberun.cloud/llms.txt

Use this file to discover all available pages before exploring further.

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

​
workflowId
string<uuid>
required

UUID of the workflow.

Example:

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

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:
["gpu", "sd15"]
​
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:
["checkpoints/sdxl-base.safetensors"]
​
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"