> ## 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. # Get task status > Retrieve the current status and metadata of a task. Use this to poll for task completion. Accepts JWT Bearer, `sk-` integration credential, or `dk-` device credential. ## OpenAPI ````yaml /api-reference/core-openapi.yaml get /r/tasks/{taskId} openapi: 3.0.3 info: title: Cyberun API version: 1.0.0 description: > Multi-tenant GPU orchestration platform for enterprise private deployments. ## Authentication Two authentication families are supported: - **JWT Bearer** (`Authorization: Bearer `) — Used by team owners/admins/members for management endpoints and user sessions. JWT-authenticated requests that operate on a team **must** include the `X-Team-ID` header to select which team the request applies to (a user can belong to multiple teams). - **Credential Bearer** (`Authorization: Bearer `) — Unified machine credential. The credential is always scoped to a single team derived from the credential row, and any `X-Team-ID` header is **ignored**. The three kinds differ in identity and routing: | Kind | Prefix | Identity | Allowed surfaces | | ------------- | ------ | ------------------------- | --- | | `integration` | `sk-` | Team only | Runtime API (`/r/`) + the Web MCP endpoint. Rejected on every management endpoint because the authorization layer needs a user identity and `sk-` has none. | | `agent` | `ak-` | Team only | the platform's WebSocket handshake **only** — rejected by the REST surface at the middleware layer. | | `device` | `dk-` | Team + user (per-device) | Runtime API and scoped management endpoints — behaves like a JWT for the underlying user. Issued by the desktop pairing flow only (`POST /desktop/pair/confirm`). | the authorization layer runs against the user identity carried by JWT and `dk-`. `sk-` and `ak-` bypass the authorization layer; service-layer checks enforce team scope for them. Runtime endpoints under `/r/` accept **JWT (with `X-Team-ID`)**, `sk-`, and `dk-`. `ak-` is rejected at the middleware (it is only meaningful on the the platform's WebSocket handshake). Scoped management endpoints accept **JWT (with `X-Team-ID`)** or `dk-`; `sk-` is rejected on management because the the authorization layer authorize layer requires a user identity. The Web MCP endpoint accepts `sk-` only. Multipart upload endpoints (`/uploads/multipart/*`) remain JWT-only. Credential-bearing callers (`sk-`, `dk-`) should use single-part presign (`POST /r/files/presign`) instead — that returns a vanilla S3 PUT URL (≤ 5 GB by S3, subject to the server's configured request cap; default 500 MB). Files beyond the cap currently require the JWT-only multipart flow. ## Task Lifecycle Tasks follow this state machine: `pending → waiting → queued → running → completed | failed | cancelled`. Submit tasks via workflow run endpoints, poll status via GET /r/tasks/{taskId}, and retrieve results via GET /r/tasks/{taskId}/result. ## Pagination All list endpoints support pagination via `current_page` (default: 1) and `per_page` (default: 20, max: 100) query parameters. Responses include a `page_meta` object with `current_page`, `per_page`, and `total_count`. servers: - url: https://core.cyberun.cloud/api/v1 description: Cyberun Cloud API security: [] tags: - name: Auth description: > Authentication and account lifecycle: register, login, logout, token refresh, password reset, and email verification. - name: User description: | Current user profile management: view and update profile, change password. - name: Team description: > Team management: create, update, delete teams, leave, and transfer ownership. Each user gets a personal team on registration. - name: Member description: | Team member management: list members, update roles, and remove members. - name: Invitation description: > Team invitation management: invite users by email, accept/decline invitations, list pending invitations, and cancel invitations. - name: Credential description: | Unified credential management: integration keys (`sk-`) for programmatic API access, agent keys (`ak-`) for headless workers, and device keys (`dk-`) for paired desktop installs. All three share storage and revocation flow; the `kind` field selects behaviour. - name: DevicePair description: > Desktop device pairing flow. Three endpoints — start (anonymous), confirm (JWT, called from the Cyberun dashboard), poll (anonymous, called from desktop) — exchange a short user-visible code for a `dk-` credential without the user ever typing the secret. - name: Workflow description: > ComfyUI workflow template management: create, update, delete, and list workflow templates with configurable parameters, labels, timeout, and retry settings. - name: Task description: | Task execution and monitoring: submit workflow runs, poll task status, retrieve results, and cancel tasks. Tasks follow the lifecycle: `pending → waiting → queued → running → completed | failed | cancelled`. - name: Webhook description: > Webhook management: register HTTPS endpoints to receive event notifications (task.completed, task.failed) with HMAC-SHA256 signed payloads. - name: Container description: > Container service orchestration: deploy arbitrary Docker containers (vLLM, Ollama, custom services) to agents, manage lifecycle, and proxy HTTP requests through the gateway with load balancing. - name: CloudProvider description: > Cloud compute provider management: configure third-party cloud GPU provider API keys (e.g. ComfyUI Cloud) for teams without local GPU agents, and manage automatic cloud fallback settings. - name: Notifications description: | In-app notification center: list, read, and manage notifications for status changes and system alerts. - name: Agent description: > Agent monitoring: view connected agents for a team, including their status, labels, and current task. Data is read from the the platform's runtime state. - name: Node description: | Custom node management: upload, register, update, and delete ComfyUI custom node packages (zip archives) for team-scoped agents. - name: Model description: | Model management: upload, register, update, and delete AI model files (checkpoints, LoRAs, etc.) for team-scoped agents. - name: File description: > File upload for workflow inputs: request presigned upload URLs to stage files (images, videos, audio) in S3, then reference them as `type: file` parameters when running workflows. - name: Upload description: > Multipart upload support for large files: initiate, presign parts, complete, and abort multipart uploads. Used alongside domain-specific presign endpoints for files exceeding ~100 MB. - name: Server description: | Public server information: registration status and other configuration visible to unauthenticated clients. paths: /r/tasks/{taskId}: parameters: - $ref: '#/components/parameters/TeamIdHeaderOptional' - $ref: '#/components/parameters/TaskId' get: tags: - Task summary: Get task status description: > Retrieve the current status and metadata of a task. Use this to poll for task completion. Accepts JWT Bearer, `sk-` integration credential, or `dk-` device credential. operationId: getTask responses: '200': description: Task details content: application/json: schema: $ref: '#/components/schemas/TaskResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' security: - bearerAuth: [] - DeviceAuth: [] - ApiKeyAuth: [] components: parameters: TeamIdHeaderOptional: name: X-Team-ID in: header required: false description: | 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. schema: type: string format: uuid example: 019abc12-4567-7890-abcd-ef1234567891 TaskId: name: taskId in: path required: true description: UUID of the task. schema: type: string format: uuid example: 019abc12-9012-7890-abcd-ef1234567896 schemas: TaskResponse: type: object description: > Task status and metadata. Use GET /r/tasks/{taskId}/result for output data and download URLs. required: - id - workflow_id - task_source - task_status - created_at properties: id: type: string format: uuid description: >- Unique task identifier (returned by runWorkflow / runWorkflowBySlug). example: 019abc12-9012-7890-abcd-ef1234567896 workflow_id: type: string format: uuid description: ID of the workflow template this task was created from. example: 019abc12-8901-7890-abcd-ef1234567895 task_source: $ref: '#/components/schemas/TaskSource' task_status: $ref: '#/components/schemas/TaskStatus' task_error: type: string description: Error message if the task failed. Empty string for non-failed tasks. example: '' retry_count: type: integer description: >- Number of times this task has been retried. 0 for the original attempt. Increments on each automatic retry up to the workflow's `max_retries`. example: 0 created_at: type: string format: date-time description: When the task was submitted (ISO 8601). example: '2025-02-10T14:00:00Z' started_at: type: string format: date-time nullable: true description: >- When the agent started executing the task. `null` if not yet started. example: '2025-02-10T14:00:05Z' completed_at: type: string format: date-time nullable: true description: >- When the task reached a terminal state (completed, failed, or cancelled). `null` if still running. example: '2025-02-10T14:01:30Z' agent_id: type: string description: >- ID of the agent that processed this task. `null` if not yet assigned. example: agent-gpu-01 agent_labels: type: array items: type: string description: >- Labels of the agent at the time of assignment. `null` if not yet assigned. example: - gpu - a100 gateway_id: type: string description: >- ID of the gateway that dispatched this task. `null` if not yet dispatched. example: gw-a1b2c3d4 gpu_type: type: string nullable: true description: >- GPU model that executed (or is executing) this task (e.g. "NVIDIA GeForce RTX 4090"). Available for all task sources. example: NVIDIA GeForce RTX 4090 dispatch_target: type: string enum: - agent - comfy_cloud description: | Where the task was executed: - `agent`: Executed on a BYOC (Bring Your Own Compute) agent. - `comfy_cloud`: Executed on ComfyUI Cloud. example: agent target_pool: type: string enum: - team - community description: | Dispatch pool. Echoed back from the run request (P2.2). For agent-fulfilled tasks, this records which pool the task was routed through — useful for audit and accounting. Always present; defaults to `team` on legacy rows. example: team tool_type: $ref: '#/components/schemas/ToolType' TaskSource: type: string enum: - jwt - api_key description: | How the task was created: - `jwt`: User executed a workflow via the web UI (JWT auth). - `api_key`: Executed programmatically via API Key (Bearer sk-xxx). TaskStatus: type: string enum: - pending - waiting - queued - running - completed - failed - cancelled description: > Current state of the task: - `pending`: Task created, waiting to be picked up by the scheduler. - `waiting`: The scheduler received the task, waiting for an available agent with matching labels. - `queued`: Task assigned to an agent, waiting for ACK. - `running`: Agent is executing the ComfyUI workflow. - `completed`: Execution finished successfully, output is available. - `failed`: Execution failed, check the error field for details. - `cancelled`: Task was cancelled before completion. ToolType: type: string enum: - comfyui - nerfstudio description: | Tool runtime used by this workflow: - `comfyui`: ComfyUI API workflow JSON (default, backward compatible). - `nerfstudio`: Nerfstudio 3DGS pipeline spec. example: comfyui ErrorResponse: type: object required: - error_message properties: error_message: type: string description: Human-readable error message describing what went wrong. example: resource not found responses: BadRequest: description: >- Invalid request: missing required fields, validation failure, or malformed input. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Unauthorized: description: 'Authentication failed: missing, expired, or invalid JWT/API key.' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Forbidden: description: >- Insufficient permissions: the authenticated user does not have the required role or the authorization layer policy. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' NotFound: description: 'Resource not found: the specified ID or slug does not exist.' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: | 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. DeviceAuth: type: http scheme: bearer description: > Device credential (Bearer dk-...) issued by the client device-pair flow (`POST /desktop/pair/confirm`). Carries the confirming user's identity, so it behaves like the user's JWT on team-scoped endpoints — the authorization layer runs against the user. Accepted on runtime + management endpoints. Never accepted on the platform's WebSocket. Team scope is bound at pair time; `X-Team-ID` is ignored. ApiKeyAuth: type: http scheme: bearer description: > Integration credential (Bearer sk-...). Team-scoped, no user identity, bypasses the authorization layer. Full runtime access on `/r/*` (including container invoke and proxy) and the Web MCP endpoint. **Not accepted on management endpoints** — those need a user-bearing credential (JWT or `DeviceAuth`). Team scope is taken from the credential; `X-Team-ID` is ignored. ````