Appearance
Jobs API
2 operations. Paths are relative to the API host (http://localhost:5080 in local development). Every operation accepts an OIDC bearer token (Authorization: Bearer …) or a workspace API key (X-Api-Key: keel_live_…); errors are RFC 9457 Problem Details with a code (error codes). Permissions: matrix.
| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/jobs/{jobId} | Status and progress of a queued job. |
| GET | /api/v1/jobs/{jobId}/events | Server-Sent Events: progress, stage, completed, failed. |
GetJob
http
GET /api/v1/jobs/{jobId}Status and progress of a queued job.
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
jobId | path | uuid | yes |
| Status | Description | Body |
|---|---|---|
| 200 | OK | JobStatusDto |
Response 200: JobStatusDto
| Field | Type | Notes |
|---|---|---|
attempts | int32 | |
completedAt | date-time? | |
createdAt | date-time | |
errorCode | string? | |
errorMessage | string? | |
id | uuid | |
isFinished | boolean | |
kind | string | |
progress | int32 | |
progressMessage | string? | |
startedAt | date-time? | |
status | string |
StreamJobEvents
http
GET /api/v1/jobs/{jobId}/eventsServer-Sent Events: progress, stage, completed, failed.
| Parameter | In | Type | Required | Notes |
|---|---|---|---|---|
jobId | path | uuid | yes |
| Status | Description | Body |
|---|---|---|
| 200 | OK | — |
| 404 | Not Found | ProblemDetails |