Skip to main content
GET
/
agents
List connected agents
curl --request GET \
  --url https://core.cyberun.cloud/api/v1/agents \
  --header 'Authorization: Bearer <token>'
{
  "agent_list": [
    {
      "agent_id": "gpu-node-01",
      "agent_status": "idle",
      "agent_labels": [
        "gpu",
        "a100",
        "comfyui"
      ],
      "last_heartbeat": "2025-02-10T14:30:00Z",
      "agent_version": "0.1.3",
      "tool": "comfyui",
      "tool_version": "0.3.13",
      "comfyui_version": "0.3.13",
      "gpu_capacity": 8,
      "running_count": 3,
      "running_tasks": [
        "019abc12-9012-7890-abcd-ef1234567896",
        "019abc12-9012-7890-abcd-ef1234567897"
      ],
      "platform_arch": "linux/amd64",
      "sync_phase": "downloading",
      "sync_detail": "Downloading model flux1-dev-fp8 (2.1 GB)",
      "sync_percent": 45,
      "connected_at": "2025-02-10T14:00:00Z",
      "tasks_completed": 42,
      "current_task_id": "019abc12-9012-7890-abcd-ef1234567896",
      "system_stats": {
        "comfyui_version": "0.3.10",
        "pytorch_version": "2.5.1+cu124",
        "os_type": "posix",
        "gpu_devices": [
          {
            "device_name": "NVIDIA GeForce RTX 4090",
            "device_type": "cuda",
            "vram_total": 25769803776,
            "vram_free": 22548578304
          }
        ]
      }
    }
  ],
  "page_meta": {
    "current_page": 1,
    "per_page": 20,
    "total_count": 42
  }
}

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"

Query Parameters

current_page
integer
default:1

Page number to retrieve (1-based). Default: 1.

Required range: x >= 1
Example:

1

per_page
integer
default:20

Number of items per page (1–100). Default: 20.

Required range: 1 <= x <= 100
Example:

20

Response

Agent list

agent_list
object[]
required

Agents registered for this team in the current page.

page_meta
object
required

Pagination metadata included in all list responses.