Skip to main content
GET
/
v1
/
runner
/
{id}
Get Runner
curl --request GET \
  --url https://api.comfycontrol.app/v1/runner/{id} \
  --header 'Authorization: Bearer <token>'
{
  "401": {},
  "404": {},
  "id": "<string>",
  "user_id": "<string>",
  "name": "<string>",
  "status": "<string>",
  "endpoint": "<string>",
  "tags": [
    "<string>"
  ],
  "headers": {},
  "created_at": "<string>",
  "updated_at": "<string>"
}

​
Overview

Retrieve detailed information about a specific runner by its ID. Only returns runners that belong to your account.

​
Path Parameters

​
id
string
required
The unique identifier (UUID) of the runner to retrieve.

​
Response

​
id
string
required
Unique identifier (UUID) for the runner.
​
user_id
string
required
UUID of the user who owns this runner.
​
name
string
required
The runner’s name.
​
status
string
required
Current status of the runner. Values: active, disabled
​
endpoint
string
required
The URL where the runner is accessible.
​
tags
string[]
required
Array of tags associated with the runner.
​
headers
object
required
Custom headers configured for this runner.
​
created_at
string
required
ISO 8601 timestamp when the runner was created.
​
updated_at
string
required
ISO 8601 timestamp when the runner was last updated.

​
Example Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "user_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "name": "Production GPU Runner",
  "status": "active",
  "endpoint": "https://my-comfy.example.com",
  "tags": ["production", "gpu-a100", "image-generation"],
  "headers": {
    "Authorization": "Bearer secret_token",
    "X-Custom-Header": "value"
  },
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

​
Error Responses

​
401
error
Unauthorized - invalid or missing authentication token.
​
404
error
Not Found - runner with the specified ID does not exist or does not belong to your account.