Paths, authentication, parameters, request bodies, and responses for the usine operator API.
The operator API reads instance state, manages configuration, and operates runs. This reference renders the committed OpenAPI 3.1 document. For the contract of a running instance, request GET /api/openapi.json from that instance. The schema endpoint is public and contains no instance configuration or credentials.
Token timestamps and device authorization polling intervals use finite JSON numbers.
The server reads request bodies of up to 4 MiB. An operator operation with a larger body returns HTTP 413, and POST /api/mcp returns a JSON-RPC parse error. GitHub webhook deliveries have their own limit.
Authentication
Section titled “Authentication”Send an instance token as Authorization: Bearer <token>. Browser clients can use the usine_session cookie; writes with a session also require X-Usine-CSRF. See Sign in for browser sessions, and Create a device token for token issuance. The document marks health, sign-in, and schema operations as public. Each operation’s x-usine-permission names the permission that it requires: public, read, operate, maintain, admin, session (any credential), tokens (token management), local (the local admin token), or setup. GET /api/auth/session returns effective permissions as {permission, scope} grants, and operations for a device token with an operation ceiling. Roles and token ceilings both limit access; a forbidden operation returns HTTP 403. Lists include only projects with read access.
Viewer requires read, operator adds operate, and maintainer adds maintain on a project. Instance admin grants all operations, including membership, bindings, workers, settings, and upgrades. Project resource handlers check the target project in addition to the route requirement. See roles and scopes.
POST /api/tokens accepts a name, scopes, optional operations, and an optional expiresAt in epoch milliseconds, and returns the secret once. operations lists the operation IDs from this document, such as operator.approve, that the token may call; a call to another operation returns HTTP 403, except reading the session, signing out, and public operations, which need no token. PUT /api/tokens/:id/scopes changes an owned device token’s scopes and, with operations, its operation ceiling: an array replaces the ceiling, null removes it, and an absent key keeps it. Neither accepts scopes wider than the caller’s effective permissions or unknown operation IDs. When the caller has an operation ceiling, the token’s resulting ceiling must be part of it, including a ceiling that a scope edit keeps. A device token with an expiry can create, or change the scopes of, only tokens that expire no later than it does. Token listing includes scopes, operations, and expiresAt, which is null for a device token without an expiry. It also includes unknownOperations when a stored ceiling names operation IDs that this document doesn’t have, such as an ID that a release renamed; the token can’t call them. The first request with such a token after the instance starts logs a warning that names the unknown IDs. The local admin token has instance admin permissions and a null member; its writes are attributed to local admin.
Use HTTPS through a reverse proxy for remote access. Browser requests must use an origin accepted by the instance. URL-encode path parameters, including slashes in repository names and qualified loop names. An acknowledgement from an asynchronous action means the server accepted the request; read the corresponding status to learn its outcome.
MCP tools
Section titled “MCP tools”POST /api/mcp serves the operator operations as MCP tools over Streamable HTTP, with the same bearer token or browser session as other routes. Each tool is named by its endpoint identifier, such as approve for operator.approve, and takes one object with the path parameters, the query parameters, and body for a request body. The tool list contains only the operations that the caller’s permissions and operation ceiling permit; GET /api/changes has no tool. Each call runs the operation with the caller’s credential, so permissions, project checks, and audit apply as they do over HTTP. A result is the JSON response text, cut at 100 KB with a note that names a narrower operation. A session answers only the credential that opened it, and ends after one hour without a request, or when the caller’s tool list changes. A request for a session that ended or belongs to another credential returns HTTP 404, and the client starts a new session. usine mcp serves the same tools over stdio. See Connect an MCP client.
Paths and versions
Section titled “Paths and versions”Paths use /api/.... The schema’s info.version is unversioned; GET /api/version returns the running release string. The public /api/ready endpoint returns 200 after startup recovery and 503 while startup is incomplete.
The reference covers the operator HTTP API, including sign-in, members, and tokens. Static UI assets and the separate signature-verified GitHub webhook listener are outside this contract.
Configuration capabilities
Section titled “Configuration capabilities”GET /api/configuration/capabilities returns harnesses (registered IDs), efforts (reasoning levels), and harnessDetails. Each detail has an id, a display label, and a nullable handoff. A handoff contains the terminal command, a nullable homeVariable for a saved session directory, and gateway, which states whether the command can resume a gateway-authenticated session. Clients use this metadata for harness labels and resume details.
SQLite reader health
Section titled “SQLite reader health”GET /api/health is public and returns { "ok": true, "sqliteReader": "worker" } during normal operation. sqliteReader changes to fallback while the server uses the main connection and waits to retry worker startup, or respawning while a replacement starts and passes its probe. Reads use the main connection in both states. The endpoint returns HTTP 200 throughout recovery; long reads on the main connection can delay responses. The server logs worker failures and retries after 1 second, 5 seconds, 30 seconds, and then every 5 minutes. Recovery resets this delay.
Polling summaries and detail
Section titled “Polling summaries and detail”GET /api/overview returns project and board summaries with item titles, states, labels, counts, and identities. Its runs use RunSummaryView and its attempts use AttemptSummaryView. GET /api/desk uses the same summary types for running, stalled, and recent runs.
Each run summary read uses one read-only snapshot for run state and attempts. The SQLite worker executes these reads so long overview, board, and run-list queries permit transcript appends and health responses to continue. Board reads include history counts, timing, and loop states in that same database snapshot. Concurrent completion and retries preserve consistent run state, attempt outcomes, and operator actions. The overview run list reads open runs and recent closed runs together, so each run appears once. Run detail and evidence use the same snapshot boundary. During SQLite reader recovery, these snapshots use a transaction on the main connection, where long reads can delay responses.
Read GET /api/runs/:runId for the run’s task, result message, each attempt’s task, event payload, and transcript. The task endpoint, GET /api/projects/:owner/:repository/tasks/:item, also returns full run and attempt records. The board’s Run again action reads run detail before submitting the saved task and agent.
A transcript’s Started payload has a parentModel with the selected Pi parent model, or null for an attempt without a parent session.
Session records in transcripts and usage responses include an optional pool resolved at launch and an optional endpoint provider name for API-key models. Usage reads the recorded pool; older records without it use the historical harness and model rule. Endpoint names exclude URLs and credentials.
Pull request changes
Section titled “Pull request changes”The task page lists Changes beneath each pull request. Open the disclosure and use Compare to select the whole PR or an attempt with recorded commits. Files are collapsed initially, show added and removed counts, and mark test and generated files by path. Patch text does not affect these marks. The latest polled CI checks and review decision appear only for the whole PR. With no recorded attempt changes, Compare shows plain text, and the panel says whether the PR’s attempts pushed no new commits or recorded none. When the PR’s base or head changed after the task loaded, Retry refreshes the task and loads the latest changes. On phones, long file paths wrap to keep the file name visible. Open a file to read the patch without leaving usine.
Recorded attempt changes remain available after CI fails or a newer push cancels the CI wait. Each result is stored with the producing attempt. A successful retry adds a comparison and retains earlier attempt numbers and commit ranges.
For older records, an upgrade associates the saved step result with its recorded producer. Without a producer ID, the upgrade uses the latest attempt only if its outcome is Succeeded or AwaitingCi. Other older results remain in run detail and are omitted from the comparison selector.
GET /api/projects/:project/pull-requests/:repository/:item/files requires read access to the project. Encode the repository (owner/name) as one path segment. The query’s scope selects PullRequestFiles for the whole PR or CommitRangeFiles for an attempt. Both require base and head as full commit SHAs. Use the projected PR base for whole-PR reads and the recorded checkout base for attempts. Task detail provides attempt commit selections in attemptChanges, including runs beyond the first history page. Attempts without a recorded base are left out. Attempts that pushed no new commits are included with a base equal to their head; the task page leaves them out of its selector and says that they pushed no new commits.
Responses contain the resolved base, head, files, and filesTruncated. Each file has paths, status, counts, test and generated marks, and either a text patch with a truncation flag or an omitted patch. GitHub omits patches for some binary and large files. PR lists are limited to 3,000 files and comparisons to 300; a limited list is marked explicitly. GitHub provides no comparison file total, so a comparison with exactly 300 files is conservatively marked as limited. Successful reads are cached on the server by commit selection and in the browser without automatic refetch. The server cache holds up to 64 MiB of file paths and patch text and evicts the least recently read responses first. A response larger than that budget is returned without server caching. Task live updates supply PR base and head SHAs, so retargeting a PR refreshes its changes even when its head stays the same.
Open PRs recorded before comparison bases were polled are fetched once on the next poll, including when GitHub reports no changes. This refresh is persisted across restarts. Until a base and head are recorded, the Changes view says Pull request base or head not recorded yet.
A missing PR or unavailable commit comparison returns a 404 error envelope with FileChangesNotFoundError. When GitHub answers 404 because the GitHub App installation doesn’t cover the repository, the endpoint returns 503 with ProjectNotInstalledError; grant the installation access to the repository, then retry. A whole-PR selection whose base or head changed returns 409 with PullRequestFilesChangedError; refresh the task before retrying. GitHub rate limits return 503 with GitHubRateLimitError.
Operations
Section titled “Operations”| Method and path | Operation |
|---|---|
GET /api/upgrade | Read upgrade status |
DELETE /api/upgrade | Cancel a waiting upgrade |
POST /api/upgrade | Request an upgrade |
GET /api/version | Read the running release |
GET /api/ready | Check startup readiness |
GET /api/changes | Subscribe to entity change notices |
GET /api/workers | Read workers and slot usage |
GET /api/overview | Read the instance overview |
POST /api/attention/dismiss | Dismiss an attention item |
POST /api/attention/undo | Undo an attention dismissal |
GET /api/agents | List agents |
POST /api/runs/{runId}/edit-and-retry | Edit and retry a run |
POST /api/runs/{runId}/run-again | Run an item again |
POST /api/runs/{runId}/intervene | Send an operator message |
POST /api/cycle-budgets/reset | Reset an item cycle budget |
GET /api/runs/{runId} | Read a run and its transcript |
GET /api/runs/{runId}/github-changes | Read GitHub changes for a run |
POST /api/runs/{runId}/approve | Approve a waiting run |
POST /api/runs/{runId}/resolve-failure | Resolve a run failure |
POST /api/runs/{runId}/apply-ci-labels | Apply CI labels after CI passes |
POST /api/runs/{runId}/retry | Retry a failed run |
POST /api/runs/{runId}/cancel | Cancel a run |
GET /api/projects/{project} | Read a project board |
GET /api/projects/{project}/lanes/{lane}/items | Read the next page of board cards |
GET /api/projects/{project}/pull-requests/{repository}/{item}/files | Read pull request or attempt changes |
GET /api/projects/{project}/tasks/{item} | Read a project task |
POST /api/projects/{project}/items/{item}/lane | Move a project item |
POST /api/loops/{project}/{loop}/pause | Pause a project loop |
POST /api/loops/{project}/{loop}/unpause | Resume a project loop |
POST /api/projects/{owner}/{repository}/items/{item}/lane | Move a repository item |
POST /api/workers/{worker}/preflight | Run worker preflight |
POST /api/workers/{worker}/discard-leftovers | Discard worker leftovers |
POST /api/loops/{loop}/pause | Pause a loop |
POST /api/loops/{loop}/unpause | Resume a loop |
GET /api/projects/{owner}/{repository}/tasks/{item}/runs | Read a page of task runs |
GET /api/projects/{owner}/{repository}/tasks/{item} | Read a repository task |
POST /api/configuration/loops/check | Check a loop definition |
POST /api/configuration/loops/preview | Preview a loop |
GET /api/configuration/head | Read the current configuration revision |
GET /api/configuration/capabilities | List configuration capabilities |
GET /api/configuration/repositories | List installation repositories |
GET /api/configuration/labels/{repository} | List repository labels |
GET /api/configuration/revisions | List configuration revisions |
GET /api/configuration/revisions/{number} | Read a configuration revision |
GET /api/configuration/entities/{kind}/{identifier} | Read a configuration entity |
PUT /api/configuration/entities/{kind}/{identifier} | Replace a configuration entity |
DELETE /api/configuration/entities/{kind}/{identifier} | Delete a configuration entity |
POST /api/configuration/revisions/{number}/revert | Revert a configuration revision |
GET /api/configuration | Read instance configuration |
GET /api/desk | Read overview attention and activity |
GET /api/statistics | Read task statistics |
GET /api/statistics/runs | Read run statistics |
GET /api/health | Check server health |
GET /api/auth/info | Read sign-in availability |
GET /api/auth/session | Read the current session |
POST /api/auth/link | Create a sign-in link |
POST /api/auth/link/consume | Consume a sign-in link |
GET /api/auth/github | Start GitHub web sign-in |
GET /api/auth/callback | Complete GitHub web sign-in |
POST /api/auth/device | Start device sign-in |
POST /api/auth/device/poll | Poll device sign-in |
POST /api/auth/sign-out | Sign out |
GET /api/members | List members |
POST /api/members | Add a member |
DELETE /api/members/{id} | Remove a member |
GET /api/tokens | List member tokens |
POST /api/tokens | Create a scoped token |
PUT /api/tokens/{id}/scopes | Set token scopes |
DELETE /api/tokens/{id} | Revoke a token |
GET /api/setup | Read setup progress |
POST /api/setup/manifest | Prepare GitHub App creation |
GET /api/setup/callback | Complete GitHub App creation |
POST /api/setup/restore | Restore App credentials |
POST /api/setup/activate | Activate the configured instance |
GET /api/setup/runtime | Check runtime readiness |
GET /api/providers | Read provider connections |
POST /api/providers/login | Start provider sign-in |
POST /api/providers/code | Submit a Claude authorization code |
DELETE /api/providers/login/{id} | Cancel provider sign-in |
PUT /api/providers/key | Connect a provider API key |
POST /api/providers/disconnect | Disconnect a provider |
GET /api/openapi.json | Read the API schema |
Read upgrade status
GET /api/upgrade
Operation ID operator.upgradeStatus · Permission admin
Returns the running release, available release, and upgrade progress.
Requires an instance bearer token or browser session.
Responses
{
"200": {
"description": "@usine/orchestrator/UpgradeView",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_usine_orchestrator_UpgradeViewEncoded"
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Cancel a waiting upgrade
DELETE /api/upgrade
Operation ID operator.cancelUpgrade · Permission admin
Cancels a pending upgrade before installation begins and resumes deferred runs.
Requires an instance bearer token or browser session.
Responses
{
"200": {
"description": "The request was accepted. An asynchronous action may still be running.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false,
"title": "Acknowledgement",
"description": "The request was accepted. An asynchronous action may still be running."
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Request an upgrade
POST /api/upgrade
Operation ID operator.requestUpgrade · Permission admin
Accepts an upgrade when idle or an immediate restart. Poll upgrade status for the outcome.
Requires an instance bearer token or browser session.
Request body
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_usine_orchestrator_UpgradeRequestEncoded"
}
}
},
"required": true
}Responses
{
"200": {
"description": "The request was accepted. An asynchronous action may still be running.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false,
"title": "Acknowledgement",
"description": "The request was accepted. An asynchronous action may still be running."
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Read the running release
GET /api/version
Operation ID operator.serverVersion · Permission public
Public health check that returns the running release string.
Public endpoint.
Responses
{
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Check startup readiness
GET /api/ready
Operation ID operator.serverReady · Permission public
Public readiness check. Returns 503 with Retry-After during startup recovery and 200 after runtime routes are installed.
Public endpoint.
Responses
{
"200": {
"description": "Startup recovery has finished and runtime routes are available.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false,
"title": "Readiness",
"description": "Startup recovery has finished and runtime routes are available."
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"Starting"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
]
}
}
}
}
}Subscribe to entity change notices
GET /api/changes
Operation ID operator.changes · Permission read
Streams authorized entity identifiers and monotonic revisions. Resumes from Last-Event-ID or requests a cache reset.
Requires an instance bearer token or browser session.
Responses
{
"200": {
"description": "Success",
"content": {
"text/event-stream": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Read workers and slot usage
GET /api/workers
Operation ID operator.workers · Permission admin
Returns configured and removed workers with current slot usage.
Requires an instance bearer token or browser session.
Responses
{
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"workers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_WorkerConfigurationViewEncoded"
}
},
"removedWorkers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_RemovedWorkerViewEncoded"
}
}
},
"required": [
"workers",
"removedWorkers"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Read the instance overview
GET /api/overview
Operation ID operator.overview · Permission read
Returns project boards, loops, workers, and instance readiness.
Requires an instance bearer token or browser session.
Responses
{
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_ReadyOverviewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_NeedsSetupOverviewEncoded"
}
]
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Dismiss an attention item
POST /api/attention/dismiss
Operation ID operator.dismissNeed · Permission admin
Acknowledges the current attention item until its state changes.
Requires an instance bearer token or browser session.
Request body
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_usine_engine_AttentionKeyEncoded"
}
}
},
"required": true
}Responses
{
"200": {
"description": "The request was accepted. An asynchronous action may still be running.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false,
"title": "Acknowledgement",
"description": "The request was accepted. An asynchronous action may still be running."
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Undo an attention dismissal
POST /api/attention/undo
Operation ID operator.undoDismissNeed · Permission admin
Removes the acknowledgement for the supplied attention item.
Requires an instance bearer token or browser session.
Request body
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_usine_engine_AttentionKeyEncoded"
}
}
},
"required": true
}Responses
{
"200": {
"description": "The request was accepted. An asynchronous action may still be running.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false,
"title": "Acknowledgement",
"description": "The request was accepted. An asynchronous action may still be running."
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}List agents
GET /api/agents
Operation ID operator.agents · Permission read
Returns the names of saved agent definitions available for runs.
Requires an instance bearer token or browser session.
Responses
{
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
}
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Edit and retry a run
POST /api/runs/{runId}/edit-and-retry
Operation ID operator.editAndRetry · Permission operate
Retries a failed run with the supplied task or agent changes.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
runId | path | Yes | {"type":"string","minLength":1} |
Request body
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_usine_orchestrator_EditAndRetryEncoded"
}
}
},
"required": true
}Responses
{
"200": {
"description": "The request was accepted. An asynchronous action may still be running.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false,
"title": "Acknowledgement",
"description": "The request was accepted. An asynchronous action may still be running."
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Run an item again
POST /api/runs/{runId}/run-again
Operation ID operator.runAgain · Permission operate
Opens a new run for a succeeded or canceled run and returns the admission result.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
runId | path | Yes | {"type":"string","minLength":1} |
Request body
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_usine_orchestrator_EditAndRetryEncoded"
}
}
},
"required": true
}Responses
{
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_engine_ClaimedEncoded"
},
{
"$ref": "#/components/schemas/_usine_engine_CycleBlockedEncoded"
}
]
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Send an operator message
POST /api/runs/{runId}/intervene
Operation ID operator.intervene · Permission operate
Sends a message to the selected session of a running attempt.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
runId | path | Yes | {"type":"string","minLength":1} |
Request body
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_usine_orchestrator_SessionInterventionEncoded"
}
}
},
"required": true
}Responses
{
"200": {
"description": "The request was accepted. An asynchronous action may still be running.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false,
"title": "Acknowledgement",
"description": "The request was accepted. An asynchronous action may still be running."
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Reset an item cycle budget
POST /api/cycle-budgets/reset
Operation ID operator.resetCycleBudget · Permission operate
Answers an open cycle budget ask and allows the item to run again. Returns the blocked CI fix events that the reset replayed; a repeated answer returns an empty list.
Requires an instance bearer token or browser session.
Request body
{
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"askId": {
"type": "string",
"minLength": 1
}
},
"required": [
"askId"
],
"additionalProperties": false
}
}
},
"required": true
}Responses
{
"200": {
"description": "@usine/orchestrator/CycleBudgetResetView",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_usine_orchestrator_CycleBudgetResetViewEncoded"
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Read a run and its transcript
GET /api/runs/{runId}
Operation ID operator.detail · Permission read
Without cursors, returns the latest transcript page. Use after for updates, or before and attempt together for earlier messages.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
runId | path | Yes | {"type":"string","minLength":1} |
after | query | No | {"type":"integer","minimum":1,"maximum":9007199254740991} |
before | query | No | {"type":"integer","minimum":1,"maximum":9007199254740991} |
attempt | query | No | {"type":"string","minLength":1} |
Responses
{
"200": {
"description": "@usine/orchestrator/RunDetailView",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_usine_orchestrator_RunDetailViewEncoded"
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Read GitHub changes for a run
GET /api/runs/{runId}/github-changes
Operation ID operator.githubChanges · Permission read
Returns GitHub writes grouped by attempt window.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
runId | path | Yes | {"type":"string","minLength":1} |
Responses
{
"200": {
"description": "@usine/orchestrator/RunGitHubChangesView",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_usine_orchestrator_RunGitHubChangesViewEncoded"
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Approve a waiting run
POST /api/runs/{runId}/approve
Operation ID operator.approve · Permission operate
Records the signed-in member approval for a run waiting at a gate.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
runId | path | Yes | {"type":"string","minLength":1} |
Responses
{
"200": {
"description": "The request was accepted. An asynchronous action may still be running.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false,
"title": "Acknowledgement",
"description": "The request was accepted. An asynchronous action may still be running."
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Resolve a run failure
POST /api/runs/{runId}/resolve-failure
Operation ID operator.resolveFailure · Permission operate
Acknowledges the supplied failed attempt only while it remains the current failure.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
runId | path | Yes | {"type":"string","minLength":1} |
Request body
{
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"attemptId": {
"type": "string",
"minLength": 1
}
},
"required": [
"attemptId"
],
"additionalProperties": false
}
}
},
"required": true
}Responses
{
"200": {
"description": "The request was accepted. An asynchronous action may still be running.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false,
"title": "Acknowledgement",
"description": "The request was accepted. An asynchronous action may still be running."
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Apply CI labels after CI passes
POST /api/runs/{runId}/apply-ci-labels
Operation ID operator.applyCiLabels · Permission operate
For a run whose CI wait ended because CI on its head didn't finish, checks that CI on the same head has passed with every workflow run concluded, applies the wait's completion labels, and resolves the supplied failed attempt.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
runId | path | Yes | {"type":"string","minLength":1} |
Request body
{
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"attemptId": {
"type": "string",
"minLength": 1
}
},
"required": [
"attemptId"
],
"additionalProperties": false
}
}
},
"required": true
}Responses
{
"200": {
"description": "The request was accepted. An asynchronous action may still be running.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false,
"title": "Acknowledgement",
"description": "The request was accepted. An asynchronous action may still be running."
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Retry a failed run
POST /api/runs/{runId}/retry
Operation ID operator.retry · Permission operate
Starts another attempt of a failed run with its saved definitions.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
runId | path | Yes | {"type":"string","minLength":1} |
Responses
{
"200": {
"description": "The request was accepted. An asynchronous action may still be running.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false,
"title": "Acknowledgement",
"description": "The request was accepted. An asynchronous action may still be running."
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Cancel a run
POST /api/runs/{runId}/cancel
Operation ID operator.cancel · Permission operate
Cancels an open run and requests that any active attempt stop.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
runId | path | Yes | {"type":"string","minLength":1} |
Responses
{
"200": {
"description": "The request was accepted. An asynchronous action may still be running.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false,
"title": "Acknowledgement",
"description": "The request was accepted. An asynchronous action may still be running."
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Read a project board
GET /api/projects/{project}
Operation ID operator.project · Permission read
Returns the project and its board across member repositories.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
project | path | Yes | {"type":"string","pattern":"^[a-z0-9]+(?:-[a-z0-9]+)*$"} |
Responses
{
"200": {
"description": "@usine/orchestrator/ProjectView",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_usine_orchestrator_ProjectViewEncoded"
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Read the next page of board cards
GET /api/projects/{project}/lanes/{lane}/items
Operation ID operator.boardLaneItems · Permission read
Returns up to 50 items and the next offset for a project lane.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
project | path | Yes | {"type":"string","pattern":"^[a-z0-9]+(?:-[a-z0-9]+)*$"} |
lane | path | Yes | {"type":"string","minLength":1} |
offset | query | No | {"type":"string","pattern":"^[+-]?(?:\\d+(?:\\.\\d+)?|\\.\\d+)(?:[Ee][+-]?\\d+)?$"} |
Responses
{
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_BoardTaskViewEncoded"
}
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"nextOffset": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"items",
"total",
"nextOffset"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Read pull request or attempt changes
GET /api/projects/{project}/pull-requests/{repository}/{item}/files
Operation ID operator.pullRequestFiles · Permission read
Returns commit-pinned files for a whole pull request or a comparison from an attempt checkout base to its pushed head. Reports missing patches and truncated file lists. Requires read access to the repository's project.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
project | path | Yes | {"type":"string","pattern":"^[a-z0-9]+(?:-[a-z0-9]+)*$"} |
repository | path | Yes | {"type":"string","pattern":"^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"} |
item | path | Yes | {"type":"string","pattern":"^[+-]?(?:\\d+(?:\\.\\d+)?|\\.\\d+)(?:[Ee][+-]?\\d+)?$"} |
scope | query | Yes | {"type":"string","enum":["PullRequestFiles","CommitRangeFiles"]} |
head | query | Yes | {"type":"string","pattern":"^[0-9a-f]{40}(?:[0-9a-f]{24})?$"} |
base | query | Yes | {"type":"string","pattern":"^[0-9a-f]{40}(?:[0-9a-f]{24})?$"} |
Responses
{
"200": {
"description": "FileChanges",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileChangesEncoded"
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Read a project task
GET /api/projects/{project}/tasks/{item}
Operation ID operator.projectTask · Permission read
Returns linked issues, pull requests, and runs for an item in a project repository.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
project | path | Yes | {"type":"string","pattern":"^[a-z0-9]+(?:-[a-z0-9]+)*$"} |
item | path | Yes | {"type":"string"} |
repository | query | Yes | {"type":"string","pattern":"^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"} |
Responses
{
"200": {
"description": "@usine/orchestrator/TaskView",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_usine_orchestrator_TaskViewEncoded"
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Move a project item
POST /api/projects/{project}/items/{item}/lane
Operation ID operator.moveProjectItem · Permission operate
Changes the GitHub labels of the task current item to match the destination lane.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
project | path | Yes | {"type":"string","pattern":"^[a-z0-9]+(?:-[a-z0-9]+)*$"} |
item | path | Yes | {"type":"string"} |
Request body
{
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"repository": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
},
"toLane": {
"type": "string",
"minLength": 1
}
},
"required": [
"repository",
"toLane"
],
"additionalProperties": false
}
}
},
"required": true
}Responses
{
"200": {
"description": "The request was accepted. An asynchronous action may still be running.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false,
"title": "Acknowledgement",
"description": "The request was accepted. An asynchronous action may still be running."
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Pause a project loop
POST /api/loops/{project}/{loop}/pause
Operation ID operator.pauseProjectLoop · Permission operate
Stops the loop from opening new runs without canceling existing runs.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
project | path | Yes | {"type":"string","pattern":"^[a-z0-9]+(?:-[a-z0-9]+)*$"} |
loop | path | Yes | {"type":"string","minLength":1} |
Responses
{
"200": {
"description": "The request was accepted. An asynchronous action may still be running.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false,
"title": "Acknowledgement",
"description": "The request was accepted. An asynchronous action may still be running."
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Resume a project loop
POST /api/loops/{project}/{loop}/unpause
Operation ID operator.unpauseProjectLoop · Permission operate
Allows the loop to open runs for matching items.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
project | path | Yes | {"type":"string","pattern":"^[a-z0-9]+(?:-[a-z0-9]+)*$"} |
loop | path | Yes | {"type":"string","minLength":1} |
Responses
{
"200": {
"description": "The request was accepted. An asynchronous action may still be running.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false,
"title": "Acknowledgement",
"description": "The request was accepted. An asynchronous action may still be running."
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Move a repository item
POST /api/projects/{owner}/{repository}/items/{item}/lane
Operation ID operator.moveBoardItem · Permission operate
Moves the item using the lanes of the project that contains its repository.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
owner | path | Yes | {"type":"string","pattern":"^[A-Za-z0-9_.-]+$"} |
repository | path | Yes | {"type":"string","pattern":"^[A-Za-z0-9_.-]+$"} |
item | path | Yes | {"type":"string"} |
Request body
{
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"toLane": {
"type": "string",
"minLength": 1
}
},
"required": [
"toLane"
],
"additionalProperties": false
}
}
},
"required": true
}Responses
{
"200": {
"description": "The request was accepted. An asynchronous action may still be running.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false,
"title": "Acknowledgement",
"description": "The request was accepted. An asynchronous action may still be running."
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Run worker preflight
POST /api/workers/{worker}/preflight
Operation ID operator.runWorkerPreflight · Permission admin
Checks one idle worker and replaces its stored capability results, including failures with remediation. Returns 409 while an attempt or another preflight uses the worker.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
worker | path | Yes | {"type":"string","pattern":"^[a-z0-9]+(?:-[a-z0-9]+)*$"} |
Responses
{
"200": {
"description": "@usine/orchestrator/WorkerPreflightView",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_usine_orchestrator_WorkerPreflightViewEncoded"
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Discard worker leftovers
POST /api/workers/{worker}/discard-leftovers
Operation ID operator.discardLeftovers · Permission admin
Discards a removed worker only after its running attempts have ended.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
worker | path | Yes | {"type":"string","pattern":"^[a-z0-9]+(?:-[a-z0-9]+)*$"} |
Responses
{
"200": {
"description": "The request was accepted. An asynchronous action may still be running.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false,
"title": "Acknowledgement",
"description": "The request was accepted. An asynchronous action may still be running."
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Pause a loop
POST /api/loops/{loop}/pause
Operation ID operator.pause · Permission operate
Accepts a qualified project/loop name, or a short name while it is unique. Encode slashes in the path segment.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
loop | path | Yes | {"type":"string","minLength":1} |
Responses
{
"200": {
"description": "The request was accepted. An asynchronous action may still be running.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false,
"title": "Acknowledgement",
"description": "The request was accepted. An asynchronous action may still be running."
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Resume a loop
POST /api/loops/{loop}/unpause
Operation ID operator.unpause · Permission operate
Accepts a qualified project/loop name, or a short name while it is unique. Encode slashes in the path segment.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
loop | path | Yes | {"type":"string","minLength":1} |
Responses
{
"200": {
"description": "The request was accepted. An asynchronous action may still be running.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false,
"title": "Acknowledgement",
"description": "The request was accepted. An asynchronous action may still be running."
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Read a page of task runs
GET /api/projects/{owner}/{repository}/tasks/{item}/runs
Operation ID operator.taskRuns · Permission read
Returns up to 25 runs and the next offset for a repository task.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
owner | path | Yes | {"type":"string","pattern":"^[A-Za-z0-9_.-]+$"} |
repository | path | Yes | {"type":"string","pattern":"^[A-Za-z0-9_.-]+$"} |
item | path | Yes | {"type":"string"} |
offset | query | No | {"type":"string","pattern":"^[+-]?(?:\\d+(?:\\.\\d+)?|\\.\\d+)(?:[Ee][+-]?\\d+)?$"} |
Responses
{
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"runs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_RunViewEncoded"
}
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"nextOffset": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"runs",
"total",
"nextOffset"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Read a repository task
GET /api/projects/{owner}/{repository}/tasks/{item}
Operation ID operator.task · Permission read
Returns linked items and runs for the repository item.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
owner | path | Yes | {"type":"string","pattern":"^[A-Za-z0-9_.-]+$"} |
repository | path | Yes | {"type":"string","pattern":"^[A-Za-z0-9_.-]+$"} |
item | path | Yes | {"type":"string"} |
Responses
{
"200": {
"description": "@usine/orchestrator/TaskView",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_usine_orchestrator_TaskViewEncoded"
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Check a loop definition
POST /api/configuration/loops/check
Operation ID operator.checkLoop · Permission maintain
Checks the proposed loop, CEL expressions, and prompt without saving a revision.
Requires an instance bearer token or browser session.
Request body
{
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"pattern": "^(?:[a-z0-9]+(?:-[a-z0-9]+)*\\/)?[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"value": {},
"text": {
"not": {}
}
},
"required": [
"name",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"pattern": "^(?:[a-z0-9]+(?:-[a-z0-9]+)*\\/)?[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"text": {
"type": "string"
},
"value": {
"not": {}
}
},
"required": [
"name",
"text"
],
"additionalProperties": false
}
]
}
}
},
"required": true
}Responses
{
"200": {
"description": "LoopCheck",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoopCheckEncoded"
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "StaleRevisionRefusal | ConfigurationRevertRefusal | @usine/orchestrator/RestartRequiredRefusal | @usine/orchestrator/ReloadPreflightRefusal",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/StaleRevisionRefusalEncoded"
},
{
"$ref": "#/components/schemas/ConfigurationRevertRefusalEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_RestartRequiredRefusalEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ReloadPreflightRefusalEncoded"
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
]
}
}
}
},
"422": {
"description": "ConfigurationInvalidRefusal | @usine/orchestrator/FactoryConfigRefusal",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ConfigurationInvalidRefusalEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_FactoryConfigRefusalEncoded"
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
]
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "@usine/orchestrator/ValidationTimeoutRefusal",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_ValidationTimeoutRefusalEncoded"
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
]
}
}
}
}
}Preview a loop
POST /api/configuration/loops/preview
Operation ID operator.previewLoop · Permission read
Evaluates the proposed loop against stored GitHub items without making GitHub requests or saving a revision.
Requires an instance bearer token or browser session.
Request body
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoopPreviewRequestEncoded"
}
}
},
"required": true
}Responses
{
"200": {
"description": "LoopPreview",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoopPreviewEncoded"
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "StaleRevisionRefusal | ConfigurationRevertRefusal | @usine/orchestrator/RestartRequiredRefusal | @usine/orchestrator/ReloadPreflightRefusal",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/StaleRevisionRefusalEncoded"
},
{
"$ref": "#/components/schemas/ConfigurationRevertRefusalEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_RestartRequiredRefusalEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ReloadPreflightRefusalEncoded"
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
]
}
}
}
},
"422": {
"description": "ConfigurationInvalidRefusal | @usine/orchestrator/FactoryConfigRefusal",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ConfigurationInvalidRefusalEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_FactoryConfigRefusalEncoded"
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
]
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "@usine/orchestrator/ValidationTimeoutRefusal",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_ValidationTimeoutRefusalEncoded"
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
]
}
}
}
}
}Read the current configuration revision
GET /api/configuration/head
Operation ID operator.configurationHead · Permission read
Returns the revision number used to detect stale configuration writes.
Requires an instance bearer token or browser session.
Responses
{
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"number": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"number"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "StaleRevisionRefusal | ConfigurationRevertRefusal | @usine/orchestrator/RestartRequiredRefusal | @usine/orchestrator/ReloadPreflightRefusal",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/StaleRevisionRefusalEncoded"
},
{
"$ref": "#/components/schemas/ConfigurationRevertRefusalEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_RestartRequiredRefusalEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ReloadPreflightRefusalEncoded"
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
]
}
}
}
},
"422": {
"description": "ConfigurationInvalidRefusal | @usine/orchestrator/FactoryConfigRefusal",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ConfigurationInvalidRefusalEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_FactoryConfigRefusalEncoded"
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
]
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "@usine/orchestrator/ValidationTimeoutRefusal",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_ValidationTimeoutRefusalEncoded"
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
]
}
}
}
}
}List configuration capabilities
GET /api/configuration/capabilities
Operation ID operator.configurationCapabilities · Permission read
Returns supported harnesses and reasoning efforts.
Requires an instance bearer token or browser session.
Responses
{
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"harnesses": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"
}
},
"harnessDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_agents_HarnessPresentationEncoded"
}
},
"efforts": {
"type": "array",
"items": {
"type": "string",
"enum": [
"off",
"minimal",
"low",
"medium",
"high",
"xhigh",
"max"
]
}
}
},
"required": [
"harnesses",
"harnessDetails",
"efforts"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}List installation repositories
GET /api/configuration/repositories
Operation ID operator.configurationRepositories · Permission admin
Returns repositories available to the instance GitHub App installation.
Requires an instance bearer token or browser session.
Responses
{
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
}
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}List repository labels
GET /api/configuration/labels/{repository}
Operation ID operator.configurationLabels · Permission read
Reads live GitHub labels. Encode the repository slash in the path segment.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
repository | path | Yes | {"type":"string","pattern":"^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"} |
Responses
{
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_github_RepositoryLabelEncoded"
}
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}List configuration revisions
GET /api/configuration/revisions
Operation ID operator.configurationRevisions · Permission read
Returns a page of revisions, newest first. Pass nextBefore as before for the next page; the default limit is 50.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
kind | query | No | {"anyOf":[{"type":"string"},{"type":"array","prefixItems":[{"type":"string"}],"minItems":1,"items":{"type":"string"}}]} |
identifier | query | No | {"anyOf":[{"type":"string"},{"type":"array","prefixItems":[{"type":"string"}],"minItems":1,"items":{"type":"string"}}]} |
before | query | No | {"anyOf":[{"type":"string"},{"type":"array","prefixItems":[{"type":"string"}],"minItems":1,"items":{"type":"string"}}]} |
limit | query | No | {"anyOf":[{"type":"string"},{"type":"array","prefixItems":[{"type":"string"}],"minItems":1,"items":{"type":"string"}}]} |
Responses
{
"200": {
"description": "ConfigurationRevisionPage",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigurationRevisionPageEncoded"
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "StaleRevisionRefusal | ConfigurationRevertRefusal | @usine/orchestrator/RestartRequiredRefusal | @usine/orchestrator/ReloadPreflightRefusal",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/StaleRevisionRefusalEncoded"
},
{
"$ref": "#/components/schemas/ConfigurationRevertRefusalEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_RestartRequiredRefusalEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ReloadPreflightRefusalEncoded"
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
]
}
}
}
},
"422": {
"description": "ConfigurationInvalidRefusal | @usine/orchestrator/FactoryConfigRefusal",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ConfigurationInvalidRefusalEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_FactoryConfigRefusalEncoded"
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
]
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "@usine/orchestrator/ValidationTimeoutRefusal",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_ValidationTimeoutRefusalEncoded"
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
]
}
}
}
}
}Read a configuration revision
GET /api/configuration/revisions/{number}
Operation ID operator.configurationRevision · Permission read
Returns each changed entity with its values before and after the revision.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
number | path | Yes | {"type":"string"} |
Responses
{
"200": {
"description": "ConfigurationRevisionView",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigurationRevisionViewEncoded"
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "StaleRevisionRefusal | ConfigurationRevertRefusal | @usine/orchestrator/RestartRequiredRefusal | @usine/orchestrator/ReloadPreflightRefusal",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/StaleRevisionRefusalEncoded"
},
{
"$ref": "#/components/schemas/ConfigurationRevertRefusalEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_RestartRequiredRefusalEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ReloadPreflightRefusalEncoded"
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
]
}
}
}
},
"422": {
"description": "ConfigurationInvalidRefusal | @usine/orchestrator/FactoryConfigRefusal",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ConfigurationInvalidRefusalEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_FactoryConfigRefusalEncoded"
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
]
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "@usine/orchestrator/ValidationTimeoutRefusal",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_ValidationTimeoutRefusalEncoded"
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
]
}
}
}
}
}Read a configuration entity
GET /api/configuration/entities/{kind}/{identifier}
Operation ID operator.configurationEntity · Permission read
Returns the current JSON value, export-format text, and revision number.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
kind | path | Yes | {"type":"string"} |
identifier | path | Yes | {"type":"string","minLength":1} |
Responses
{
"200": {
"description": "ConfigurationEntityView",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigurationEntityViewEncoded"
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "StaleRevisionRefusal | ConfigurationRevertRefusal | @usine/orchestrator/RestartRequiredRefusal | @usine/orchestrator/ReloadPreflightRefusal",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/StaleRevisionRefusalEncoded"
},
{
"$ref": "#/components/schemas/ConfigurationRevertRefusalEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_RestartRequiredRefusalEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ReloadPreflightRefusalEncoded"
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
]
}
}
}
},
"422": {
"description": "ConfigurationInvalidRefusal | @usine/orchestrator/FactoryConfigRefusal",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ConfigurationInvalidRefusalEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_FactoryConfigRefusalEncoded"
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
]
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "@usine/orchestrator/ValidationTimeoutRefusal",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_ValidationTimeoutRefusalEncoded"
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
]
}
}
}
}
}Replace a configuration entity
PUT /api/configuration/entities/{kind}/{identifier}
Operation ID operator.replaceConfigurationEntity · Permission maintain
Creates or replaces an entity from value or text. The expected revision rejects stale writes.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
kind | path | Yes | {"type":"string"} |
identifier | path | Yes | {"type":"string","minLength":1} |
Request body
{
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"expected": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"message": {
"type": "string"
},
"value": {},
"text": {
"not": {}
},
"position": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"expected",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"expected": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"message": {
"type": "string"
},
"text": {
"type": "string"
},
"value": {
"not": {}
},
"position": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"expected",
"text"
],
"additionalProperties": false
}
]
}
}
},
"required": true
}Responses
{
"200": {
"description": "ConfigurationRevisionView",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigurationRevisionViewEncoded"
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "StaleRevisionRefusal | ConfigurationRevertRefusal | @usine/orchestrator/RestartRequiredRefusal | @usine/orchestrator/ReloadPreflightRefusal",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/StaleRevisionRefusalEncoded"
},
{
"$ref": "#/components/schemas/ConfigurationRevertRefusalEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_RestartRequiredRefusalEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ReloadPreflightRefusalEncoded"
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
]
}
}
}
},
"422": {
"description": "ConfigurationInvalidRefusal | @usine/orchestrator/FactoryConfigRefusal",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ConfigurationInvalidRefusalEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_FactoryConfigRefusalEncoded"
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
]
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "@usine/orchestrator/ValidationTimeoutRefusal",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_ValidationTimeoutRefusalEncoded"
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
]
}
}
}
}
}Delete a configuration entity
DELETE /api/configuration/entities/{kind}/{identifier}
Operation ID operator.deleteConfigurationEntity · Permission maintain
Deletes the entity if the expected revision is current.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
kind | path | Yes | {"type":"string"} |
identifier | path | Yes | {"type":"string","minLength":1} |
Request body
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigurationWriteEncoded"
}
}
},
"required": true
}Responses
{
"200": {
"description": "ConfigurationRevisionView",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigurationRevisionViewEncoded"
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "StaleRevisionRefusal | ConfigurationRevertRefusal | @usine/orchestrator/RestartRequiredRefusal | @usine/orchestrator/ReloadPreflightRefusal",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/StaleRevisionRefusalEncoded"
},
{
"$ref": "#/components/schemas/ConfigurationRevertRefusalEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_RestartRequiredRefusalEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ReloadPreflightRefusalEncoded"
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
]
}
}
}
},
"422": {
"description": "ConfigurationInvalidRefusal | @usine/orchestrator/FactoryConfigRefusal",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ConfigurationInvalidRefusalEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_FactoryConfigRefusalEncoded"
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
]
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "@usine/orchestrator/ValidationTimeoutRefusal",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_ValidationTimeoutRefusalEncoded"
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
]
}
}
}
}
}Revert a configuration revision
POST /api/configuration/revisions/{number}/revert
Operation ID operator.revertConfigurationRevision · Permission maintain
Creates a revision restoring earlier values unless later edits conflict.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
number | path | Yes | {"type":"string"} |
Request body
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigurationWriteEncoded"
}
}
},
"required": true
}Responses
{
"200": {
"description": "ConfigurationRevisionView",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigurationRevisionViewEncoded"
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "StaleRevisionRefusal | ConfigurationRevertRefusal | @usine/orchestrator/RestartRequiredRefusal | @usine/orchestrator/ReloadPreflightRefusal",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/StaleRevisionRefusalEncoded"
},
{
"$ref": "#/components/schemas/ConfigurationRevertRefusalEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_RestartRequiredRefusalEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ReloadPreflightRefusalEncoded"
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
]
}
}
}
},
"422": {
"description": "ConfigurationInvalidRefusal | @usine/orchestrator/FactoryConfigRefusal",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ConfigurationInvalidRefusalEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_FactoryConfigRefusalEncoded"
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
]
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "@usine/orchestrator/ValidationTimeoutRefusal",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_ValidationTimeoutRefusalEncoded"
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
]
}
}
}
}
}Read instance configuration
GET /api/configuration
Operation ID operator.configuration · Permission read
Returns stored configuration for the configuration editor.
Requires an instance bearer token or browser session.
Responses
{
"200": {
"description": "@usine/orchestrator/ConfigurationView",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_usine_orchestrator_ConfigurationViewEncoded"
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Read overview attention and activity
GET /api/desk
Operation ID operator.desk · Permission read
Returns attention items, active attempts, recent runs, and worker slots.
Requires an instance bearer token or browser session.
Responses
{
"200": {
"description": "@usine/orchestrator/DeskView",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_usine_orchestrator_DeskViewEncoded"
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Read task statistics
GET /api/statistics
Operation ID operator.statistics · Permission read
Aggregates task outcomes and worker utilization for the requested window, defaulting to 30d.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
window | query | No | {"anyOf":[{"type":"string"},{"type":"array","prefixItems":[{"type":"string"}],"minItems":1,"items":{"type":"string"}}]} |
Responses
{
"200": {
"description": "@usine/orchestrator/StatisticsView",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_usine_orchestrator_StatisticsViewEncoded"
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Read run statistics
GET /api/statistics/runs
Operation ID operator.runStatistics · Permission read
Aggregates runs, attempts, retries, and durations for the requested window, defaulting to 30d.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
window | query | No | {"anyOf":[{"type":"string"},{"type":"array","prefixItems":[{"type":"string"}],"minItems":1,"items":{"type":"string"}}]} |
Responses
{
"200": {
"description": "@usine/orchestrator/RunStatisticsView",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/_usine_orchestrator_RunStatisticsViewEncoded"
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Error Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"404": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"409": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"500": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"502": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
},
"503": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AccessDenied",
"WorkerPreflightRejectedError",
"UpgradeError",
"ConfigurationNotFound",
"ConfigurationStoreError",
"SchemaError",
"InvalidRequestError",
"CrossSiteRequestError",
"RunNotFoundError",
"TranscriptAttemptNotFoundError",
"BoardProjectNotFoundError",
"BoardItemNotFoundError",
"BoardLaneNotFoundError",
"GitHubItemNotFoundError",
"FileChangesNotFoundError",
"PullRequestFilesChangedError",
"RunOperationRejectedError",
"CiNotPassedError",
"RunRetryBlockedError",
"RunInterventionRejectedError",
"LeftoversDiscardRejectedError",
"RosterAgentNotFoundError",
"LoopNotFoundError",
"CycleBudgetResetRejectedError",
"BoardLaneReadOnlyError",
"RestartRequiredError",
"ReloadPreflightError",
"FactoryConfigError",
"EnginePersistenceError",
"AttemptCancellationError",
"HttpBodyError",
"GitHubApiError",
"InvalidGitHubResponseError",
"BackendUnavailableError",
"InstallationDiscoveryError",
"AppPermissionError",
"ProjectNotInstalledError",
"GitHubRateLimitError"
],
"description": "Domain failure tag that selects the HTTP status."
},
"message": {
"type": "string",
"description": "Diagnostic text safe to show to the operator."
}
},
"required": [
"error",
"message"
],
"additionalProperties": false
}
}
}
}
}Check server health
GET /api/health
Operation ID authentication.health · Permission public
Public liveness check with the SQLite reader state; does not require instance setup.
Public endpoint.
Responses
{
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
},
"sqliteReader": {
"type": "string",
"enum": [
"worker",
"fallback",
"respawning"
]
}
},
"required": [
"ok"
],
"additionalProperties": false
}
}
}
},
"403": {
"description": "Forbidden. Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
}
}Read sign-in availability
GET /api/auth/info
Operation ID authentication.info · Permission public
Reports whether GitHub sign-in is configured.
Public endpoint.
Responses
{
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"github": {
"type": "boolean"
}
},
"required": [
"github"
],
"additionalProperties": false
}
}
}
},
"403": {
"description": "Forbidden. Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
}
}Read the current session
GET /api/auth/session
Operation ID authentication.session · Permission session
Returns the signed-in member, effective permissions, the device token's operation ceiling, and the CSRF token. Setup sessions have a null member.
Requires an instance bearer token or browser session.
Responses
{
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"member": {
"anyOf": [
{
"$ref": "#/components/schemas/MemberEncoded"
},
{
"type": "null"
}
]
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PermissionGrantEncoded"
}
},
"operations": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z]+\\.[A-Za-z]+$"
},
"description": "Operation IDs from this document, such as operator.approve, that the token may call. Requests also need the token's scopes."
},
"csrf": {
"type": "string"
}
},
"required": [
"member",
"permissions",
"csrf"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Sign-in or credential operation failed. Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"409": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"429": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"500": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"502": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"503": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
}
}Create a sign-in link
POST /api/auth/link
Operation ID authentication.link · Permission local
Requires the local admin bearer token. Returns a single-use link valid for ten minutes.
Requires an instance bearer token or browser session.
Responses
{
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
},
"required": [
"url"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Sign-in or credential operation failed. Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"409": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"429": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"500": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"502": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"503": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
}
}Consume a sign-in link
POST /api/auth/link/consume
Operation ID authentication.consumeLink · Permission public
Consumes the one-time token and sets browser session and CSRF cookies.
Public endpoint.
Request body
{
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"token": {
"type": "string",
"minLength": 1
}
},
"required": [
"token"
],
"additionalProperties": false
}
}
},
"required": true
}Responses
{
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
},
"bootstrap": {
"type": "boolean"
}
},
"required": [
"ok",
"bootstrap"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"401": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"403": {
"description": "Sign-in or credential operation failed. Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"409": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"429": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"500": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"502": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"503": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
}
}Start GitHub web sign-in
GET /api/auth/github
Operation ID authentication.github · Permission public
Redirects to GitHub and sets a short-lived state cookie. First enrollment requires a setup session.
Public endpoint.
Responses
{
"302": {
"description": "<No Content>"
},
"400": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"401": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"403": {
"description": "Sign-in or credential operation failed. Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"409": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"429": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"500": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"502": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"503": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
}
}Complete GitHub web sign-in
GET /api/auth/callback
Operation ID authentication.callback · Permission public
Verifies state against the browser cookie, sets a session, and redirects to the UI. Failed sign-ins redirect to the sign-in page.
Public endpoint.
| Parameter | Location | Required | Schema |
|---|---|---|---|
state | query | Yes | {"type":"string"} |
code | query | Yes | {"type":"string"} |
Responses
{
"302": {
"description": "<No Content>"
},
"403": {
"description": "Forbidden. Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
}
}Start device sign-in
POST /api/auth/device
Operation ID authentication.device · Permission public
Returns a challenge, GitHub user code, verification URL, and polling interval in seconds.
Public endpoint.
Request body
{
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"required": [
"name"
],
"additionalProperties": false
}
}
},
"required": true
}Responses
{
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"userCode": {
"type": "string"
},
"verificationUri": {
"type": "string"
},
"interval": {
"type": "number"
}
},
"required": [
"id",
"userCode",
"verificationUri",
"interval"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"401": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"403": {
"description": "Sign-in or credential operation failed. Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"409": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"429": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"500": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"502": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"503": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
}
}Poll device sign-in
POST /api/auth/device/poll
Operation ID authentication.pollDevice · Permission public
Returns pending until authorization completes, then returns the instance token once. Honor the polling interval.
Public endpoint.
Request body
{
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
}
},
"required": [
"id"
],
"additionalProperties": false
}
}
},
"required": true
}Responses
{
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"pending": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"pending"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"token": {
"type": "string"
}
},
"required": [
"token"
],
"additionalProperties": false
}
]
}
}
}
},
"400": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"401": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"403": {
"description": "Sign-in or credential operation failed. Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"409": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"429": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"500": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"502": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"503": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
}
}Sign out
POST /api/auth/sign-out
Operation ID authentication.signOut · Permission session
Revokes the current credential and expires browser cookies.
Requires an instance bearer token or browser session.
Responses
{
"200": {
"description": "The request completed successfully.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false,
"description": "The request completed successfully."
}
}
}
},
"400": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Sign-in or credential operation failed. Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"409": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"429": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"500": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"502": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"503": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
}
}List members
GET /api/members
Operation ID authentication.members · Permission admin
Returns enrolled members. Requires a member session or token.
Requires an instance bearer token or browser session.
Responses
{
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberEncoded"
}
}
}
}
},
"400": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Sign-in or credential operation failed. Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"409": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"429": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"500": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"502": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"503": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
}
}Add a member
POST /api/members
Operation ID authentication.addMember · Permission admin
Resolves the GitHub login to a numeric identity and enrolls the member.
Requires an instance bearer token or browser session.
Request body
{
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"login": {
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9-]{0,37}[A-Za-z0-9])?$"
}
},
"required": [
"login"
],
"additionalProperties": false
}
}
},
"required": true
}Responses
{
"200": {
"description": "The request completed successfully.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false,
"description": "The request completed successfully."
}
}
}
},
"400": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Sign-in or credential operation failed. Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"409": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"429": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"500": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"502": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"503": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
}
}Remove a member
DELETE /api/members/{id}
Operation ID authentication.removeMember · Permission admin
Revokes the member credentials and removes membership. The last member cannot be removed.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
id | path | Yes | {"type":"string"} |
Responses
{
"200": {
"description": "The request completed successfully.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false,
"description": "The request completed successfully."
}
}
}
},
"400": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Sign-in or credential operation failed. Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"409": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"429": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"500": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"502": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"503": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
}
}List member tokens
GET /api/tokens
Operation ID authentication.tokens · Permission tokens
Returns the current member devices and browser sessions, excluding expired credentials and token secrets.
Requires an instance bearer token or browser session.
Responses
{
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"createdAt": {
"type": "number"
},
"lastUsedAt": {
"type": "number"
},
"scopes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"permission": {
"type": "string",
"enum": [
"read",
"operate",
"maintain",
"admin"
]
},
"scope": {
"anyOf": [
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Instance"
]
}
},
"required": [
"_tag"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Project"
]
},
"project": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
}
},
"required": [
"_tag",
"project"
],
"additionalProperties": false
}
]
}
},
"required": [
"permission",
"scope"
],
"additionalProperties": false
}
},
"kind": {
"type": "string",
"enum": [
"session",
"device"
]
},
"operations": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z]+\\.[A-Za-z]+$"
},
"description": "Operation IDs from this document, such as operator.approve, that the token may call. Requests also need the token's scopes."
},
"unknownOperations": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z]+\\.[A-Za-z]+$"
},
"description": "The operation IDs of the ceiling that match no operation, such as an ID that a release renamed. The token cannot call them."
},
"expiresAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Epoch milliseconds of expiry, or null for a device token without one."
}
},
"required": [
"id",
"name",
"createdAt",
"lastUsedAt",
"kind",
"expiresAt"
],
"additionalProperties": false
}
}
}
}
},
"400": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Sign-in or credential operation failed. Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"409": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"429": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"500": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"502": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"503": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
}
}Create a scoped token
POST /api/tokens
Operation ID authentication.createToken · Permission tokens
Creates a device token whose scopes are a subset of the caller's effective permissions, with an optional operation ceiling and expiry. The secret is returned once.
Requires an instance bearer token or browser session.
Request body
{
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"scopes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PermissionGrantEncoded"
}
},
"operations": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z]+\\.[A-Za-z]+$"
},
"description": "Operation IDs from this document, such as operator.approve, that the token may call. Requests also need the token's scopes."
},
"expiresAt": {
"type": "number",
"description": "Epoch milliseconds after which the token stops authenticating."
}
},
"required": [
"name",
"scopes"
],
"additionalProperties": false
}
}
},
"required": true
}Responses
{
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"token": {
"type": "string"
}
},
"required": [
"token"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Sign-in or credential operation failed. Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"409": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"429": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"500": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"502": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"503": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
}
}Set token scopes
PUT /api/tokens/{id}/scopes
Operation ID authentication.setScopes · Permission tokens
Sets the scope ceiling and operation ceiling for one of the member's device tokens. Requests also check current role bindings. Browser sessions follow role bindings and reject scope edits.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
id | path | Yes | {"type":"string","minLength":1} |
Request body
{
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"scopes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PermissionGrantEncoded"
}
},
"operations": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z]+\\.[A-Za-z]+$"
},
"description": "Operation IDs from this document, such as operator.approve, that the token may call. Requests also need the token's scopes."
},
{
"type": "null"
}
],
"description": "Replaces the operation ceiling. Null removes it; an absent key keeps the current ceiling."
}
},
"required": [
"scopes"
],
"additionalProperties": false
}
}
},
"required": true
}Responses
{
"200": {
"description": "The request completed successfully.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false,
"description": "The request completed successfully."
}
}
}
},
"400": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Sign-in or credential operation failed. Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"409": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"429": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"500": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"502": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"503": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
}
}Revoke a token
DELETE /api/tokens/{id}
Operation ID authentication.revokeToken · Permission tokens
Revokes a device or browser session belonging to the current member.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
id | path | Yes | {"type":"string","minLength":1} |
Responses
{
"200": {
"description": "The request completed successfully.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false,
"description": "The request completed successfully."
}
}
}
},
"400": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Sign-in or credential operation failed. Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"409": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"429": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"500": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"502": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
},
"503": {
"description": "Sign-in or credential operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Sign-in or credential operation failed."
}
}
}
}
}Read setup progress
GET /api/setup
Operation ID setup.status · Permission setup
Checks App credentials, installation, sign-in, and registry state.
Requires an instance bearer token or browser session.
Responses
{
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"NoApp"
]
}
},
"required": [
"_tag"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"MissingKey"
]
},
"message": {
"type": "string"
}
},
"required": [
"_tag",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"NeedsInstallation"
]
},
"url": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"_tag",
"url",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Repositories"
]
},
"signIn": {
"type": "boolean"
},
"github": {
"type": "boolean"
}
},
"required": [
"_tag",
"signIn",
"github"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Ready"
]
}
},
"required": [
"_tag"
],
"additionalProperties": false
}
]
}
}
}
},
"400": {
"description": "Setup operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Setup operation failed. Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"409": {
"description": "Setup operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
}
}
}
},
"429": {
"description": "Setup operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
}
}
}
},
"500": {
"description": "Setup operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
}
}
}
},
"502": {
"description": "Setup operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
}
}
}
},
"503": {
"description": "Setup operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
}
}
}
}
}Prepare GitHub App creation
POST /api/setup/manifest
Operation ID setup.manifest · Permission setup
Returns a GitHub form action and manifest, and sets a ten-minute state cookie. POST the manifest to the returned action in the same browser.
Requires an instance bearer token or browser session.
Request body
{
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 34
},
"organization": {
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9-]{0,37}[A-Za-z0-9])?$"
}
},
"required": [
"name"
],
"additionalProperties": false
}
}
},
"required": true
}Responses
{
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"action": {
"type": "string"
},
"manifest": {
"type": "string"
}
},
"required": [
"action",
"manifest"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Setup operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Setup operation failed. Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"409": {
"description": "Setup operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
}
}
}
},
"429": {
"description": "Setup operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
}
}
}
},
"500": {
"description": "Setup operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
}
}
}
},
"502": {
"description": "Setup operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
}
}
}
},
"503": {
"description": "Setup operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
}
}
}
}
}Complete GitHub App creation
GET /api/setup/callback
Operation ID setup.callback · Permission public
Verifies the single-use state and browser cookie, exchanges GitHub's code, and saves credentials. Redirects to setup on success or failure.
Public endpoint.
| Parameter | Location | Required | Schema |
|---|---|---|---|
state | query | Yes | {"type":"string"} |
code | query | Yes | {"type":"string"} |
Responses
{
"302": {
"description": "<No Content>"
},
"403": {
"description": "Forbidden. Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
}
}Restore App credentials
POST /api/setup/restore
Operation ID setup.restore · Permission setup
Saves credential JSON with mode 0600 when usable credentials are missing. Accepts legacy App ID and private key files with optional client and webhook fields.
Requires an instance bearer token or browser session.
Request body
{
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"credentials": {
"type": "string",
"minLength": 1
}
},
"required": [
"credentials"
],
"additionalProperties": false
}
}
},
"required": true
}Responses
{
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Setup operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Setup operation failed. Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"409": {
"description": "Setup operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
}
}
}
},
"429": {
"description": "Setup operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
}
}
}
},
"500": {
"description": "Setup operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
}
}
}
},
"502": {
"description": "Setup operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
}
}
}
},
"503": {
"description": "Setup operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
}
}
}
}
}Activate the configured instance
POST /api/setup/activate
Operation ID setup.activate · Permission setup
Starts the runtime with saved credentials. Poll the runtime endpoint before navigating while the HTTP listener restarts.
Requires an instance bearer token or browser session.
Responses
{
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"enum": [
true
]
}
},
"required": [
"ok"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Setup operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Setup operation failed. Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"409": {
"description": "Setup operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
}
}
}
},
"429": {
"description": "Setup operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
}
}
}
},
"500": {
"description": "Setup operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
}
}
}
},
"502": {
"description": "Setup operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
}
}
}
},
"503": {
"description": "Setup operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
}
}
}
}
}Check runtime readiness
GET /api/setup/runtime
Operation ID setup.runtime · Permission setup
Returns true when the instance serves the active runtime.
Requires an instance bearer token or browser session.
Responses
{
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ready": {
"type": "boolean"
}
},
"required": [
"ready"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Setup operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Setup operation failed. Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"409": {
"description": "Setup operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
}
}
}
},
"429": {
"description": "Setup operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
}
}
}
},
"500": {
"description": "Setup operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
}
}
}
},
"502": {
"description": "Setup operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
}
}
}
},
"503": {
"description": "Setup operation failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Setup operation failed."
}
}
}
}
}Read provider connections
GET /api/providers
Operation ID providers.status · Permission setup
Returns credential metadata and pending authorization prompts for configured gateways or local harnesses. Requires instance admin or setup access.
Requires an instance bearer token or browser session.
Responses
{
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"targets": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"target": {
"type": "string"
},
"label": {
"type": "string"
},
"providers": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"anthropic-messages",
"openai-responses"
]
},
"credential": {
"anyOf": [
{
"type": "string",
"enum": [
"api-key",
"subscription"
]
},
{
"type": "null"
}
]
},
"expiresAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastRefresh": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"refreshable": {
"type": "boolean"
}
},
"required": [
"provider",
"credential",
"expiresAt",
"lastRefresh"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"anthropic-messages",
"openai-responses"
]
},
"error": {
"type": "string"
}
},
"required": [
"provider",
"error"
],
"additionalProperties": false
}
]
}
}
},
"required": [
"target",
"label",
"providers"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"target": {
"type": "string"
},
"label": {
"type": "string"
},
"error": {
"type": "string"
}
},
"required": [
"target",
"label",
"error"
],
"additionalProperties": false
}
]
}
},
"logins": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"target": {
"type": "string"
},
"provider": {
"type": "string",
"enum": [
"claude",
"chatgpt"
]
},
"state": {
"anyOf": [
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"starting"
]
}
},
"required": [
"status"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"authorizing"
]
},
"url": {
"type": "string"
},
"code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"status",
"url",
"code"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"connected"
]
}
},
"required": [
"status"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"failed"
]
},
"message": {
"type": "string"
}
},
"required": [
"status",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"cancelled"
]
}
},
"required": [
"status"
],
"additionalProperties": false
}
]
}
},
"required": [
"id",
"target",
"provider",
"state"
],
"additionalProperties": false
}
}
},
"required": [
"targets",
"logins"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Provider connection request failed. Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"409": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
},
"429": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
},
"500": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
},
"502": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
},
"503": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
}
}Start provider sign-in
POST /api/providers/login
Operation ID providers.begin · Permission setup
Starts an isolated native provider login. Poll connection status for its authorization page and device code.
Requires an instance bearer token or browser session.
Request body
{
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"target": {
"type": "string",
"minLength": 1
},
"provider": {
"type": "string",
"enum": [
"claude",
"chatgpt"
]
}
},
"required": [
"target",
"provider"
],
"additionalProperties": false
}
}
},
"required": true
}Responses
{
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"target": {
"type": "string"
},
"provider": {
"type": "string",
"enum": [
"claude",
"chatgpt"
]
},
"state": {
"anyOf": [
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"starting"
]
}
},
"required": [
"status"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"authorizing"
]
},
"url": {
"type": "string"
},
"code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"status",
"url",
"code"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"connected"
]
}
},
"required": [
"status"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"failed"
]
},
"message": {
"type": "string"
}
},
"required": [
"status",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"cancelled"
]
}
},
"required": [
"status"
],
"additionalProperties": false
}
]
}
},
"required": [
"id",
"target",
"provider",
"state"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Provider connection request failed. Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"409": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
},
"429": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
},
"500": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
},
"502": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
},
"503": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
}
}Submit a Claude authorization code
POST /api/providers/code
Operation ID providers.code · Permission setup
Passes the code to the pending Claude login. Completed credentials transfer to the configured destination.
Requires an instance bearer token or browser session.
Request body
{
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"code": {
"type": "string",
"minLength": 1,
"maxLength": 4096,
"pattern": "^[^\\r\\n]+$"
}
},
"required": [
"id",
"code"
],
"additionalProperties": false
}
}
},
"required": true
}Responses
{
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean"
}
},
"required": [
"ok"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Provider connection request failed. Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"409": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
},
"429": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
},
"500": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
},
"502": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
},
"503": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
}
}Cancel provider sign-in
DELETE /api/providers/login/{id}
Operation ID providers.cancel · Permission setup
Stops an unfinished login and preserves the previously saved credential.
Requires an instance bearer token or browser session.
| Parameter | Location | Required | Schema |
|---|---|---|---|
id | path | Yes | {"type":"string"} |
Responses
{
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean"
}
},
"required": [
"ok"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Provider connection request failed. Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"409": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
},
"429": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
},
"500": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
},
"502": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
},
"503": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
}
}Connect a provider API key
PUT /api/providers/key
Operation ID providers.key · Permission setup
Saves an API key on the selected destination and updates gateway worker routing.
Requires an instance bearer token or browser session.
Request body
{
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"target": {
"type": "string",
"minLength": 1
},
"provider": {
"type": "string",
"enum": [
"claude",
"chatgpt"
]
},
"key": {
"type": "string",
"minLength": 1,
"maxLength": 4096,
"pattern": "^[^\\r\\n]+$"
}
},
"required": [
"target",
"provider",
"key"
],
"additionalProperties": false
}
}
},
"required": true
}Responses
{
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean"
}
},
"required": [
"ok"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Provider connection request failed. Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"409": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
},
"429": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
},
"500": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
},
"502": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
},
"503": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
}
}Disconnect a provider
POST /api/providers/disconnect
Operation ID providers.disconnect · Permission setup
Removes the saved credential and gateway worker routing, cancelling any unfinished login for this destination and provider.
Requires an instance bearer token or browser session.
Request body
{
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"target": {
"type": "string",
"minLength": 1
},
"provider": {
"type": "string",
"enum": [
"claude",
"chatgpt"
]
}
},
"required": [
"target",
"provider"
],
"additionalProperties": false
}
}
},
"required": true
}Responses
{
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ok": {
"type": "boolean"
}
},
"required": [
"ok"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
},
"401": {
"description": "A valid instance token or browser session is required.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
},
"403": {
"description": "Provider connection request failed. Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers. Browser session writes require a valid X-Usine-CSRF header.",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
},
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
]
}
}
}
},
"409": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
},
"429": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
},
"500": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
},
"502": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
},
"503": {
"description": "Provider connection request failed.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"AuthenticationError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": false,
"description": "Provider connection request failed."
}
}
}
}
}Read the API schema
GET /api/openapi.json
Operation ID documentation.openapi · Permission public
Public OpenAPI 3.1 document generated from the registered API contracts.
Public endpoint.
Responses
{
"200": {
"description": "OpenAPI 3.1 description of the instance HTTP API.",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "OpenAPI document",
"description": "OpenAPI 3.1 description of the instance HTTP API."
}
}
}
},
"403": {
"description": "Forbidden. Requests with an Origin header require an allowed origin. Unknown origins receive no CORS headers.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"CrossSiteRequestError"
]
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
],
"additionalProperties": true
}
}
}
}
}Schemas
Request and response references resolve to these shared schemas.
PermissionGrantEncoded
{
"type": "object",
"properties": {
"permission": {
"type": "string",
"enum": [
"read",
"operate",
"maintain",
"admin"
]
},
"scope": {
"anyOf": [
{
"$ref": "#/components/schemas/InstanceScopeEncoded"
},
{
"$ref": "#/components/schemas/ProjectScopeEncoded"
}
]
}
},
"required": [
"permission",
"scope"
],
"additionalProperties": false
}ProjectScopeEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Project"
]
},
"project": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
}
},
"required": [
"_tag",
"project"
],
"additionalProperties": false
}InstanceScopeEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Instance"
]
}
},
"required": [
"_tag"
],
"additionalProperties": false
}MemberEncoded
{
"type": "object",
"properties": {
"login": {
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9-]{0,37}[A-Za-z0-9])?$"
},
"id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"addedAt": {
"type": "number"
},
"addedBy": {
"anyOf": [
{
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9-]{0,37}[A-Za-z0-9])?$"
},
{
"type": "string",
"enum": [
"local admin"
]
}
]
}
},
"required": [
"login",
"id",
"addedAt",
"addedBy"
],
"additionalProperties": false
}_usine_orchestrator_RunStatisticsViewEncoded
{
"type": "object",
"properties": {
"window": {
"type": "string",
"enum": [
"7d",
"30d",
"all"
]
},
"from": {
"type": "string"
},
"to": {
"type": "string"
},
"bucket": {
"type": "string",
"enum": [
"day",
"week"
]
},
"runs": {
"$ref": "#/components/schemas/_usine_orchestrator_OutcomeCountsViewEncoded"
},
"runTime": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_DurationSummaryViewEncoded"
},
{
"type": "null"
}
]
},
"attemptTime": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_DurationSummaryViewEncoded"
},
{
"type": "null"
}
]
},
"unmeasuredAttempts": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"throughput": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_ThroughputPeriodViewEncoded"
}
},
"loops": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_LoopStatisticsViewEncoded"
}
},
"agents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_AgentStatisticsViewEncoded"
}
},
"brains": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_BrainStatisticsViewEncoded"
}
},
"queueWait": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_WorkerQueueWaitViewEncoded"
}
},
"attemptsPerRun": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_AttemptCountViewEncoded"
}
},
"utilization": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_WorkerUtilizationViewEncoded"
}
},
"needsAttention": {
"$ref": "#/components/schemas/_usine_orchestrator_NeedsAttentionViewEncoded"
},
"machineStarts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_executor_MachineStartsEncoded"
}
}
},
"required": [
"window",
"from",
"to",
"bucket",
"runs",
"runTime",
"attemptTime",
"unmeasuredAttempts",
"throughput",
"loops",
"agents",
"brains",
"queueWait",
"attemptsPerRun",
"utilization",
"needsAttention",
"machineStarts"
],
"additionalProperties": false
}_usine_executor_MachineStartsEncoded
{
"type": "object",
"properties": {
"worker": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"provider": {
"type": "string",
"enum": [
"hetzner",
"boat",
"boxd"
]
},
"day": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"count": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
}
},
"required": [
"worker",
"provider",
"day",
"count"
],
"additionalProperties": false
}_usine_orchestrator_NeedsAttentionViewEncoded
{
"type": "object",
"properties": {
"approvals": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"failures": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"periods": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_NeedsAttentionPeriodViewEncoded"
}
},
"approvalWait": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_DurationSummaryViewEncoded"
},
{
"type": "null"
}
]
},
"retryWait": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_DurationSummaryViewEncoded"
},
{
"type": "null"
}
]
},
"resolutionWait": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_DurationSummaryViewEncoded"
},
{
"type": "null"
}
]
},
"failureWait": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_DurationSummaryViewEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"approvals",
"failures",
"periods",
"approvalWait",
"retryWait",
"resolutionWait",
"failureWait"
],
"additionalProperties": false
}_usine_orchestrator_DurationSummaryViewEncoded
{
"type": "object",
"properties": {
"count": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"medianMillis": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"count",
"medianMillis"
],
"additionalProperties": false
}_usine_orchestrator_NeedsAttentionPeriodViewEncoded
{
"type": "object",
"properties": {
"start": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"approvals": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"failures": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"start",
"approvals",
"failures"
],
"additionalProperties": false
}_usine_orchestrator_WorkerUtilizationViewEncoded
{
"type": "object",
"properties": {
"worker": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"slots": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"occupiedMillis": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"share": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"required": [
"worker",
"slots",
"occupiedMillis",
"share"
],
"additionalProperties": false
}_usine_orchestrator_AttemptCountViewEncoded
{
"type": "object",
"properties": {
"attempts": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"runs": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"attempts",
"runs"
],
"additionalProperties": false
}_usine_orchestrator_WorkerQueueWaitViewEncoded
{
"type": "object",
"properties": {
"worker": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"wait": {
"$ref": "#/components/schemas/_usine_orchestrator_DurationSummaryViewEncoded"
}
},
"required": [
"worker",
"wait"
],
"additionalProperties": false
}_usine_orchestrator_BrainStatisticsViewEncoded
{
"type": "object",
"properties": {
"brain": {
"$ref": "#/components/schemas/Agent_BrainSpecEncoded"
},
"outcomes": {
"$ref": "#/components/schemas/_usine_orchestrator_OutcomeCountsViewEncoded"
},
"time": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_DurationSummaryViewEncoded"
},
{
"type": "null"
}
]
},
"usage": {
"$ref": "#/components/schemas/_usine_orchestrator_UsageSummaryViewEncoded"
}
},
"required": [
"brain",
"outcomes",
"time",
"usage"
],
"additionalProperties": false
}_usine_orchestrator_UsageSummaryViewEncoded
{
"type": "object",
"properties": {
"measured": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"tokens": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"meanTokens": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"pools": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_PoolTokensViewEncoded"
}
},
"cost": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_CostSummaryViewEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"measured",
"tokens",
"meanTokens",
"pools",
"cost"
],
"additionalProperties": false
}_usine_orchestrator_CostSummaryViewEncoded
{
"type": "object",
"properties": {
"usd": {
"type": "number",
"minimum": 0
},
"meanUsd": {
"type": "number",
"minimum": 0
},
"estimate": {
"type": "boolean"
},
"priced": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
}
},
"required": [
"usd",
"meanUsd",
"estimate",
"priced"
],
"additionalProperties": false
}_usine_orchestrator_PoolTokensViewEncoded
{
"type": "object",
"properties": {
"pool": {
"type": "string",
"enum": [
"apiKeys",
"claudePlan",
"chatgptPlan"
]
},
"tokens": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"pool",
"tokens"
],
"additionalProperties": false
}_usine_orchestrator_OutcomeCountsViewEncoded
{
"type": "object",
"properties": {
"succeeded": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"failed": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"canceled": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"succeeded",
"failed",
"canceled"
],
"additionalProperties": false
}Agent_BrainSpecEncoded
{
"type": "object",
"properties": {
"harness": {
"type": "string",
"pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"
},
"model": {
"type": "string",
"pattern": "\\S"
},
"effort": {
"type": "string",
"enum": [
"off",
"minimal",
"low",
"medium",
"high",
"xhigh",
"max"
]
}
},
"required": [
"harness",
"model",
"effort"
],
"additionalProperties": false
}_usine_orchestrator_AgentStatisticsViewEncoded
{
"type": "object",
"properties": {
"agent": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"outcomes": {
"$ref": "#/components/schemas/_usine_orchestrator_OutcomeCountsViewEncoded"
},
"time": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_DurationSummaryViewEncoded"
},
{
"type": "null"
}
]
},
"usage": {
"$ref": "#/components/schemas/_usine_orchestrator_UsageSummaryViewEncoded"
}
},
"required": [
"agent",
"outcomes",
"time",
"usage"
],
"additionalProperties": false
}_usine_orchestrator_LoopStatisticsViewEncoded
{
"type": "object",
"properties": {
"loop": {
"type": "string",
"minLength": 1
},
"outcomes": {
"$ref": "#/components/schemas/_usine_orchestrator_OutcomeCountsViewEncoded"
},
"time": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_DurationSummaryViewEncoded"
},
{
"type": "null"
}
]
},
"usage": {
"$ref": "#/components/schemas/_usine_orchestrator_UsageSummaryViewEncoded"
}
},
"required": [
"loop",
"outcomes",
"time",
"usage"
],
"additionalProperties": false
}_usine_orchestrator_ThroughputPeriodViewEncoded
{
"type": "object",
"properties": {
"start": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"succeeded": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"failed": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"canceled": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"start",
"succeeded",
"failed",
"canceled"
],
"additionalProperties": false
}_usine_orchestrator_StatisticsViewEncoded
{
"type": "object",
"properties": {
"window": {
"type": "string",
"enum": [
"7d",
"30d",
"all"
]
},
"from": {
"type": "string"
},
"to": {
"type": "string"
},
"bucket": {
"type": "string",
"enum": [
"day",
"week"
]
},
"loops": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_TaskDoneViewEncoded"
}
},
"medianMillis": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"periods": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_TaskPeriodViewEncoded"
}
},
"firstTimeRight": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"memoryKills": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"memoryKillAttempts": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"repeatedMemoryKillAttempts": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"operatorActions": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"time": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_TaskTimeViewEncoded"
},
{
"type": "null"
}
]
},
"tokens": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_TaskTokensViewEncoded"
},
{
"type": "null"
}
]
},
"untimed": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_UntimedTasksViewEncoded"
},
{
"type": "null"
}
]
},
"unmetered": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"agents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_AgentModelsViewEncoded"
}
}
},
"required": [
"window",
"from",
"to",
"bucket",
"loops",
"tasks",
"medianMillis",
"periods",
"firstTimeRight",
"memoryKills",
"memoryKillAttempts",
"repeatedMemoryKillAttempts",
"operatorActions",
"time",
"tokens",
"untimed",
"unmetered",
"agents"
],
"additionalProperties": false
}_usine_orchestrator_AgentModelsViewEncoded
{
"type": "object",
"properties": {
"agent": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"tasks": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"opened": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"models": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_ModelOutcomeViewEncoded"
}
}
},
"required": [
"agent",
"tasks",
"opened",
"models"
],
"additionalProperties": false
}_usine_orchestrator_ModelOutcomeViewEncoded
{
"type": "object",
"properties": {
"harness": {
"type": "string",
"pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"
},
"model": {
"type": "string",
"pattern": "\\S"
},
"tasks": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"mixed": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"firstTimeRight": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"medianRounds": {
"type": "number",
"minimum": 0
},
"medianMillis": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"metered": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"medianTokens": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"cost": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_TaskCostViewEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"harness",
"model",
"tasks",
"mixed",
"firstTimeRight",
"medianRounds",
"medianMillis",
"metered",
"medianTokens",
"cost"
],
"additionalProperties": false
}_usine_orchestrator_TaskCostViewEncoded
{
"type": "object",
"properties": {
"tasks": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"medianUsd": {
"type": "number",
"minimum": 0
},
"estimate": {
"type": "boolean"
}
},
"required": [
"tasks",
"medianUsd",
"estimate"
],
"additionalProperties": false
}_usine_orchestrator_UntimedTasksViewEncoded
{
"type": "object",
"properties": {
"tasks": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
}
},
"required": [
"tasks",
"before"
],
"additionalProperties": false
}_usine_orchestrator_TaskTokensViewEncoded
{
"type": "object",
"properties": {
"tasks": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"medianTokens": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"loops": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_LoopShareViewEncoded"
}
},
"cost": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_TaskCostViewEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"tasks",
"medianTokens",
"loops",
"cost"
],
"additionalProperties": false
}_usine_orchestrator_LoopShareViewEncoded
{
"type": "object",
"properties": {
"loop": {
"type": "string",
"minLength": 1
},
"share": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"required": [
"loop",
"share"
],
"additionalProperties": false
}_usine_orchestrator_TaskTimeViewEncoded
{
"type": "object",
"properties": {
"tasks": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"loops": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_LoopShareViewEncoded"
}
},
"waiting": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"runs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_LoopRunTimeViewEncoded"
}
}
},
"required": [
"tasks",
"loops",
"waiting",
"runs"
],
"additionalProperties": false
}_usine_orchestrator_LoopRunTimeViewEncoded
{
"type": "object",
"properties": {
"loop": {
"type": "string",
"minLength": 1
},
"runs": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"medianMillis": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"loop",
"runs",
"medianMillis"
],
"additionalProperties": false
}_usine_orchestrator_TaskPeriodViewEncoded
{
"type": "object",
"properties": {
"start": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"tasks": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"medianMillis": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"firstTimeRight": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"operatorActions": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"start",
"tasks",
"medianMillis",
"firstTimeRight",
"operatorActions"
],
"additionalProperties": false
}_usine_orchestrator_TaskDoneViewEncoded
{
"type": "object",
"properties": {
"repository": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
},
"number": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"mergedAt": {
"type": "string"
},
"durationMillis": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"repository",
"number",
"mergedAt",
"durationMillis"
],
"additionalProperties": false
}_usine_orchestrator_DeskViewEncoded
{
"type": "object",
"properties": {
"running": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_RunningAttemptViewEncoded"
}
},
"notMoving": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_StalledItemViewEncoded"
}
},
"lastOutcomes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_ClosedRunViewEncoded"
}
},
"workers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_WorkerViewEncoded"
}
},
"polls": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_RepositoryPollViewEncoded"
}
}
},
"required": [
"running",
"notMoving",
"lastOutcomes",
"workers",
"polls"
],
"additionalProperties": false
}_usine_orchestrator_RepositoryPollViewEncoded
{
"type": "object",
"properties": {
"repository": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
},
"polledAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"repository",
"polledAt"
],
"additionalProperties": false
}_usine_orchestrator_WorkerViewEncoded
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"slots": {
"$ref": "#/components/schemas/_usine_orchestrator_WorkerSlotsViewEncoded"
},
"paused": {
"type": "boolean"
},
"upgradeWait": {
"anyOf": [
{
"type": "object",
"properties": {
"target": {
"type": "string",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-(?:0|[1-9]\\d*|\\d*[A-Za-z-][0-9A-Za-z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[A-Za-z-][0-9A-Za-z-]*))*)?(?:\\+[0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*)?$"
},
"since": {
"type": "string"
}
},
"required": [
"target",
"since"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"preflight": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_PassedCheckViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_DegradedCheckViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_DeferredCheckViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_FailedCheckViewEncoded"
},
{
"type": "null"
}
]
},
"machines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_MachineViewEncoded"
}
},
"provisioning": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_ProvisioningPauseViewEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"name",
"slots",
"preflight",
"machines",
"provisioning"
],
"additionalProperties": false
}_usine_orchestrator_ProvisioningPauseViewEncoded
{
"type": "object",
"properties": {
"reason": {
"type": "string",
"enum": [
"capacity",
"quota",
"refused",
"provider",
"unreachable",
"timeout",
"check"
]
},
"message": {
"type": "string"
},
"failures": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"failedAt": {
"type": "string"
},
"retryAt": {
"type": "string"
},
"blocked": {
"type": "boolean"
}
},
"required": [
"reason",
"message",
"failures",
"failedAt",
"retryAt",
"blocked"
],
"additionalProperties": false
}_usine_orchestrator_MachineViewEncoded
{
"type": "object",
"properties": {
"worker": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"provider": {
"type": "string",
"enum": [
"hetzner",
"boat",
"boxd"
]
},
"state": {
"type": "string",
"enum": [
"creating",
"preparing",
"ready",
"idle",
"deleting"
]
},
"id": {
"anyOf": [
{
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$"
},
{
"type": "null"
}
]
},
"runId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"attemptId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"since": {
"type": "string"
},
"attempts": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"worker",
"provider",
"state",
"id",
"runId",
"attemptId",
"since",
"attempts"
],
"additionalProperties": false
}_usine_orchestrator_FailedCheckViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Failed"
]
},
"checkedAt": {
"type": "string"
},
"capability": {
"anyOf": [
{
"type": "string",
"enum": [
"machine",
"toolchain",
"memory",
"disk",
"harness-login",
"credentials",
"gateway",
"container",
"provider"
]
},
{
"type": "null"
}
]
},
"message": {
"type": "string"
}
},
"required": [
"_tag",
"checkedAt",
"capability",
"message"
],
"additionalProperties": false
}_usine_orchestrator_DeferredCheckViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Deferred"
]
},
"checkedAt": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"_tag",
"checkedAt",
"message"
],
"additionalProperties": false
}_usine_orchestrator_DegradedCheckViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Degraded"
]
},
"checkedAt": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"_tag",
"checkedAt",
"message"
],
"additionalProperties": false
}_usine_orchestrator_PassedCheckViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Passed"
]
},
"checkedAt": {
"type": "string"
}
},
"required": [
"_tag",
"checkedAt"
],
"additionalProperties": false
}_usine_orchestrator_WorkerSlotsViewEncoded
{
"type": "object",
"properties": {
"capacity": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"leased": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"capacity",
"leased"
],
"additionalProperties": false
}_usine_orchestrator_ClosedRunViewEncoded
{
"type": "object",
"properties": {
"run": {
"$ref": "#/components/schemas/_usine_orchestrator_RunSummaryViewEncoded"
},
"item": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_BoardItemLinkEncoded"
},
{
"type": "null"
}
]
},
"closedAt": {
"type": "string"
}
},
"required": [
"run",
"item",
"closedAt"
],
"additionalProperties": false
}_usine_orchestrator_BoardItemLinkEncoded
{
"type": "object",
"properties": {
"itemKey": {
"type": "string",
"minLength": 1
},
"kind": {
"type": "string",
"enum": [
"issue",
"pr"
]
},
"number": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"title": {
"type": "string"
},
"url": {
"type": "string",
"minLength": 1
},
"state": {
"type": "string",
"enum": [
"issue-open",
"issue-closed",
"pr-open",
"pr-closed",
"pr-merged"
]
},
"labels": {
"type": "array",
"items": {
"type": "string",
"pattern": "^\\S(?:.*\\S)?$",
"maxLength": 50
}
},
"conflicting": {
"type": "boolean"
}
},
"required": [
"itemKey",
"kind",
"number",
"title",
"url",
"state",
"labels",
"conflicting"
],
"additionalProperties": false
}_usine_orchestrator_RunSummaryViewEncoded
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"itemKey": {
"type": "string",
"minLength": 1
},
"loop": {
"type": "string",
"minLength": 1
},
"repository": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
},
"agent": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"agentBrain": {
"$ref": "#/components/schemas/Agent_BrainSpecEncoded"
},
"state": {
"type": "string",
"enum": [
"Pending",
"Waiting",
"Queued",
"Running",
"AwaitingCi",
"Succeeded",
"HandedOff",
"Failed",
"Canceled"
]
},
"ciWait": {
"anyOf": [
{
"type": "object",
"properties": {
"pullRequest": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"head": {
"type": "string",
"pattern": "^[0-9a-f]{40}(?:[0-9a-f]{24})?$"
},
"fixLoop": {
"type": "string",
"minLength": 1
},
"timeoutSeconds": {
"type": "integer",
"maximum": 86400,
"exclusiveMinimum": 0
},
"onGreen": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"add": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"uniqueItems": true
},
"remove": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"uniqueItems": true
}
},
"required": [
"item",
"add",
"remove"
],
"additionalProperties": false
}
}
},
"required": [
"pullRequest",
"head",
"fixLoop",
"timeoutSeconds",
"onGreen"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"handoff": {
"anyOf": [
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"HandedOff"
]
},
"reason": {
"type": "string",
"minLength": 1
},
"head": {
"type": "string",
"pattern": "^[0-9a-f]{40}(?:[0-9a-f]{24})?$"
},
"fixLoop": {
"type": "string",
"minLength": 1
},
"fixRunId": {
"type": "string",
"minLength": 1
}
},
"required": [
"_tag",
"reason",
"head",
"fixLoop",
"fixRunId"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"upgradeWait": {
"anyOf": [
{
"type": "object",
"properties": {
"target": {
"type": "string",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-(?:0|[1-9]\\d*|\\d*[A-Za-z-][0-9A-Za-z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[A-Za-z-][0-9A-Za-z-]*))*)?(?:\\+[0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*)?$"
},
"since": {
"type": "string"
}
},
"required": [
"target",
"since"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"providerRetry": {
"anyOf": [
{
"type": "object",
"properties": {
"nextAttempt": {
"type": "integer",
"minimum": 2,
"maximum": 9007199254740991
},
"retryAt": {
"type": "string"
},
"message": {
"type": "string",
"minLength": 1
}
},
"required": [
"nextAttempt",
"retryAt",
"message"
],
"propertyNames": {
"anyOf": [
{
"enum": [
"nextAttempt",
"retryAt",
"message"
]
},
{
"type": "string"
}
]
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"machineWait": {
"anyOf": [
{
"type": "object",
"properties": {
"worker": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"message": {
"type": "string"
}
},
"required": [
"worker",
"message"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"loopPaused": {
"type": "boolean"
},
"openedAt": {
"type": "string"
},
"closedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"approval": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_ApprovalViewEncoded"
},
{
"type": "null"
}
]
},
"approvalReason": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"runAgain": {
"anyOf": [
{
"$ref": "#/components/schemas/RunAgainEncoded"
},
{
"type": "null"
}
]
},
"pullRequestUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"canApprove": {
"type": "boolean"
},
"canRetry": {
"type": "boolean"
},
"canResolveFailure": {
"type": "boolean"
},
"canApplyCiLabels": {
"type": "boolean"
},
"canCancel": {
"type": "boolean"
},
"canRunAgain": {
"type": "boolean"
},
"attempts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_AttemptSummaryViewEncoded"
}
}
},
"required": [
"id",
"itemKey",
"loop",
"repository",
"agent",
"agentBrain",
"state",
"loopPaused",
"openedAt",
"closedAt",
"approval",
"runAgain",
"pullRequestUrl",
"canApprove",
"canRetry",
"canResolveFailure",
"canCancel",
"canRunAgain",
"attempts"
],
"additionalProperties": false
}_usine_orchestrator_AttemptSummaryViewEncoded
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"number": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"worker": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"workerAccess": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_LocalWorkerAccessEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_SshWorkerAccessEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ProvisionedWorkerAccessEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_SandboxWorkerAccessEncoded"
},
{
"type": "null"
}
]
},
"brain": {
"$ref": "#/components/schemas/Agent_BrainSpecEncoded"
},
"agent": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"operatorIntervened": {
"type": "boolean"
},
"startedAt": {
"type": "string"
},
"outcome": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_SucceededAttemptViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_AwaitingCiAttemptViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_HandedOffAttemptViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_FailedAttemptViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_CanceledAttemptViewEncoded"
},
{
"type": "null"
}
]
},
"endedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"salvage": {
"anyOf": [
{
"$ref": "#/components/schemas/AttemptSalvage_PushedEncoded"
},
{
"$ref": "#/components/schemas/AttemptSalvage_PartlyPushedEncoded"
},
{
"$ref": "#/components/schemas/AttemptSalvage_RetainedEncoded"
},
{
"$ref": "#/components/schemas/AttemptSalvage_RejectedEncoded"
},
{
"type": "null"
}
]
},
"start": {
"anyOf": [
{
"$ref": "#/components/schemas/AttemptStart_EventEncoded"
},
{
"$ref": "#/components/schemas/AttemptStart_RetryEncoded"
},
{
"$ref": "#/components/schemas/AttemptStart_EditAndRetryEncoded"
},
{
"$ref": "#/components/schemas/AttemptStart_InfraRetryEncoded"
},
{
"$ref": "#/components/schemas/AttemptStart_ProviderRetryEncoded"
},
{
"$ref": "#/components/schemas/AttemptStart_AfterRestartEncoded"
},
{
"type": "null"
}
]
},
"reattachedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"outOfMemory": {
"anyOf": [
{
"$ref": "#/components/schemas/OutOfMemoryKillsEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"number",
"worker",
"workerAccess",
"brain",
"agent",
"operatorIntervened",
"startedAt",
"outcome",
"endedAt",
"salvage",
"start",
"reattachedAt",
"outOfMemory"
],
"additionalProperties": false
}OutOfMemoryKillsEncoded
{
"type": "object",
"properties": {
"kills": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"memoryMib": {
"type": "integer",
"minimum": 256,
"maximum": 9007199254740991
},
"processes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"command": {
"type": "string",
"minLength": 1
},
"pid": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
}
},
"required": [
"command",
"pid"
],
"additionalProperties": false
}
}
},
"required": [
"kills",
"memoryMib"
],
"additionalProperties": false
}AttemptStart_AfterRestartEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"AfterRestart"
]
}
},
"required": [
"_tag"
],
"additionalProperties": false
}AttemptStart_ProviderRetryEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"ProviderRetry"
]
}
},
"required": [
"_tag"
],
"additionalProperties": false
}AttemptStart_InfraRetryEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"InfraRetry"
]
}
},
"required": [
"_tag"
],
"additionalProperties": false
}AttemptStart_EditAndRetryEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"EditAndRetry"
]
},
"operator": {
"anyOf": [
{
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9-]{0,37}[A-Za-z0-9])?$"
},
{
"type": "string",
"enum": [
"local admin"
]
},
{
"type": "null"
}
]
}
},
"required": [
"_tag",
"operator"
],
"additionalProperties": false
}AttemptStart_RetryEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"OperatorRetry"
]
},
"operator": {
"anyOf": [
{
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9-]{0,37}[A-Za-z0-9])?$"
},
{
"type": "string",
"enum": [
"local admin"
]
},
{
"type": "null"
}
]
}
},
"required": [
"_tag",
"operator"
],
"additionalProperties": false
}AttemptStart_EventEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Event"
]
}
},
"required": [
"_tag"
],
"additionalProperties": false
}AttemptSalvage_RejectedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Rejected"
]
},
"path": {
"type": "string",
"minLength": 1
},
"commit": {
"type": "string",
"pattern": "^[0-9a-f]{40}(?:[0-9a-f]{24})?$"
},
"message": {
"type": "string"
}
},
"required": [
"_tag",
"path",
"commit",
"message"
],
"additionalProperties": false
}AttemptSalvage_RetainedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Retained"
]
},
"path": {
"type": "string",
"minLength": 1
},
"commit": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9a-f]{40}(?:[0-9a-f]{24})?$"
},
{
"type": "null"
}
]
},
"message": {
"type": "string"
},
"pushFailure": {
"anyOf": [
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"GitHubPushFailure"
]
},
"repository": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
},
"ref": {
"type": "string",
"minLength": 1
},
"message": {
"type": "string"
}
},
"required": [
"_tag",
"repository",
"ref",
"message"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"_tag",
"path",
"commit",
"message"
],
"additionalProperties": false
}AttemptSalvage_PartlyPushedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"PartlyPushed"
]
},
"ref": {
"type": "string",
"minLength": 1
},
"commit": {
"type": "string",
"pattern": "^[0-9a-f]{40}(?:[0-9a-f]{24})?$"
},
"path": {
"type": "string",
"minLength": 1
},
"message": {
"type": "string"
}
},
"required": [
"_tag",
"ref",
"commit",
"path",
"message"
],
"additionalProperties": false
}AttemptSalvage_PushedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Pushed"
]
},
"ref": {
"type": "string",
"minLength": 1
},
"commit": {
"type": "string",
"pattern": "^[0-9a-f]{40}(?:[0-9a-f]{24})?$"
}
},
"required": [
"_tag",
"ref",
"commit"
],
"additionalProperties": false
}_usine_orchestrator_CanceledAttemptViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Canceled"
]
}
},
"required": [
"_tag"
],
"additionalProperties": false
}_usine_orchestrator_FailedAttemptViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Failed"
]
},
"failure": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_GitHubPushFailureViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_InfraFailureViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ProviderCapacityFailureViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_DefectFailureViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_AgentFailureViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_BlockedFailureViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_QuestionFailureViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_RunawayFailureViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ChildSessionBudgetFailureViewEncoded"
}
]
},
"report": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"_tag",
"failure",
"report"
],
"additionalProperties": false
}_usine_orchestrator_ChildSessionBudgetFailureViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"ChildSessionBudgetFailure"
]
},
"maxChildren": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"attemptedChildren": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
}
},
"required": [
"_tag",
"maxChildren",
"attemptedChildren"
],
"additionalProperties": false
}_usine_orchestrator_RunawayFailureViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"RunawayFailure"
]
},
"ceiling": {
"type": "string",
"enum": [
"wall-clock",
"tokens"
]
}
},
"required": [
"_tag",
"ceiling"
],
"additionalProperties": false
}_usine_orchestrator_QuestionFailureViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"QuestionFailure"
]
},
"question": {
"type": "string"
}
},
"required": [
"_tag",
"question"
],
"additionalProperties": false
}_usine_orchestrator_BlockedFailureViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"BlockedFailure"
]
},
"message": {
"type": "string"
}
},
"required": [
"_tag",
"message"
],
"additionalProperties": false
}_usine_orchestrator_AgentFailureViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"AgentFailure"
]
},
"message": {
"type": "string"
}
},
"required": [
"_tag",
"message"
],
"additionalProperties": false
}_usine_orchestrator_DefectFailureViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"DefectFailure"
]
},
"message": {
"type": "string"
}
},
"required": [
"_tag",
"message"
],
"additionalProperties": false
}_usine_orchestrator_ProviderCapacityFailureViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"ProviderCapacityFailure"
]
},
"message": {
"type": "string"
}
},
"required": [
"_tag",
"message"
],
"additionalProperties": false
}_usine_orchestrator_InfraFailureViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"InfraFailure"
]
},
"message": {
"type": "string"
}
},
"required": [
"_tag",
"message"
],
"additionalProperties": false
}_usine_orchestrator_GitHubPushFailureViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"GitHubPushFailure"
]
},
"message": {
"type": "string"
}
},
"required": [
"_tag",
"message"
],
"additionalProperties": false
}_usine_orchestrator_HandedOffAttemptViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"HandedOff"
]
}
},
"required": [
"_tag"
],
"additionalProperties": false
}_usine_orchestrator_AwaitingCiAttemptViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"AwaitingCi"
]
}
},
"required": [
"_tag"
],
"additionalProperties": false
}_usine_orchestrator_SucceededAttemptViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Succeeded"
]
}
},
"required": [
"_tag"
],
"additionalProperties": false
}_usine_orchestrator_SandboxWorkerAccessEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Sandbox"
]
}
},
"required": [
"_tag"
],
"additionalProperties": false
}_usine_orchestrator_ProvisionedWorkerAccessEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Provisioned"
]
},
"provider": {
"type": "string",
"enum": [
"hetzner",
"boat",
"boxd"
]
}
},
"required": [
"_tag",
"provider"
],
"additionalProperties": false
}_usine_orchestrator_SshWorkerAccessEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Ssh"
]
},
"destination": {
"type": "string",
"pattern": "^(?:[A-Za-z0-9._-]+@)?(?:[A-Za-z0-9](?:[A-Za-z0-9.-]*[A-Za-z0-9])?|[0-9A-Fa-f]{0,4}(?::[0-9A-Fa-f]{0,4}){2,7})$"
},
"port": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 65535
},
{
"type": "null"
}
]
}
},
"required": [
"_tag",
"destination",
"port"
],
"additionalProperties": false
}_usine_orchestrator_LocalWorkerAccessEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Local"
]
}
},
"required": [
"_tag"
],
"additionalProperties": false
}RunAgainEncoded
{
"type": "object",
"properties": {
"from": {
"type": "string",
"minLength": 1
},
"requestedBy": {
"anyOf": [
{
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9-]{0,37}[A-Za-z0-9])?$"
},
{
"type": "string",
"enum": [
"local admin"
]
},
{
"type": "null"
}
]
}
},
"required": [
"from",
"requestedBy"
],
"propertyNames": {
"anyOf": [
{
"enum": [
"from",
"requestedBy"
]
},
{
"type": "string"
}
]
},
"additionalProperties": false
}_usine_orchestrator_ApprovalViewEncoded
{
"type": "object",
"properties": {
"approvedAt": {
"type": "string"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/ApprovalSourceEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"approvedAt",
"source"
],
"additionalProperties": false
}ApprovalSourceEncoded
{
"type": "object",
"properties": {
"channel": {
"anyOf": [
{
"type": "string",
"enum": [
"ui"
]
}
]
},
"approver": {
"anyOf": [
{
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9-]{0,37}[A-Za-z0-9])?$"
},
{
"type": "string",
"enum": [
"local admin"
]
},
{
"type": "null"
}
]
}
},
"required": [
"channel",
"approver"
],
"propertyNames": {
"anyOf": [
{
"enum": [
"channel",
"approver"
]
},
{
"type": "string"
}
]
},
"additionalProperties": false
}_usine_orchestrator_StalledItemViewEncoded
{
"type": "object",
"properties": {
"repository": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
},
"loop": {
"type": "string",
"minLength": 1
},
"item": {
"$ref": "#/components/schemas/_usine_orchestrator_BoardItemLinkEncoded"
},
"reason": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_WaitingForUpgradeViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_AwaitingApprovalViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_SuppressedForOperatorViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_CycleBudgetUsedUpViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_RunFailedViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ClosedUnchangedViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_LoopPausedViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_WaitingForStopViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_QueuedForWorkerViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_AwaitingPollViewEncoded"
}
]
}
},
"required": [
"repository",
"loop",
"item",
"reason"
],
"additionalProperties": false
}_usine_orchestrator_AwaitingPollViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"AwaitingPoll"
]
}
},
"required": [
"_tag"
],
"additionalProperties": false
}_usine_orchestrator_QueuedForWorkerViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"QueuedForWorker"
]
},
"run": {
"$ref": "#/components/schemas/_usine_orchestrator_RunSummaryViewEncoded"
},
"ahead": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"priority": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"creating": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_MachineViewEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"_tag",
"run",
"ahead",
"priority",
"creating"
],
"additionalProperties": false
}_usine_orchestrator_WaitingForStopViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"WaitingForStop"
]
},
"run": {
"$ref": "#/components/schemas/_usine_orchestrator_RunSummaryViewEncoded"
},
"stop": {
"$ref": "#/components/schemas/_usine_orchestrator_UnconfirmedStopViewEncoded"
}
},
"required": [
"_tag",
"run",
"stop"
],
"additionalProperties": false
}_usine_orchestrator_UnconfirmedStopViewEncoded
{
"type": "object",
"properties": {
"runId": {
"type": "string",
"minLength": 1
},
"attemptNumber": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"worker": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
}
},
"required": [
"runId",
"attemptNumber",
"worker"
],
"additionalProperties": false
}_usine_orchestrator_LoopPausedViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"LoopPaused"
]
}
},
"required": [
"_tag"
],
"additionalProperties": false
}_usine_orchestrator_ClosedUnchangedViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"ClosedUnchanged"
]
},
"run": {
"$ref": "#/components/schemas/_usine_orchestrator_RunSummaryViewEncoded"
}
},
"required": [
"_tag",
"run"
],
"additionalProperties": false
}_usine_orchestrator_RunFailedViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"RunFailed"
]
},
"run": {
"$ref": "#/components/schemas/_usine_orchestrator_RunSummaryViewEncoded"
}
},
"required": [
"_tag",
"run"
],
"additionalProperties": false
}_usine_orchestrator_CycleBudgetUsedUpViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"CycleBudgetUsedUp"
]
},
"ask": {
"$ref": "#/components/schemas/CycleBudgetAskEncoded"
}
},
"required": [
"_tag",
"ask"
],
"additionalProperties": false
}CycleBudgetAskEncoded
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"itemKey": {
"type": "string",
"minLength": 1
},
"repository": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
},
"loop": {
"type": "string",
"minLength": 1
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"counts": {
"type": "array",
"prefixItems": [
{
"$ref": "#/components/schemas/LoopCycleCountEncoded"
}
],
"minItems": 1,
"items": {
"$ref": "#/components/schemas/LoopCycleCountEncoded"
}
},
"blocks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"loop": {
"type": "string",
"minLength": 1
},
"eventId": {
"type": "string",
"minLength": 1
}
},
"required": [
"loop",
"eventId"
],
"propertyNames": {
"anyOf": [
{
"enum": [
"loop",
"eventId"
]
},
{
"type": "string"
}
]
},
"additionalProperties": false
}
}
},
"required": [
"id",
"itemKey",
"repository",
"loop",
"limit",
"counts"
],
"propertyNames": {
"anyOf": [
{
"enum": [
"id",
"itemKey",
"repository",
"loop",
"limit",
"counts",
"blocks"
]
},
{
"type": "string"
}
]
},
"additionalProperties": false
}LoopCycleCountEncoded
{
"type": "object",
"properties": {
"loop": {
"type": "string",
"minLength": 1
},
"admitted": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"completed": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"loop",
"admitted",
"completed"
],
"propertyNames": {
"anyOf": [
{
"enum": [
"loop",
"admitted",
"completed"
]
},
{
"type": "string"
}
]
},
"additionalProperties": false
}_usine_orchestrator_SuppressedForOperatorViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"SuppressedForOperator"
]
},
"run": {
"$ref": "#/components/schemas/_usine_orchestrator_RunSummaryViewEncoded"
}
},
"required": [
"_tag",
"run"
],
"additionalProperties": false
}_usine_orchestrator_AwaitingApprovalViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"AwaitingApproval"
]
},
"run": {
"$ref": "#/components/schemas/_usine_orchestrator_RunSummaryViewEncoded"
}
},
"required": [
"_tag",
"run"
],
"additionalProperties": false
}_usine_orchestrator_WaitingForUpgradeViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"WaitingForUpgrade"
]
},
"run": {
"$ref": "#/components/schemas/_usine_orchestrator_RunSummaryViewEncoded"
},
"wait": {
"$ref": "#/components/schemas/_usine_engine_UpgradeWaitEncoded"
}
},
"required": [
"_tag",
"run",
"wait"
],
"additionalProperties": false
}_usine_engine_UpgradeWaitEncoded
{
"type": "object",
"properties": {
"target": {
"type": "string",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-(?:0|[1-9]\\d*|\\d*[A-Za-z-][0-9A-Za-z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[A-Za-z-][0-9A-Za-z-]*))*)?(?:\\+[0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*)?$"
},
"since": {
"type": "string"
}
},
"required": [
"target",
"since"
],
"additionalProperties": false
}_usine_orchestrator_RunningAttemptViewEncoded
{
"type": "object",
"properties": {
"run": {
"$ref": "#/components/schemas/_usine_orchestrator_RunSummaryViewEncoded"
},
"attempt": {
"$ref": "#/components/schemas/_usine_orchestrator_AttemptSummaryViewEncoded"
},
"item": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_BoardItemLinkEncoded"
},
{
"type": "null"
}
]
},
"lastActivityAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"warnings": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_WorkerSilentViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ProviderRetryingViewEncoded"
}
]
}
}
},
"required": [
"run",
"attempt",
"item",
"lastActivityAt",
"warnings"
],
"additionalProperties": false
}_usine_orchestrator_ProviderRetryingViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"ProviderRetrying"
]
},
"agent": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"message": {
"type": "string",
"minLength": 1
},
"retries": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"since": {
"type": "string"
}
},
"required": [
"_tag",
"agent",
"message",
"retries",
"since"
],
"additionalProperties": false
}_usine_orchestrator_WorkerSilentViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"WorkerSilent"
]
},
"worker": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"lastAnsweredAt": {
"type": "string"
}
},
"required": [
"_tag",
"worker",
"lastAnsweredAt"
],
"additionalProperties": false
}_usine_orchestrator_ConfigurationViewEncoded
{
"type": "object",
"properties": {
"projects": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"name": {
"type": "string",
"pattern": "\\S"
},
"repositories": {
"type": "array",
"prefixItems": [
{
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
}
],
"minItems": 1,
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
}
},
"lanes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "\\S"
},
"sources": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"label": {
"type": "string",
"pattern": "^\\S(?:.*\\S)?$",
"maxLength": 50
}
},
"required": [
"label"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"issue-open",
"issue-closed",
"pr-open",
"pr-closed",
"pr-merged"
]
}
},
"required": [
"state"
],
"additionalProperties": false
}
]
},
"minItems": 1
}
},
"required": [
"name",
"sources"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"name",
"repositories"
],
"additionalProperties": false
}
},
"bindings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"member": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"role": {
"type": "string",
"enum": [
"admin",
"viewer",
"operator",
"maintainer"
]
},
"scope": {
"anyOf": [
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Instance"
]
}
},
"required": [
"_tag"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Project"
]
},
"project": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
}
},
"required": [
"_tag",
"project"
],
"additionalProperties": false
}
]
}
},
"required": [
"name",
"member",
"role",
"scope"
],
"additionalProperties": false
}
},
"labels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_config_DeclaredLabelEncoded"
}
},
"loops": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_LoopFileViewEncoded"
}
},
"quarantinedLoops": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_QuarantinedLoopViewEncoded"
}
},
"agents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_AgentFileViewEncoded"
}
},
"invalidAgents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_InvalidAgentViewEncoded"
}
},
"workers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_WorkerConfigurationViewEncoded"
}
},
"removedWorkers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_RemovedWorkerViewEncoded"
}
},
"repositories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_RepositoryConfigurationViewEncoded"
}
},
"settings": {
"$ref": "#/components/schemas/_usine_orchestrator_SettingsViewEncoded"
}
},
"required": [
"labels",
"loops",
"quarantinedLoops",
"agents",
"invalidAgents",
"workers",
"removedWorkers",
"repositories",
"settings"
],
"additionalProperties": false
}_usine_orchestrator_SettingsViewEncoded
{
"type": "object",
"properties": {
"pollInterval": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxChildren": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"maxAttemptMinutes": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"maxAttemptTokens": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"maxBackgroundWaitMinutes": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"parentModel": {
"anyOf": [
{
"type": "string",
"pattern": "\\S"
},
{
"type": "null"
}
]
},
"parentEffort": {
"anyOf": [
{
"type": "string",
"enum": [
"off",
"minimal",
"low",
"medium",
"high",
"xhigh",
"max"
]
},
{
"type": "null"
}
]
},
"coordinator": {
"type": "string",
"enum": [
"session",
"events"
]
},
"supervisor": {
"anyOf": [
{
"type": "object",
"properties": {
"harness": {
"type": "string",
"pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"
},
"model": {
"type": "string",
"pattern": "\\S"
},
"effort": {
"type": "string",
"enum": [
"off",
"minimal",
"low",
"medium",
"high",
"xhigh",
"max"
]
},
"ownTools": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"unavailable": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
}
},
"required": [
"harness",
"model",
"effort",
"ownTools",
"unavailable"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"operator": {
"anyOf": [
{
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9-]{0,37}[A-Za-z0-9])?$"
},
{
"type": "null"
}
]
},
"webhooks": {
"type": "string",
"enum": [
"off",
"deliveries",
"endpoint"
]
},
"webhooksPublicUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastHintAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tracing": {
"anyOf": [
{
"type": "object",
"properties": {
"otlpUrl": {
"type": "string"
},
"serviceName": {
"type": "string"
}
},
"required": [
"otlpUrl",
"serviceName"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"pollInterval",
"maxChildren",
"maxAttemptMinutes",
"maxAttemptTokens",
"maxBackgroundWaitMinutes",
"parentModel",
"parentEffort",
"coordinator",
"supervisor",
"operator",
"webhooks",
"webhooksPublicUrl",
"lastHintAt",
"tracing"
],
"additionalProperties": false
}_usine_orchestrator_RepositoryConfigurationViewEncoded
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
},
"tags": {
"type": "array",
"items": {
"type": "string",
"pattern": "\\S"
}
},
"lanes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_LaneConfigurationViewEncoded"
}
},
"declaredLabels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_LabelStateViewEncoded"
}
},
"loops": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
}
},
"required": [
"name",
"tags",
"lanes",
"declaredLabels",
"loops"
],
"additionalProperties": false
}_usine_orchestrator_LabelStateViewEncoded
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^\\S(?:.*\\S)?$",
"maxLength": 50
},
"onGitHub": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"declared": {
"type": "boolean"
},
"failure": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_LabelPreflightFindingEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"name",
"onGitHub",
"color",
"description",
"declared",
"failure"
],
"additionalProperties": false
}_usine_orchestrator_LabelPreflightFindingEncoded
{
"type": "object",
"properties": {
"repository": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
},
"label": {
"type": "string",
"pattern": "^\\S(?:.*\\S)?$",
"maxLength": 50
},
"errorTag": {
"type": "string",
"minLength": 1
},
"message": {
"type": "string",
"minLength": 1
}
},
"required": [
"repository",
"label",
"errorTag",
"message"
],
"additionalProperties": false
}_usine_orchestrator_LaneConfigurationViewEncoded
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "\\S"
},
"sources": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_LabelLaneSourceViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_StateLaneSourceViewEncoded"
}
]
}
}
},
"required": [
"name",
"sources"
],
"additionalProperties": false
}_usine_orchestrator_StateLaneSourceViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"State"
]
},
"state": {
"type": "string",
"enum": [
"issue-open",
"issue-closed",
"pr-open",
"pr-closed",
"pr-merged"
]
}
},
"required": [
"_tag",
"state"
],
"additionalProperties": false
}_usine_orchestrator_LabelLaneSourceViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Label"
]
},
"label": {
"$ref": "#/components/schemas/_usine_orchestrator_LabelStateViewEncoded"
}
},
"required": [
"_tag",
"label"
],
"additionalProperties": false
}_usine_orchestrator_RemovedWorkerViewEncoded
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"running": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"name",
"running"
],
"additionalProperties": false
}_usine_orchestrator_WorkerConfigurationViewEncoded
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"kind": {
"type": "string",
"enum": [
"local",
"exe.dev",
"ssh",
"cloudflare"
]
},
"maxConcurrentAttempts": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"paused": {
"type": "boolean"
},
"destination": {
"anyOf": [
{
"type": "string",
"pattern": "^(?:[A-Za-z0-9._-]+@)?(?:[A-Za-z0-9](?:[A-Za-z0-9.-]*[A-Za-z0-9])?|[0-9A-Fa-f]{0,4}(?::[0-9A-Fa-f]{0,4}){2,7})$"
},
{
"type": "null"
}
]
},
"port": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 65535
},
{
"type": "null"
}
]
},
"identityFile": {
"anyOf": [
{
"type": "string",
"pattern": "^(?:\\/|~\\/)[!-~]+$"
},
{
"type": "null"
}
]
},
"root": {
"anyOf": [
{
"type": "string",
"pattern": "^(?:\\/[!-.0-~]+)+$"
},
{
"type": "null"
}
]
},
"gateway": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_GatewayViewEncoded"
},
{
"type": "null"
}
]
},
"container": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_ContainerViewEncoded"
},
{
"type": "null"
}
]
},
"containerLimits": {
"anyOf": [
{
"$ref": "#/components/schemas/ContainerLimitsEncoded"
},
{
"type": "null"
}
]
},
"provisioner": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_HetznerProvisionerViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_BoatProvisionerViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_BoxdProvisionerViewEncoded"
},
{
"type": "null"
}
]
},
"machines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_MachineViewEncoded"
}
},
"provisioning": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_ProvisioningPauseViewEncoded"
},
{
"type": "null"
}
]
},
"slots": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_WorkerSlotsViewEncoded"
},
{
"type": "null"
}
]
},
"prerequisites": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_PassedCheckViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_DegradedCheckViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_DeferredCheckViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_FailedCheckViewEncoded"
},
{
"type": "null"
}
]
},
"preflightRunning": {
"type": "boolean"
},
"harnesses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_HarnessPreflightViewEncoded"
}
},
"findings": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"name",
"kind",
"maxConcurrentAttempts",
"destination",
"port",
"identityFile",
"root",
"gateway",
"container",
"containerLimits",
"provisioner",
"machines",
"provisioning",
"slots",
"prerequisites",
"preflightRunning",
"harnesses",
"findings"
],
"additionalProperties": false
}_usine_orchestrator_HarnessPreflightViewEncoded
{
"type": "object",
"properties": {
"harness": {
"type": "string",
"pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"
},
"check": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_PassedCheckViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_DegradedCheckViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_DeferredCheckViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_FailedCheckViewEncoded"
}
]
}
},
"required": [
"harness",
"check"
],
"additionalProperties": false
}_usine_orchestrator_BoxdProvisionerViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"boxd"
]
},
"tokenEnv": {
"type": "string"
},
"endpoint": {
"anyOf": [
{
"type": "string",
"pattern": "^(?:https:\\/\\/(?:[a-z0-9](?:[a-z0-9.-]*[a-z0-9])?|\\[[0-9a-f:.]+\\])|http:\\/\\/(?:localhost|127(?:\\.\\d{1,3}){3}|\\[::1\\]))(?::\\d{1,5})?$"
},
{
"type": "null"
}
]
},
"region": {
"anyOf": [
{
"type": "string",
"pattern": "^[a-z0-9][a-z0-9_-]{0,62}$"
},
{
"type": "null"
}
]
},
"size": {
"anyOf": [
{
"type": "string",
"pattern": "^[1-9][0-9]{0,3}x[1-9][0-9]{0,5}$"
},
{
"type": "null"
}
]
},
"snapshot": {
"type": "string",
"pattern": "^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$"
},
"isolated": {
"type": "boolean"
},
"egress": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"pattern": "^(?:none|(?:\\*\\.)?(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z](?:[a-z0-9-]{0,61}[a-z0-9])?|(?:(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])(?:\\/(?:3[0-2]|[12]?[0-9]))?)$"
}
},
{
"type": "null"
}
]
},
"anthropicKeyEnv": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"openaiKeyEnv": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"_tag",
"tokenEnv",
"endpoint",
"region",
"size",
"snapshot",
"isolated",
"egress",
"anthropicKeyEnv",
"openaiKeyEnv"
],
"additionalProperties": false
}_usine_orchestrator_BoatProvisionerViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"boat"
]
},
"tokenEnv": {
"type": "string"
},
"size": {
"type": "string",
"enum": [
"small",
"default",
"large",
"xlarge"
]
},
"anthropicKeyEnv": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"openaiKeyEnv": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"_tag",
"tokenEnv",
"size",
"anthropicKeyEnv",
"openaiKeyEnv"
],
"additionalProperties": false
}_usine_orchestrator_HetznerProvisionerViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"hetzner"
]
},
"tokenEnv": {
"type": "string"
},
"serverType": {
"type": "string",
"pattern": "^[a-z0-9](?:[a-z0-9-]{0,62}[a-z0-9])?$"
},
"location": {
"type": "string",
"pattern": "^[a-z0-9](?:[a-z0-9-]{0,62}[a-z0-9])?$"
},
"image": {
"type": "string",
"pattern": "^[!-~](?:[ -~]{0,253}[!-~])?$"
},
"network": {
"anyOf": [
{
"type": "string",
"pattern": "^[!-~](?:[ -~]{0,126}[!-~])?$"
},
{
"type": "null"
}
]
},
"firewall": {
"anyOf": [
{
"type": "string",
"pattern": "^[!-~](?:[ -~]{0,126}[!-~])?$"
},
{
"type": "null"
}
]
},
"sshKey": {
"type": "string",
"pattern": "^[!-~](?:[ -~]{0,126}[!-~])?$"
},
"sshUser": {
"type": "string",
"pattern": "^[a-z_][a-z0-9_-]{0,31}$"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"anthropicKeyEnv": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"openaiKeyEnv": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"_tag",
"tokenEnv",
"serverType",
"location",
"image",
"network",
"firewall",
"sshKey",
"sshUser",
"labels",
"anthropicKeyEnv",
"openaiKeyEnv"
],
"additionalProperties": false
}ContainerLimitsEncoded
{
"type": "object",
"properties": {
"cpus": {
"type": "number",
"exclusiveMinimum": 0
},
"memoryMib": {
"type": "integer",
"minimum": 256,
"maximum": 9007199254740991
},
"pids": {
"type": "integer",
"minimum": 64,
"maximum": 9007199254740991
}
},
"required": [
"cpus",
"memoryMib",
"pids"
],
"additionalProperties": false
}_usine_orchestrator_ContainerViewEncoded
{
"type": "object",
"properties": {
"image": {
"anyOf": [
{
"type": "string",
"pattern": "^[a-z0-9][A-Za-z0-9._/:@-]{0,254}$"
},
{
"type": "null"
}
]
},
"cpus": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0
},
{
"type": "null"
}
]
},
"memoryMib": {
"anyOf": [
{
"type": "integer",
"minimum": 256,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"pids": {
"anyOf": [
{
"type": "integer",
"minimum": 64,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"shmSizeMib": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"tmpfsSizeMib": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"image",
"cpus",
"memoryMib",
"pids",
"shmSizeMib",
"tmpfsSizeMib"
],
"additionalProperties": false
}_usine_orchestrator_GatewayViewEncoded
{
"type": "object",
"properties": {
"domain": {
"type": "string",
"pattern": "^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$"
},
"destination": {
"type": "string",
"pattern": "^(?:[A-Za-z0-9._-]+@)?(?:[A-Za-z0-9](?:[A-Za-z0-9.-]*[A-Za-z0-9])?|[0-9A-Fa-f]{0,4}(?::[0-9A-Fa-f]{0,4}){2,7})$"
},
"adminPort": {
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"adminTokenEnv": {
"type": "string",
"minLength": 1
},
"llmProviders": {
"type": "array",
"items": {
"type": "string",
"enum": [
"anthropic-messages",
"openai-responses"
]
}
}
},
"required": [
"domain",
"destination",
"adminPort",
"adminTokenEnv",
"llmProviders"
],
"additionalProperties": false
}_usine_orchestrator_InvalidAgentViewEncoded
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"file": {
"type": "string",
"minLength": 1
},
"error": {
"$ref": "#/components/schemas/_usine_config_ConfigFileErrorEncoded"
}
},
"required": [
"name",
"file",
"error"
],
"additionalProperties": false
}_usine_config_ConfigFileErrorEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"ConfigFileError"
]
},
"file": {
"type": "string",
"minLength": 1
},
"stage": {
"type": "string",
"enum": [
"expression",
"frontmatter",
"read",
"reference",
"schema",
"yaml"
]
},
"expression": {
"type": "string",
"pattern": "\\S"
},
"message": {
"type": "string",
"minLength": 1
},
"details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"message": {
"type": "string"
},
"expression": {
"type": "string",
"pattern": "\\S"
},
"position": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"_tag",
"file",
"stage",
"message"
],
"additionalProperties": false
}_usine_orchestrator_AgentFileViewEncoded
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"file": {
"type": "string",
"minLength": 1
},
"harness": {
"type": "string",
"pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"
},
"model": {
"type": "string",
"pattern": "\\S"
},
"effort": {
"type": "string",
"enum": [
"off",
"minimal",
"low",
"medium",
"high",
"xhigh",
"max"
]
},
"parentModel": {
"anyOf": [
{
"type": "string",
"pattern": "\\S"
},
{
"type": "null"
}
]
},
"parentEffort": {
"anyOf": [
{
"type": "string",
"enum": [
"off",
"minimal",
"low",
"medium",
"high",
"xhigh",
"max"
]
},
{
"type": "null"
}
]
},
"resolvedParentModel": {
"anyOf": [
{
"type": "string",
"pattern": "\\S"
},
{
"type": "null"
}
]
},
"resolvedParentEffort": {
"type": "string",
"enum": [
"off",
"minimal",
"low",
"medium",
"high",
"xhigh",
"max"
]
},
"coordinator": {
"anyOf": [
{
"type": "string",
"enum": [
"session",
"events"
]
},
{
"type": "null"
}
]
},
"resolvedCoordinator": {
"type": "string",
"enum": [
"session",
"events"
]
},
"persona": {
"type": "string",
"pattern": "\\S"
},
"loops": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
}
},
"required": [
"name",
"file",
"harness",
"model",
"effort",
"parentModel",
"parentEffort",
"resolvedParentModel",
"resolvedParentEffort",
"coordinator",
"resolvedCoordinator",
"persona",
"loops"
],
"additionalProperties": false
}_usine_orchestrator_QuarantinedLoopViewEncoded
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"file": {
"type": "string",
"minLength": 1
},
"error": {
"$ref": "#/components/schemas/_usine_config_ConfigFileErrorEncoded"
}
},
"required": [
"name",
"file",
"error"
],
"additionalProperties": false
}_usine_orchestrator_LoopFileViewEncoded
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"file": {
"type": "string",
"minLength": 1
},
"stream": {
"type": "string",
"enum": [
"issue",
"pr",
"schedule"
]
},
"condition": {
"type": "string",
"pattern": "\\S"
},
"cron": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"timeZone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"selector": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_LoopSelectorViewEncoded"
},
{
"type": "null"
}
]
},
"repositories": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
}
},
"approval": {
"anyOf": [
{
"type": "string",
"enum": [
"none",
"required"
]
},
{
"type": "string",
"pattern": "\\S"
}
]
},
"maxCycles": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"permissions": {
"type": "string",
"enum": [
"write",
"read"
]
},
"priority": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "string",
"pattern": "\\S"
},
{
"type": "null"
}
]
},
"step": {
"type": "string",
"minLength": 1
},
"agent": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"prompt": {
"type": "string",
"pattern": "\\S"
},
"paused": {
"type": "boolean"
},
"undeclaredLabels": {
"type": "array",
"items": {
"type": "string",
"pattern": "^\\S(?:.*\\S)?$",
"maxLength": 50
}
},
"outcomeLabels": {
"type": "array",
"items": {
"type": "string",
"pattern": "^\\S(?:.*\\S)?$",
"maxLength": 50
},
"uniqueItems": true
},
"undeclaredOutcomeLabels": {
"type": "array",
"items": {
"type": "string",
"pattern": "^\\S(?:.*\\S)?$",
"maxLength": 50
}
}
},
"required": [
"name",
"file",
"stream",
"condition",
"cron",
"timeZone",
"selector",
"repositories",
"approval",
"maxCycles",
"permissions",
"priority",
"step",
"agent",
"prompt",
"paused",
"undeclaredLabels",
"outcomeLabels",
"undeclaredOutcomeLabels"
],
"additionalProperties": false
}_usine_orchestrator_LoopSelectorViewEncoded
{
"type": "object",
"properties": {
"repos": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
}
},
{
"type": "null"
}
]
},
"tags": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"pattern": "\\S"
}
},
{
"type": "null"
}
]
}
},
"required": [
"repos",
"tags"
],
"additionalProperties": false
}_usine_config_DeclaredLabelEncoded
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^\\S(?:.*\\S)?$",
"maxLength": 50
},
"color": {
"type": "string",
"pattern": "^[0-9a-fA-F]{6}$"
},
"description": {
"type": "string",
"maxLength": 100
}
},
"required": [
"name"
],
"additionalProperties": false
}_usine_orchestrator_ValidationTimeoutRefusalEncoded
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"ValidationTimeoutError"
]
},
"message": {
"type": "string"
},
"step": {
"type": "string",
"enum": [
"wait",
"read",
"parse",
"restart",
"coordinator-brains",
"worker-preflight",
"store",
"apply"
]
}
},
"required": [
"error",
"message",
"step"
],
"additionalProperties": false
}_usine_orchestrator_FactoryConfigRefusalEncoded
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"FactoryConfigError"
]
},
"message": {
"type": "string"
},
"file": {
"type": "string",
"minLength": 1
},
"stage": {
"type": "string",
"enum": [
"expression",
"frontmatter",
"read",
"reference",
"schema",
"yaml"
]
}
},
"required": [
"error",
"message",
"file",
"stage"
],
"additionalProperties": false
}ConfigurationInvalidRefusalEncoded
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"ConfigurationInvalid"
]
},
"message": {
"type": "string"
},
"problems": {
"type": "array",
"prefixItems": [
{
"type": "object",
"properties": {
"entity": {
"$ref": "#/components/schemas/_usine_config_ConfigurationEntityKeyEncoded"
},
"path": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"message": {
"type": "string"
},
"expression": {
"type": "string",
"pattern": "\\S"
},
"position": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"entity",
"path",
"message"
],
"additionalProperties": false
}
],
"minItems": 1,
"items": {
"type": "object",
"properties": {
"entity": {
"$ref": "#/components/schemas/_usine_config_ConfigurationEntityKeyEncoded"
},
"path": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"message": {
"type": "string"
},
"expression": {
"type": "string",
"pattern": "\\S"
},
"position": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"entity",
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"error",
"message",
"problems"
],
"additionalProperties": false
}_usine_config_ConfigurationEntityKeyEncoded
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"settings",
"worker",
"repository",
"project",
"label",
"loop",
"agent",
"binding"
]
},
"identifier": {
"type": "string",
"minLength": 1
}
},
"required": [
"kind",
"identifier"
],
"additionalProperties": false
}_usine_orchestrator_ReloadPreflightRefusalEncoded
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"ReloadPreflightError"
]
},
"message": {
"type": "string"
},
"agents": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
}
},
"workers": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
}
},
"cause": {
"anyOf": [
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"WorkerCapabilityError"
]
},
"worker": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"capability": {
"type": "string",
"enum": [
"machine",
"toolchain",
"memory",
"disk",
"harness-login",
"credentials",
"gateway",
"container",
"provider"
]
},
"message": {
"type": "string"
}
},
"required": [
"_tag",
"worker",
"capability",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"ExecutorOperationError"
]
},
"operation": {
"type": "string",
"enum": [
"preflight",
"prepare",
"launch",
"cancel",
"cleanup"
]
},
"message": {
"type": "string"
}
},
"required": [
"_tag",
"operation",
"message"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"CredentialUnavailableError"
]
},
"repository": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
},
"message": {
"type": "string"
}
},
"required": [
"_tag",
"repository",
"message"
],
"additionalProperties": false
}
]
}
},
"required": [
"error",
"message",
"agents",
"workers",
"cause"
],
"additionalProperties": false
}_usine_orchestrator_RestartRequiredRefusalEncoded
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"RestartRequiredError"
]
},
"message": {
"type": "string"
},
"blocks": {
"type": "array",
"prefixItems": [
{
"type": "string",
"enum": [
"workers",
"tracing",
"auth"
]
}
],
"minItems": 1,
"items": {
"type": "string",
"enum": [
"workers",
"tracing",
"auth"
]
}
},
"fields": {
"type": "array",
"prefixItems": [
{
"type": "string",
"minLength": 1
}
],
"minItems": 1,
"items": {
"type": "string",
"minLength": 1
}
}
},
"required": [
"error",
"message",
"blocks",
"fields"
],
"additionalProperties": false
}ConfigurationRevertRefusalEncoded
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"ConfigurationRevertBlocked"
]
},
"message": {
"type": "string"
},
"entities": {
"type": "array",
"prefixItems": [
{
"$ref": "#/components/schemas/_usine_config_ConfigurationEntityKeyEncoded"
}
],
"minItems": 1,
"items": {
"$ref": "#/components/schemas/_usine_config_ConfigurationEntityKeyEncoded"
}
}
},
"required": [
"error",
"message",
"entities"
],
"additionalProperties": false
}StaleRevisionRefusalEncoded
{
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"StaleRevision"
]
},
"message": {
"type": "string"
},
"expected": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"current": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"error",
"message",
"expected",
"current"
],
"additionalProperties": false
}ConfigurationRevisionViewEncoded
{
"type": "object",
"properties": {
"number": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"actor": {
"anyOf": [
{
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9-]{0,37}[A-Za-z0-9])?$"
},
{
"type": "string",
"enum": [
"local admin"
]
},
{
"type": "null"
}
]
},
"time": {
"type": "string"
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"entities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_config_ConfigurationEntityKeyEncoded"
}
},
"changes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"$ref": "#/components/schemas/_usine_config_ConfigurationEntityKeyEncoded"
},
"before": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"after": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"position": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"key",
"before",
"after"
],
"additionalProperties": false
}
}
},
"required": [
"number",
"actor",
"time",
"message",
"entities",
"changes"
],
"additionalProperties": false
}ConfigurationWriteEncoded
{
"type": "object",
"properties": {
"expected": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"message": {
"type": "string"
}
},
"required": [
"expected"
],
"additionalProperties": false
}ConfigurationEntityViewEncoded
{
"type": "object",
"properties": {
"key": {
"$ref": "#/components/schemas/_usine_config_ConfigurationEntityKeyEncoded"
},
"value": {},
"text": {
"type": "string"
},
"number": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"key",
"value",
"text",
"number"
],
"additionalProperties": false
}ConfigurationRevisionPageEncoded
{
"type": "object",
"properties": {
"revisions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigurationRevisionSummaryEncoded"
}
},
"nextBefore": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"revisions",
"nextBefore"
],
"additionalProperties": false
}ConfigurationRevisionSummaryEncoded
{
"type": "object",
"properties": {
"number": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"actor": {
"anyOf": [
{
"type": "string",
"pattern": "^[A-Za-z0-9](?:[A-Za-z0-9-]{0,37}[A-Za-z0-9])?$"
},
{
"type": "string",
"enum": [
"local admin"
]
},
{
"type": "null"
}
]
},
"time": {
"type": "string"
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"entities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_config_ConfigurationEntityKeyEncoded"
}
}
},
"required": [
"number",
"actor",
"time",
"message",
"entities"
],
"additionalProperties": false
}_usine_github_RepositoryLabelEncoded
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"color": {
"type": "string",
"pattern": "^[0-9a-fA-F]{6}$"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"name",
"color",
"description"
],
"additionalProperties": false
}_usine_agents_HarnessPresentationEncoded
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"
},
"label": {
"type": "string",
"minLength": 1
},
"handoff": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_agents_ResumeCommandEncoded"
},
{
"type": "null"
}
]
},
"ownTools": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"label",
"handoff",
"ownTools"
],
"additionalProperties": false
}_usine_agents_ResumeCommandEncoded
{
"type": "object",
"properties": {
"command": {
"type": "string",
"minLength": 1
},
"homeVariable": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"gateway": {
"type": "boolean"
}
},
"required": [
"command",
"homeVariable",
"gateway"
],
"additionalProperties": false
}LoopPreviewEncoded
{
"type": "object",
"properties": {
"stream": {
"type": "string",
"enum": [
"issue",
"pr",
"schedule"
]
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LoopPreviewItemEncoded"
}
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"prompt": {
"anyOf": [
{
"type": "object",
"properties": {
"itemKey": {
"type": "string",
"minLength": 1
},
"text": {
"type": "string"
}
},
"required": [
"itemKey",
"text"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"repositoriesWithoutItems": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
}
},
"failures": {
"type": "array",
"items": {
"type": "object",
"properties": {
"itemKey": {
"type": "string",
"minLength": 1
},
"message": {
"type": "string"
}
},
"required": [
"itemKey",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"stream",
"items",
"total",
"prompt",
"repositoriesWithoutItems",
"failures"
],
"additionalProperties": false
}LoopPreviewItemEncoded
{
"type": "object",
"properties": {
"itemKey": {
"type": "string",
"minLength": 1
},
"repository": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
},
"kind": {
"type": "string",
"enum": [
"issue",
"pr"
]
},
"number": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"title": {
"type": "string"
},
"url": {
"type": "string"
},
"state": {
"type": "string",
"enum": [
"issue-open",
"issue-closed",
"pr-open",
"pr-closed",
"pr-merged"
]
},
"priority": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"itemKey",
"repository",
"kind",
"number",
"title",
"url",
"state",
"priority"
],
"additionalProperties": false
}LoopPreviewRequestEncoded
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"pattern": "^(?:[a-z0-9]+(?:-[a-z0-9]+)*\\/)?[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"value": {},
"itemKey": {
"type": "string",
"minLength": 1
}
},
"required": [
"name",
"value"
],
"additionalProperties": false
}LoopCheckEncoded
{
"type": "object",
"properties": {
"problems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"message": {
"type": "string"
},
"expression": {
"type": "string",
"pattern": "\\S"
},
"position": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"path",
"message"
],
"additionalProperties": false
}
}
},
"required": [
"problems"
],
"additionalProperties": false
}_usine_orchestrator_TaskViewEncoded
{
"type": "object",
"properties": {
"repository": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
},
"number": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"title": {
"type": "string"
},
"current": {
"type": "string",
"minLength": 1
},
"lane": {
"$ref": "#/components/schemas/_usine_orchestrator_TaskLaneViewEncoded"
},
"needsYou": {
"type": "boolean"
},
"items": {
"type": "array",
"prefixItems": [
{
"$ref": "#/components/schemas/_usine_orchestrator_TaskItemViewEncoded"
}
],
"minItems": 1,
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_TaskItemViewEncoded"
}
},
"runs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_RunViewEncoded"
}
},
"runsTotal": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"commentRuns": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"repository": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
},
"itemKey": {
"type": "string",
"minLength": 1
},
"loop": {
"type": "string",
"minLength": 1
}
},
"required": [
"id",
"repository",
"itemKey",
"loop"
],
"additionalProperties": false
}
},
"comments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_TaskCommentViewEncoded"
}
},
"attemptChanges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"runId": {
"type": "string",
"minLength": 1
},
"attemptId": {
"type": "string",
"minLength": 1
},
"number": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"loop": {
"type": "string",
"minLength": 1
},
"pullRequest": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"base": {
"type": "string",
"pattern": "^[0-9a-f]{40}(?:[0-9a-f]{24})?$"
},
"head": {
"type": "string",
"pattern": "^[0-9a-f]{40}(?:[0-9a-f]{24})?$"
}
},
"required": [
"runId",
"attemptId",
"number",
"loop",
"pullRequest",
"base",
"head"
],
"additionalProperties": false
}
}
},
"required": [
"repository",
"number",
"title",
"current",
"lane",
"needsYou",
"items",
"runs",
"comments"
],
"additionalProperties": false
}_usine_orchestrator_TaskCommentViewEncoded
{
"type": "object",
"properties": {
"runId": {
"type": "string",
"minLength": 1
},
"kind": {
"type": "string",
"enum": [
"issue-comment",
"review",
"review-comment"
]
},
"url": {
"type": "string"
},
"postedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"attemptEndedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"runId",
"kind",
"url",
"postedAt",
"attemptEndedAt"
],
"additionalProperties": false
}_usine_orchestrator_RunViewEncoded
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"itemKey": {
"type": "string",
"minLength": 1
},
"loop": {
"type": "string",
"minLength": 1
},
"repository": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
},
"agent": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"agentBrain": {
"$ref": "#/components/schemas/Agent_BrainSpecEncoded"
},
"state": {
"type": "string",
"enum": [
"Pending",
"Waiting",
"Queued",
"Running",
"AwaitingCi",
"Succeeded",
"HandedOff",
"Failed",
"Canceled"
]
},
"ciWait": {
"anyOf": [
{
"type": "object",
"properties": {
"pullRequest": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"head": {
"type": "string",
"pattern": "^[0-9a-f]{40}(?:[0-9a-f]{24})?$"
},
"fixLoop": {
"type": "string",
"minLength": 1
},
"timeoutSeconds": {
"type": "integer",
"maximum": 86400,
"exclusiveMinimum": 0
},
"onGreen": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"add": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"uniqueItems": true
},
"remove": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"uniqueItems": true
}
},
"required": [
"item",
"add",
"remove"
],
"additionalProperties": false
}
}
},
"required": [
"pullRequest",
"head",
"fixLoop",
"timeoutSeconds",
"onGreen"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"handoff": {
"anyOf": [
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"HandedOff"
]
},
"reason": {
"type": "string",
"minLength": 1
},
"head": {
"type": "string",
"pattern": "^[0-9a-f]{40}(?:[0-9a-f]{24})?$"
},
"fixLoop": {
"type": "string",
"minLength": 1
},
"fixRunId": {
"type": "string",
"minLength": 1
}
},
"required": [
"_tag",
"reason",
"head",
"fixLoop",
"fixRunId"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"upgradeWait": {
"anyOf": [
{
"type": "object",
"properties": {
"target": {
"type": "string",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-(?:0|[1-9]\\d*|\\d*[A-Za-z-][0-9A-Za-z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[A-Za-z-][0-9A-Za-z-]*))*)?(?:\\+[0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*)?$"
},
"since": {
"type": "string"
}
},
"required": [
"target",
"since"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"providerRetry": {
"anyOf": [
{
"type": "object",
"properties": {
"nextAttempt": {
"type": "integer",
"minimum": 2,
"maximum": 9007199254740991
},
"retryAt": {
"type": "string"
},
"message": {
"type": "string",
"minLength": 1
}
},
"required": [
"nextAttempt",
"retryAt",
"message"
],
"propertyNames": {
"anyOf": [
{
"enum": [
"nextAttempt",
"retryAt",
"message"
]
},
{
"type": "string"
}
]
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"machineWait": {
"anyOf": [
{
"type": "object",
"properties": {
"worker": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"message": {
"type": "string"
}
},
"required": [
"worker",
"message"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"loopPaused": {
"type": "boolean"
},
"openedAt": {
"type": "string"
},
"closedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"task": {
"type": "string"
},
"attempts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_AttemptViewEncoded"
}
},
"approval": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_ApprovalViewEncoded"
},
{
"type": "null"
}
]
},
"approvalReason": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"runAgain": {
"anyOf": [
{
"$ref": "#/components/schemas/RunAgainEncoded"
},
{
"type": "null"
}
]
},
"resultMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"pullRequestUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"canApprove": {
"type": "boolean"
},
"canRetry": {
"type": "boolean"
},
"canResolveFailure": {
"type": "boolean"
},
"canApplyCiLabels": {
"type": "boolean"
},
"canCancel": {
"type": "boolean"
},
"canRunAgain": {
"type": "boolean"
}
},
"required": [
"id",
"itemKey",
"loop",
"repository",
"agent",
"agentBrain",
"state",
"loopPaused",
"openedAt",
"closedAt",
"task",
"attempts",
"approval",
"runAgain",
"resultMessage",
"pullRequestUrl",
"canApprove",
"canRetry",
"canResolveFailure",
"canCancel",
"canRunAgain"
],
"additionalProperties": false
}_usine_orchestrator_AttemptViewEncoded
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"number": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"worker": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"workerAccess": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_LocalWorkerAccessEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_SshWorkerAccessEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ProvisionedWorkerAccessEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_SandboxWorkerAccessEncoded"
},
{
"type": "null"
}
]
},
"brain": {
"$ref": "#/components/schemas/Agent_BrainSpecEncoded"
},
"task": {
"type": "string",
"pattern": "\\S"
},
"agent": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"operatorIntervened": {
"type": "boolean"
},
"startedAt": {
"type": "string"
},
"outcome": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_SucceededAttemptViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_AwaitingCiAttemptViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_HandedOffAttemptViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_FailedAttemptViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_CanceledAttemptViewEncoded"
},
{
"type": "null"
}
]
},
"endedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"salvage": {
"anyOf": [
{
"$ref": "#/components/schemas/AttemptSalvage_PushedEncoded"
},
{
"$ref": "#/components/schemas/AttemptSalvage_PartlyPushedEncoded"
},
{
"$ref": "#/components/schemas/AttemptSalvage_RetainedEncoded"
},
{
"$ref": "#/components/schemas/AttemptSalvage_RejectedEncoded"
},
{
"type": "null"
}
]
},
"start": {
"anyOf": [
{
"$ref": "#/components/schemas/AttemptStart_EventEncoded"
},
{
"$ref": "#/components/schemas/AttemptStart_RetryEncoded"
},
{
"$ref": "#/components/schemas/AttemptStart_EditAndRetryEncoded"
},
{
"$ref": "#/components/schemas/AttemptStart_InfraRetryEncoded"
},
{
"$ref": "#/components/schemas/AttemptStart_ProviderRetryEncoded"
},
{
"$ref": "#/components/schemas/AttemptStart_AfterRestartEncoded"
},
{
"type": "null"
}
]
},
"reattachedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"outOfMemory": {
"anyOf": [
{
"$ref": "#/components/schemas/OutOfMemoryKillsEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"number",
"worker",
"workerAccess",
"brain",
"task",
"agent",
"operatorIntervened",
"startedAt",
"outcome",
"endedAt",
"salvage",
"start",
"reattachedAt",
"outOfMemory"
],
"additionalProperties": false
}_usine_orchestrator_TaskItemViewEncoded
{
"type": "object",
"properties": {
"itemKey": {
"type": "string",
"minLength": 1
},
"kind": {
"type": "string",
"enum": [
"issue",
"pr"
]
},
"number": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"title": {
"type": "string"
},
"url": {
"type": "string",
"minLength": 1
},
"state": {
"type": "string",
"enum": [
"issue-open",
"issue-closed",
"pr-open",
"pr-closed",
"pr-merged"
]
},
"labels": {
"type": "array",
"items": {
"type": "string",
"pattern": "^\\S(?:.*\\S)?$",
"maxLength": 50
}
},
"conflicting": {
"type": "boolean"
},
"pullRequest": {
"anyOf": [
{
"type": "object",
"properties": {
"base": {
"type": "string",
"pattern": "^[0-9a-f]{40}(?:[0-9a-f]{24})?$"
},
"head": {
"type": "string",
"pattern": "^[0-9a-f]{40}(?:[0-9a-f]{24})?$"
},
"checks": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"review": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"base",
"head",
"checks",
"review"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"itemKey",
"kind",
"number",
"title",
"url",
"state",
"labels",
"conflicting"
],
"additionalProperties": false
}_usine_orchestrator_TaskLaneViewEncoded
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"pattern": "\\S"
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
}_usine_orchestrator_WorkerPreflightViewEncoded
{
"type": "object",
"properties": {
"worker": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"prerequisites": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_PassedCheckViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_DegradedCheckViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_DeferredCheckViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_FailedCheckViewEncoded"
},
{
"type": "null"
}
]
},
"harnesses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_HarnessPreflightViewEncoded"
}
},
"containerLimits": {
"anyOf": [
{
"$ref": "#/components/schemas/ContainerLimitsEncoded"
},
{
"type": "null"
}
]
},
"findings": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"worker",
"prerequisites",
"harnesses",
"containerLimits",
"findings"
],
"additionalProperties": false
}FileChangesEncoded
{
"type": "object",
"properties": {
"base": {
"type": "string",
"pattern": "^[0-9a-f]{40}(?:[0-9a-f]{24})?$"
},
"head": {
"type": "string",
"pattern": "^[0-9a-f]{40}(?:[0-9a-f]{24})?$"
},
"files": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChangedFileEncoded"
}
},
"filesTruncated": {
"type": "boolean"
}
},
"required": [
"base",
"head",
"files",
"filesTruncated"
],
"additionalProperties": false
}ChangedFileEncoded
{
"type": "object",
"properties": {
"path": {
"type": "string",
"minLength": 1
},
"oldPath": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"added",
"modified",
"removed",
"renamed"
]
},
"additions": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"deletions": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"patch": {
"anyOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"text"
]
},
"text": {
"type": "string"
},
"truncated": {
"type": "boolean"
}
},
"required": [
"kind",
"text",
"truncated"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"omitted"
]
}
},
"required": [
"kind"
],
"additionalProperties": false
}
]
},
"test": {
"type": "boolean"
},
"generated": {
"type": "boolean"
}
},
"required": [
"path",
"oldPath",
"status",
"additions",
"deletions",
"patch",
"test",
"generated"
],
"additionalProperties": false
}_usine_orchestrator_BoardTaskViewEncoded
{
"type": "object",
"properties": {
"itemKey": {
"type": "string",
"minLength": 1
},
"kind": {
"type": "string",
"enum": [
"issue",
"pr"
]
},
"number": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"title": {
"type": "string"
},
"url": {
"type": "string",
"minLength": 1
},
"state": {
"type": "string",
"enum": [
"issue-open",
"issue-closed",
"pr-open",
"pr-closed",
"pr-merged"
]
},
"labels": {
"type": "array",
"items": {
"type": "string",
"pattern": "^\\S(?:.*\\S)?$",
"maxLength": 50
}
},
"conflicting": {
"type": "boolean"
},
"repository": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_BoardItemLinkEncoded"
},
"minItems": 1
},
"pullRequest": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_BoardPullRequestViewEncoded"
},
{
"type": "null"
}
]
},
"runCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"attemptCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"runContext": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_RunSummaryViewEncoded"
}
},
"loopStates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"loop": {
"type": "string",
"minLength": 1
},
"state": {
"type": "string",
"enum": [
"Pending",
"Waiting",
"Queued",
"Running",
"AwaitingCi",
"Succeeded",
"HandedOff",
"Failed",
"Canceled"
]
}
},
"required": [
"loop",
"state"
],
"additionalProperties": false
}
},
"run": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_RunSummaryViewEncoded"
},
{
"type": "null"
}
]
},
"needsYou": {
"type": "boolean"
},
"loops": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"usage": {
"$ref": "#/components/schemas/_usine_orchestrator_TaskUsageViewEncoded"
}
},
"required": [
"itemKey",
"kind",
"number",
"title",
"url",
"state",
"labels",
"conflicting",
"repository",
"items",
"pullRequest",
"runCount",
"attemptCount",
"runContext",
"loopStates",
"run",
"needsYou",
"loops",
"usage"
],
"additionalProperties": false
}_usine_orchestrator_TaskUsageViewEncoded
{
"type": "object",
"properties": {
"durationMillis": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"runningSince": {
"type": "array",
"items": {
"type": "string"
}
},
"unmeasured": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"tokens": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"pools": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_TaskPoolUsageViewEncoded"
}
},
"cost": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_UsageCostViewEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"durationMillis",
"runningSince",
"unmeasured",
"tokens",
"pools",
"cost"
],
"additionalProperties": false
}_usine_orchestrator_UsageCostViewEncoded
{
"type": "object",
"properties": {
"usd": {
"type": "number",
"minimum": 0
},
"estimate": {
"type": "boolean"
}
},
"required": [
"usd",
"estimate"
],
"additionalProperties": false
}_usine_orchestrator_TaskPoolUsageViewEncoded
{
"type": "object",
"properties": {
"pool": {
"type": "string",
"enum": [
"apiKeys",
"claudePlan",
"chatgptPlan"
]
},
"tokens": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"cost": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_UsageCostViewEncoded"
},
{
"type": "null"
}
]
},
"unpriced": {
"type": "boolean"
}
},
"required": [
"pool",
"tokens",
"cost",
"unpriced"
],
"additionalProperties": false
}_usine_orchestrator_BoardPullRequestViewEncoded
{
"type": "object",
"properties": {
"number": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"url": {
"type": "string",
"minLength": 1
},
"state": {
"type": "string",
"enum": [
"pr-open",
"pr-merged"
]
}
},
"required": [
"number",
"url",
"state"
],
"additionalProperties": false
}_usine_orchestrator_ProjectViewEncoded
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"name": {
"type": "string"
},
"repositories": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
}
},
"repository": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
},
"status": {
"type": "string",
"enum": [
"clear",
"active",
"needs-you"
]
},
"runs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_RunSummaryViewEncoded"
}
},
"board": {
"$ref": "#/components/schemas/_usine_orchestrator_BoardViewEncoded"
},
"labels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_LabelViewEncoded"
}
},
"preflightFindings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_LabelPreflightFindingEncoded"
}
}
},
"required": [
"repository",
"status",
"runs",
"board",
"labels",
"preflightFindings"
],
"additionalProperties": false
}_usine_orchestrator_LabelViewEncoded
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^\\S(?:.*\\S)?$",
"maxLength": 50
},
"color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"name",
"color",
"description"
],
"additionalProperties": false
}_usine_orchestrator_BoardViewEncoded
{
"type": "object",
"properties": {
"lanes": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_WritableBoardLaneViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ReadOnlyBoardLaneViewEncoded"
}
]
}
},
"cardedItemKeys": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"failures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_BoardProjectionErrorEncoded"
}
}
},
"required": [
"lanes",
"failures"
],
"additionalProperties": false
}_usine_orchestrator_BoardProjectionErrorEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"BoardProjectionError"
]
},
"repository": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
},
"itemKey": {
"type": "string",
"minLength": 1
},
"message": {
"type": "string",
"minLength": 1
}
},
"required": [
"_tag",
"repository",
"itemKey",
"message"
],
"additionalProperties": false
}_usine_orchestrator_ReadOnlyBoardLaneViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"ReadOnlyBoardLane"
]
},
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"pattern": "\\S"
},
"sources": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_config_LabelLaneSourceEncoded"
},
{
"$ref": "#/components/schemas/_usine_config_StateLaneSourceEncoded"
}
]
}
},
"origin": {
"type": "string",
"enum": [
"authored",
"proposed",
"fallback"
]
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_BoardTaskViewEncoded"
}
},
"totalItems": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"_tag",
"id",
"name",
"sources",
"origin",
"items"
],
"additionalProperties": false
}_usine_config_StateLaneSourceEncoded
{
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"issue-open",
"issue-closed",
"pr-open",
"pr-closed",
"pr-merged"
]
}
},
"required": [
"state"
],
"additionalProperties": false
}_usine_config_LabelLaneSourceEncoded
{
"type": "object",
"properties": {
"label": {
"type": "string",
"pattern": "^\\S(?:.*\\S)?$",
"maxLength": 50
}
},
"required": [
"label"
],
"additionalProperties": false
}_usine_orchestrator_WritableBoardLaneViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"WritableBoardLane"
]
},
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"pattern": "\\S"
},
"sources": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_config_LabelLaneSourceEncoded"
},
{
"$ref": "#/components/schemas/_usine_config_StateLaneSourceEncoded"
}
]
}
},
"origin": {
"type": "string",
"enum": [
"authored"
]
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_BoardTaskViewEncoded"
}
},
"totalItems": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"labels": {
"type": "array",
"items": {
"type": "string",
"pattern": "^\\S(?:.*\\S)?$",
"maxLength": 50
},
"minItems": 1
}
},
"required": [
"_tag",
"id",
"name",
"sources",
"origin",
"items",
"labels"
],
"additionalProperties": false
}_usine_orchestrator_RunGitHubChangesViewEncoded
{
"type": "object",
"properties": {
"attempts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_AttemptGitHubChangesViewEncoded"
}
}
},
"required": [
"attempts"
],
"additionalProperties": false
}_usine_orchestrator_AttemptGitHubChangesViewEncoded
{
"type": "object",
"properties": {
"attemptId": {
"type": "string",
"minLength": 1
},
"changes": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_LabelAddedViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_LabelRemovedViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_CommentedViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ReviewedViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_BoardMovedViewEncoded"
}
]
}
}
},
"required": [
"attemptId",
"changes"
],
"additionalProperties": false
}_usine_orchestrator_BoardMovedViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"BoardMoved"
]
},
"at": {
"type": "string"
},
"fromLane": {
"type": "string",
"pattern": "\\S"
},
"toLane": {
"type": "string",
"pattern": "\\S"
}
},
"required": [
"_tag",
"at",
"fromLane",
"toLane"
],
"additionalProperties": false
}_usine_orchestrator_ReviewedViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Reviewed"
]
},
"at": {
"type": "string"
},
"url": {
"type": "string"
},
"state": {
"type": "string",
"enum": [
"APPROVED",
"CHANGES_REQUESTED",
"COMMENTED",
"DISMISSED"
]
}
},
"required": [
"_tag",
"at",
"url",
"state"
],
"additionalProperties": false
}_usine_orchestrator_CommentedViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Commented"
]
},
"at": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"_tag",
"at",
"url"
],
"additionalProperties": false
}_usine_orchestrator_LabelRemovedViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"LabelRemoved"
]
},
"at": {
"type": "string"
},
"label": {
"$ref": "#/components/schemas/_usine_orchestrator_LabelViewEncoded"
}
},
"required": [
"_tag",
"at",
"label"
],
"additionalProperties": false
}_usine_orchestrator_LabelAddedViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"LabelAdded"
]
},
"at": {
"type": "string"
},
"label": {
"$ref": "#/components/schemas/_usine_orchestrator_LabelViewEncoded"
}
},
"required": [
"_tag",
"at",
"label"
],
"additionalProperties": false
}_usine_orchestrator_RunDetailViewEncoded
{
"type": "object",
"properties": {
"run": {
"$ref": "#/components/schemas/_usine_orchestrator_RunViewEncoded"
},
"agentDefinitionChanged": {
"type": "boolean"
},
"eventDedupKey": {
"type": "string"
},
"eventPayload": {},
"transcript": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_TranscriptEventViewEncoded"
}
},
"sessionState": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_TranscriptEventViewEncoded"
}
},
"earlierTranscript": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_TranscriptPageCursorEncoded"
}
},
"worker": {
"anyOf": [
{
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
{
"type": "null"
}
]
},
"settledItemState": {
"anyOf": [
{
"type": "string",
"enum": [
"issue-closed",
"pr-closed",
"pr-merged"
]
},
{
"type": "null"
}
]
},
"duration": {
"$ref": "#/components/schemas/_usine_orchestrator_RunDurationViewEncoded"
},
"usage": {
"$ref": "#/components/schemas/_usine_orchestrator_RunUsageViewEncoded"
},
"unconfirmedStop": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_UnconfirmedStopViewEncoded"
},
{
"type": "null"
}
]
},
"machine": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_MachineViewEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"run",
"agentDefinitionChanged",
"eventDedupKey",
"eventPayload",
"transcript",
"sessionState",
"earlierTranscript",
"worker",
"settledItemState",
"duration",
"usage",
"unconfirmedStop",
"machine"
],
"additionalProperties": false
}_usine_orchestrator_RunUsageViewEncoded
{
"type": "object",
"properties": {
"tokens": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"pools": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_PoolUsageViewEncoded"
}
},
"sessions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_SessionUsageViewEncoded"
}
}
},
"required": [
"tokens",
"pools",
"sessions"
],
"additionalProperties": false
}_usine_orchestrator_SessionUsageViewEncoded
{
"type": "object",
"properties": {
"attemptId": {
"type": "string",
"minLength": 1
},
"session": {
"anyOf": [
{
"$ref": "#/components/schemas/Agent_ParentSessionEncoded"
},
{
"$ref": "#/components/schemas/Agent_ChildSessionEncoded"
},
{
"$ref": "#/components/schemas/Agent_RoleSessionEncoded"
}
]
},
"pool": {
"type": "string",
"enum": [
"apiKeys",
"claudePlan",
"chatgptPlan"
]
},
"tokens": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"cost": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_UsageCostViewEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"attemptId",
"session",
"pool",
"tokens",
"cost"
],
"additionalProperties": false
}Agent_RoleSessionEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"RoleSession"
]
},
"id": {
"type": "string",
"minLength": 1
},
"role": {
"type": "string",
"minLength": 1,
"pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"
},
"parentId": {
"type": "string",
"minLength": 1
},
"agent": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"brain": {
"$ref": "#/components/schemas/Agent_BrainSpecEncoded"
},
"pool": {
"type": "string",
"enum": [
"apiKeys",
"claudePlan",
"chatgptPlan"
]
},
"endpoint": {
"type": "string",
"minLength": 1
}
},
"required": [
"_tag",
"id",
"role",
"agent",
"brain"
],
"additionalProperties": false
}Agent_ChildSessionEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"ChildSession"
]
},
"id": {
"type": "string",
"minLength": 1
},
"parentId": {
"type": "string",
"minLength": 1
},
"agent": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"brain": {
"$ref": "#/components/schemas/Agent_BrainSpecEncoded"
},
"pool": {
"type": "string",
"enum": [
"apiKeys",
"claudePlan",
"chatgptPlan"
]
},
"endpoint": {
"type": "string",
"minLength": 1
},
"gatewayCredential": {
"type": "string",
"enum": [
"api-key",
"subscription"
]
}
},
"required": [
"_tag",
"id",
"parentId",
"agent",
"brain"
],
"additionalProperties": false
}Agent_ParentSessionEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"ParentSession"
]
},
"id": {
"type": "string",
"minLength": 1
},
"agent": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"brain": {
"$ref": "#/components/schemas/Agent_BrainSpecEncoded"
},
"pool": {
"type": "string",
"enum": [
"apiKeys",
"claudePlan",
"chatgptPlan"
]
},
"endpoint": {
"type": "string",
"minLength": 1
}
},
"required": [
"_tag",
"id",
"agent",
"brain"
],
"additionalProperties": false
}_usine_orchestrator_PoolUsageViewEncoded
{
"type": "object",
"properties": {
"pool": {
"type": "string",
"enum": [
"apiKeys",
"claudePlan",
"chatgptPlan"
]
},
"tokens": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"cost": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_UsageCostViewEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"pool",
"tokens",
"cost"
],
"additionalProperties": false
}_usine_orchestrator_RunDurationViewEncoded
{
"type": "object",
"properties": {
"endedMillis": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"runningSince": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"unmeasured": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"endedMillis",
"runningSince",
"unmeasured"
],
"additionalProperties": false
}_usine_orchestrator_TranscriptPageCursorEncoded
{
"type": "object",
"properties": {
"attemptId": {
"type": "string",
"minLength": 1
},
"before": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
}
},
"required": [
"attemptId",
"before"
],
"additionalProperties": false
}_usine_orchestrator_TranscriptEventViewEncoded
{
"type": "object",
"properties": {
"sequence": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"attemptId": {
"type": "string",
"minLength": 1
},
"receivedAt": {
"type": "string"
},
"direction": {
"type": "string",
"enum": [
"inbound",
"outbound"
]
},
"target": {
"anyOf": [
{
"$ref": "#/components/schemas/AttemptChannel_ParentTargetEncoded"
},
{
"$ref": "#/components/schemas/AttemptChannel_ChildTargetEncoded"
}
]
},
"operator": {
"type": "string",
"minLength": 1
},
"payload": {
"anyOf": [
{
"$ref": "#/components/schemas/AttemptChannel_StartedEncoded"
},
{
"$ref": "#/components/schemas/AttemptChannel_SessionEventEncoded"
},
{
"$ref": "#/components/schemas/AttemptChannel_FinalEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_FailedTranscriptViewEncoded"
},
{
"$ref": "#/components/schemas/AttemptChannel_InterruptedEncoded"
},
{
"$ref": "#/components/schemas/AttemptChannel_SteerEncoded"
},
{
"$ref": "#/components/schemas/AttemptChannel_InterruptEncoded"
},
{
"$ref": "#/components/schemas/AttemptChannel_OperatorMessageEncoded"
},
{
"$ref": "#/components/schemas/AttemptChannel_ReleaseEncoded"
},
{
"$ref": "#/components/schemas/AttemptChannel_CancelEncoded"
},
{
"$ref": "#/components/schemas/AttemptChannel_InterventionAppliedEncoded"
},
{
"$ref": "#/components/schemas/AttemptChannel_InterventionRejectedEncoded"
},
{
"$ref": "#/components/schemas/AttemptChannel_WorkerUnresponsiveEncoded"
},
{
"$ref": "#/components/schemas/AttemptChannel_WorkerResponsiveEncoded"
}
]
}
},
"required": [
"sequence",
"attemptId",
"receivedAt",
"direction",
"payload"
],
"additionalProperties": false
}AttemptChannel_WorkerResponsiveEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"WorkerResponsive"
]
},
"worker": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"lastAnsweredAt": {
"type": "string"
},
"recovered": {
"type": "boolean"
}
},
"required": [
"_tag",
"worker",
"lastAnsweredAt"
],
"additionalProperties": false
}AttemptChannel_WorkerUnresponsiveEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"WorkerUnresponsive"
]
},
"worker": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"lastAnsweredAt": {
"type": "string"
},
"reason": {
"type": "string",
"minLength": 1
},
"unansweredProbes": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
}
},
"required": [
"_tag",
"worker",
"lastAnsweredAt",
"reason"
],
"additionalProperties": false
}AttemptChannel_InterventionRejectedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"InterventionRejected"
]
},
"inputSequence": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"intervention": {
"$ref": "#/components/schemas/AttemptChannel_InterventionEncoded"
},
"message": {
"type": "string",
"minLength": 1
}
},
"required": [
"_tag",
"inputSequence",
"intervention",
"message"
],
"additionalProperties": false
}AttemptChannel_InterventionEncoded
{
"type": "object",
"properties": {
"operator": {
"type": "string",
"minLength": 1
},
"target": {
"anyOf": [
{
"$ref": "#/components/schemas/AttemptChannel_ParentTargetEncoded"
},
{
"$ref": "#/components/schemas/AttemptChannel_ChildTargetEncoded"
}
]
},
"action": {
"anyOf": [
{
"$ref": "#/components/schemas/AttemptChannel_SteerEncoded"
},
{
"$ref": "#/components/schemas/AttemptChannel_InterruptEncoded"
},
{
"$ref": "#/components/schemas/AttemptChannel_OperatorMessageEncoded"
},
{
"$ref": "#/components/schemas/AttemptChannel_ReleaseEncoded"
}
]
}
},
"required": [
"operator",
"target",
"action"
],
"additionalProperties": false
}AttemptChannel_ReleaseEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Release"
]
}
},
"required": [
"_tag"
],
"additionalProperties": false
}AttemptChannel_OperatorMessageEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"OperatorMessage"
]
},
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"message": {
"type": "string",
"minLength": 1
}
},
"required": [
"_tag",
"message"
],
"additionalProperties": false
}AttemptChannel_InterruptEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Interrupt"
]
}
},
"required": [
"_tag"
],
"additionalProperties": false
}AttemptChannel_SteerEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Steer"
]
},
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"message": {
"type": "string",
"minLength": 1
}
},
"required": [
"_tag",
"message"
],
"additionalProperties": false
}AttemptChannel_ChildTargetEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Child"
]
},
"sessionId": {
"type": "string",
"minLength": 1
}
},
"required": [
"_tag",
"sessionId"
],
"additionalProperties": false
}AttemptChannel_ParentTargetEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Parent"
]
}
},
"required": [
"_tag"
],
"additionalProperties": false
}AttemptChannel_InterventionAppliedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"InterventionApplied"
]
},
"inputSequence": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"intervention": {
"$ref": "#/components/schemas/AttemptChannel_InterventionEncoded"
},
"state": {
"$ref": "#/components/schemas/AttemptChannel_InterventionStateEncoded"
}
},
"required": [
"_tag",
"inputSequence",
"intervention",
"state"
],
"additionalProperties": false
}AttemptChannel_InterventionStateEncoded
{
"type": "object",
"properties": {
"held": {
"type": "boolean"
},
"paused": {
"type": "boolean"
},
"queued": {
"type": "boolean"
},
"forwardedTo": {
"type": "string",
"minLength": 1
}
},
"required": [
"held",
"paused"
],
"additionalProperties": false
}AttemptChannel_CancelEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Cancel"
]
}
},
"required": [
"_tag"
],
"additionalProperties": false
}AttemptChannel_InterruptedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Interrupted"
]
}
},
"required": [
"_tag"
],
"additionalProperties": false
}_usine_orchestrator_FailedTranscriptViewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Failed"
]
},
"failure": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_GitHubPushFailureViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_InfraFailureViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ProviderCapacityFailureViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_DefectFailureViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_AgentFailureViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_BlockedFailureViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_QuestionFailureViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_RunawayFailureViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ChildSessionBudgetFailureViewEncoded"
}
]
}
},
"required": [
"_tag",
"failure"
],
"additionalProperties": false
}AttemptChannel_FinalEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Final"
]
},
"result": {
"$ref": "#/components/schemas/StepResultEncoded"
}
},
"required": [
"_tag",
"result"
],
"additionalProperties": false
}StepResultEncoded
{
"type": "object",
"properties": {
"attemptId": {
"type": "string",
"minLength": 1
},
"message": {
"type": "string",
"minLength": 1
},
"facts": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/StepResult_CommitEncoded"
},
{
"$ref": "#/components/schemas/StepResult_PullRequestEncoded"
},
{
"$ref": "#/components/schemas/StepResult_CommentEncoded"
}
]
}
},
"unverifiedHandoff": {
"anyOf": [
{
"$ref": "#/components/schemas/HeadMismatchEncoded"
},
{
"$ref": "#/components/schemas/PullRequestNotFoundEncoded"
},
{
"$ref": "#/components/schemas/PullRequestNotOpenEncoded"
},
{
"$ref": "#/components/schemas/RepositoryMismatchEncoded"
},
{
"$ref": "#/components/schemas/BranchNotAtHeadEncoded"
},
{
"$ref": "#/components/schemas/GitHubReadFailedEncoded"
},
{
"$ref": "#/components/schemas/GitReadFailedEncoded"
},
{
"$ref": "#/components/schemas/VerificationTimedOutEncoded"
}
]
},
"outputs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[a-z0-9]+(?:[-_][a-z0-9]+)*$"
},
"type": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"commit": {
"type": "string",
"pattern": "^[0-9a-f]{40}(?:[0-9a-f]{24})?$"
},
"size": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
},
"required": [
"name",
"type",
"size",
"sha256"
],
"additionalProperties": false
}
}
},
"required": [
"message",
"facts"
],
"additionalProperties": false
}VerificationTimedOutEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"VerificationTimedOut"
]
},
"seconds": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
},
"required": [
"_tag",
"seconds"
],
"additionalProperties": false
}GitReadFailedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"GitReadFailed"
]
},
"message": {
"type": "string",
"minLength": 1
},
"cause": {}
},
"required": [
"_tag",
"message",
"cause"
],
"additionalProperties": false
}GitHubReadFailedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"GitHubReadFailed"
]
},
"message": {
"type": "string",
"minLength": 1
},
"cause": {}
},
"required": [
"_tag",
"message"
],
"additionalProperties": false
}BranchNotAtHeadEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"BranchNotAtHead"
]
},
"pullRequest": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"branch": {
"type": "string",
"minLength": 1
},
"branchHead": {
"type": "string",
"pattern": "^[0-9a-f]{40}(?:[0-9a-f]{24})?$"
},
"head": {
"type": "string",
"pattern": "^[0-9a-f]{40}(?:[0-9a-f]{24})?$"
}
},
"required": [
"_tag",
"branch",
"head"
],
"additionalProperties": false
}RepositoryMismatchEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"RepositoryMismatch"
]
},
"pullRequest": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"headRepository": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
}
},
"required": [
"_tag",
"pullRequest"
],
"additionalProperties": false
}PullRequestNotOpenEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"PullRequestNotOpen"
]
},
"pullRequest": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"state": {
"type": "string",
"minLength": 1
}
},
"required": [
"_tag",
"pullRequest",
"state"
],
"additionalProperties": false
}PullRequestNotFoundEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"PullRequestNotFound"
]
},
"pullRequest": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"branch": {
"type": "string",
"minLength": 1
},
"head": {
"type": "string",
"pattern": "^[0-9a-f]{40}(?:[0-9a-f]{24})?$"
}
},
"required": [
"_tag",
"head"
],
"additionalProperties": false
}HeadMismatchEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"HeadMismatch"
]
},
"pullRequest": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"handedOff": {
"type": "string",
"pattern": "^[0-9a-f]{40}(?:[0-9a-f]{24})?$"
},
"head": {
"type": "string",
"pattern": "^[0-9a-f]{40}(?:[0-9a-f]{24})?$"
}
},
"required": [
"_tag",
"pullRequest",
"handedOff",
"head"
],
"additionalProperties": false
}StepResult_CommentEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Comment"
]
},
"url": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"issue-comment",
"review",
"review-comment"
]
},
"at": {
"type": "string"
}
},
"required": [
"_tag",
"url",
"kind"
],
"additionalProperties": false
}StepResult_PullRequestEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"PullRequest"
]
},
"number": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"url": {
"type": "string"
},
"base": {
"type": "string",
"pattern": "^[0-9a-f]{40}(?:[0-9a-f]{24})?$"
},
"head": {
"type": "string",
"pattern": "^[0-9a-f]{40}(?:[0-9a-f]{24})?$"
}
},
"required": [
"_tag",
"number",
"url"
],
"additionalProperties": false
}StepResult_CommitEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Commit"
]
},
"sha": {
"type": "string",
"pattern": "^[0-9a-f]{40}(?:[0-9a-f]{24})?$"
},
"summary": {
"type": "string",
"minLength": 1
}
},
"required": [
"_tag",
"sha",
"summary"
],
"additionalProperties": false
}AttemptChannel_SessionEventEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"SessionEvent"
]
},
"event": {
"anyOf": [
{
"$ref": "#/components/schemas/Agent_SessionStartedEncoded"
},
{
"$ref": "#/components/schemas/Agent_TextOutputEncoded"
},
{
"$ref": "#/components/schemas/Agent_ToolStartedEncoded"
},
{
"$ref": "#/components/schemas/Agent_ToolFinishedEncoded"
},
{
"$ref": "#/components/schemas/Agent_PoolRateLimitsUpdatedEncoded"
},
{
"$ref": "#/components/schemas/Agent_SessionFinishedEncoded"
},
{
"$ref": "#/components/schemas/Agent_SessionIdleEncoded"
},
{
"$ref": "#/components/schemas/Agent_SessionResumedEncoded"
},
{
"$ref": "#/components/schemas/Agent_SessionTokensUpdatedEncoded"
},
{
"$ref": "#/components/schemas/Agent_ProviderRetryingEncoded"
},
{
"$ref": "#/components/schemas/Agent_ProviderRecoveredEncoded"
}
]
}
},
"required": [
"_tag",
"event"
],
"additionalProperties": false
}Agent_ProviderRecoveredEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"ProviderRecovered"
]
},
"session": {
"anyOf": [
{
"$ref": "#/components/schemas/Agent_ParentSessionEncoded"
},
{
"$ref": "#/components/schemas/Agent_ChildSessionEncoded"
},
{
"$ref": "#/components/schemas/Agent_RoleSessionEncoded"
}
]
},
"retries": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
}
},
"required": [
"_tag",
"session",
"retries"
],
"additionalProperties": false
}Agent_ProviderRetryingEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"ProviderRetrying"
]
},
"session": {
"anyOf": [
{
"$ref": "#/components/schemas/Agent_ParentSessionEncoded"
},
{
"$ref": "#/components/schemas/Agent_ChildSessionEncoded"
},
{
"$ref": "#/components/schemas/Agent_RoleSessionEncoded"
}
]
},
"message": {
"type": "string",
"minLength": 1
},
"retries": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
}
},
"required": [
"_tag",
"session",
"message",
"retries"
],
"additionalProperties": false
}Agent_SessionTokensUpdatedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"SessionTokensUpdated"
]
},
"session": {
"anyOf": [
{
"$ref": "#/components/schemas/Agent_ParentSessionEncoded"
},
{
"$ref": "#/components/schemas/Agent_ChildSessionEncoded"
},
{
"$ref": "#/components/schemas/Agent_RoleSessionEncoded"
}
]
},
"totalTokens": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"costUsd": {
"type": "number",
"minimum": 0
},
"breakdown": {
"type": "object",
"properties": {
"input": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"cachedInput": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"cacheWrite": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"output": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"input",
"cachedInput",
"cacheWrite",
"output"
],
"additionalProperties": false
},
"processUsage": {
"type": "object",
"properties": {
"totalTokens": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"costUsd": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"messages": {
"type": "object",
"additionalProperties": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"awaitsFirstResult": {
"type": "boolean"
}
},
"required": [
"totalTokens",
"costUsd"
],
"additionalProperties": false
}
},
"required": [
"_tag",
"session",
"totalTokens"
],
"additionalProperties": false
}Agent_SessionResumedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"SessionResumed"
]
},
"session": {
"anyOf": [
{
"$ref": "#/components/schemas/Agent_ParentSessionEncoded"
},
{
"$ref": "#/components/schemas/Agent_ChildSessionEncoded"
},
{
"$ref": "#/components/schemas/Agent_RoleSessionEncoded"
}
]
}
},
"required": [
"_tag",
"session"
],
"additionalProperties": false
}Agent_SessionIdleEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"SessionIdle"
]
},
"session": {
"anyOf": [
{
"$ref": "#/components/schemas/Agent_ParentSessionEncoded"
},
{
"$ref": "#/components/schemas/Agent_ChildSessionEncoded"
},
{
"$ref": "#/components/schemas/Agent_RoleSessionEncoded"
}
]
},
"message": {
"type": "string",
"minLength": 1
},
"answeredOperator": {
"type": "boolean"
}
},
"required": [
"_tag",
"session"
],
"additionalProperties": false
}Agent_SessionFinishedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"SessionFinished"
]
},
"session": {
"anyOf": [
{
"$ref": "#/components/schemas/Agent_ParentSessionEncoded"
},
{
"$ref": "#/components/schemas/Agent_ChildSessionEncoded"
},
{
"$ref": "#/components/schemas/Agent_RoleSessionEncoded"
}
]
},
"backgroundWaitLimitPassed": {
"type": "boolean"
}
},
"required": [
"_tag",
"session"
],
"additionalProperties": false
}Agent_PoolRateLimitsUpdatedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"PoolRateLimitsUpdated"
]
},
"session": {
"anyOf": [
{
"$ref": "#/components/schemas/Agent_ParentSessionEncoded"
},
{
"$ref": "#/components/schemas/Agent_ChildSessionEncoded"
},
{
"$ref": "#/components/schemas/Agent_RoleSessionEncoded"
}
]
},
"pool": {
"type": "string",
"enum": [
"apiKeys",
"claudePlan",
"chatgptPlan"
]
},
"login": {
"type": "string",
"minLength": 1
},
"rateLimits": {
"$ref": "#/components/schemas/Agent_RateLimitsSnapshotEncoded"
}
},
"required": [
"_tag",
"session",
"pool",
"rateLimits"
],
"additionalProperties": false
}Agent_RateLimitsSnapshotEncoded
{
"type": "object",
"properties": {
"limitId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"limitName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"primary": {
"anyOf": [
{
"$ref": "#/components/schemas/Agent_RateLimitWindowEncoded"
},
{
"type": "null"
}
]
},
"secondary": {
"anyOf": [
{
"$ref": "#/components/schemas/Agent_RateLimitWindowEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"limitId",
"limitName",
"primary",
"secondary"
],
"additionalProperties": false
}Agent_RateLimitWindowEncoded
{
"type": "object",
"properties": {
"usedPercent": {
"type": "number"
},
"windowDurationMinutes": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"resetsAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"usedPercent",
"windowDurationMinutes",
"resetsAt"
],
"additionalProperties": false
}Agent_ToolFinishedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"ToolFinished"
]
},
"session": {
"anyOf": [
{
"$ref": "#/components/schemas/Agent_ParentSessionEncoded"
},
{
"$ref": "#/components/schemas/Agent_ChildSessionEncoded"
},
{
"$ref": "#/components/schemas/Agent_RoleSessionEncoded"
}
]
},
"callId": {
"type": "string",
"minLength": 1
},
"tool": {
"type": "string",
"minLength": 1
},
"output": {},
"isError": {
"type": "boolean"
}
},
"required": [
"_tag",
"session",
"callId",
"tool",
"output",
"isError"
],
"additionalProperties": false
}Agent_ToolStartedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"ToolStarted"
]
},
"session": {
"anyOf": [
{
"$ref": "#/components/schemas/Agent_ParentSessionEncoded"
},
{
"$ref": "#/components/schemas/Agent_ChildSessionEncoded"
},
{
"$ref": "#/components/schemas/Agent_RoleSessionEncoded"
}
]
},
"callId": {
"type": "string",
"minLength": 1
},
"tool": {
"type": "string",
"minLength": 1
},
"input": {}
},
"required": [
"_tag",
"session",
"callId",
"tool",
"input"
],
"additionalProperties": false
}Agent_TextOutputEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"TextOutput"
]
},
"session": {
"anyOf": [
{
"$ref": "#/components/schemas/Agent_ParentSessionEncoded"
},
{
"$ref": "#/components/schemas/Agent_ChildSessionEncoded"
},
{
"$ref": "#/components/schemas/Agent_RoleSessionEncoded"
}
]
},
"text": {
"type": "string",
"minLength": 1
}
},
"required": [
"_tag",
"session",
"text"
],
"additionalProperties": false
}Agent_SessionStartedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"SessionStarted"
]
},
"session": {
"anyOf": [
{
"$ref": "#/components/schemas/Agent_ParentSessionEncoded"
},
{
"$ref": "#/components/schemas/Agent_ChildSessionEncoded"
},
{
"$ref": "#/components/schemas/Agent_RoleSessionEncoded"
}
]
},
"prompt": {
"type": "string"
},
"harnessSession": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"cwd": {
"type": "string",
"minLength": 1
},
"home": {
"type": "string",
"minLength": 1
},
"modelProvider": {
"type": "string",
"minLength": 1
}
},
"required": [
"id",
"cwd"
],
"additionalProperties": false
}
},
"required": [
"_tag",
"session"
],
"additionalProperties": false
}AttemptChannel_StartedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Started"
]
},
"parentModel": {
"anyOf": [
{
"type": "string",
"pattern": "\\S"
},
{
"type": "null"
}
]
},
"conflictingSalvage": {
"anyOf": [
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Pushed"
]
},
"ref": {
"type": "string",
"minLength": 1
},
"commit": {
"type": "string",
"pattern": "^[0-9a-f]{40}(?:[0-9a-f]{24})?$"
}
},
"required": [
"_tag",
"ref",
"commit"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"_tag"
],
"additionalProperties": false
}_usine_orchestrator_CycleBudgetResetViewEncoded
{
"type": "object",
"properties": {
"replayedCiFixEventIds": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
}
},
"required": [
"replayedCiFixEventIds"
],
"additionalProperties": false
}_usine_orchestrator_SessionInterventionEncoded
{
"type": "object",
"properties": {
"attemptId": {
"type": "string",
"minLength": 1
},
"target": {
"anyOf": [
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Parent"
]
}
},
"required": [
"_tag"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Child"
]
},
"sessionId": {
"type": "string",
"minLength": 1
}
},
"required": [
"_tag",
"sessionId"
],
"additionalProperties": false
}
]
},
"action": {
"anyOf": [
{
"$ref": "#/components/schemas/AttemptChannel_SteerEncoded"
},
{
"$ref": "#/components/schemas/AttemptChannel_InterruptEncoded"
},
{
"$ref": "#/components/schemas/AttemptChannel_OperatorMessageEncoded"
},
{
"$ref": "#/components/schemas/AttemptChannel_ReleaseEncoded"
}
]
}
},
"required": [
"attemptId",
"action"
],
"additionalProperties": false
}_usine_engine_CycleBlockedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"CycleBlocked"
]
},
"eventId": {
"type": "string",
"minLength": 1
},
"ask": {
"$ref": "#/components/schemas/CycleBudgetAskEncoded"
}
},
"required": [
"_tag",
"eventId",
"ask"
],
"additionalProperties": false
}_usine_engine_ClaimedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Claimed"
]
},
"eventId": {
"type": "string",
"minLength": 1
},
"runId": {
"type": "string",
"minLength": 1
}
},
"required": [
"_tag",
"eventId",
"runId"
],
"additionalProperties": false
}_usine_orchestrator_EditAndRetryEncoded
{
"type": "object",
"properties": {
"task": {
"type": "string",
"pattern": "\\S"
},
"agent": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
}
},
"required": [
"task",
"agent"
],
"additionalProperties": false
}_usine_engine_AttentionKeyEncoded
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"revision": {
"type": "string",
"minLength": 1
}
},
"required": [
"id",
"revision"
],
"additionalProperties": false
}_usine_orchestrator_NeedsSetupOverviewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"NeedsSetup"
]
},
"identities": {
"type": "array",
"items": {
"type": "object",
"properties": {
"itemKey": {
"type": "string",
"minLength": 1
},
"kind": {
"type": "string",
"enum": [
"issue",
"pr"
]
},
"number": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"title": {
"type": "string"
},
"url": {
"type": "string",
"minLength": 1
},
"state": {
"type": "string",
"enum": [
"issue-open",
"issue-closed",
"pr-open",
"pr-closed",
"pr-merged"
]
},
"labels": {
"type": "array",
"items": {
"type": "string",
"pattern": "^\\S(?:.*\\S)?$",
"maxLength": 50
}
},
"conflicting": {
"type": "boolean"
},
"repository": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"itemKey": {
"type": "string",
"minLength": 1
},
"kind": {
"type": "string",
"enum": [
"issue",
"pr"
]
},
"number": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"title": {
"type": "string"
},
"url": {
"type": "string",
"minLength": 1
},
"state": {
"type": "string",
"enum": [
"issue-open",
"issue-closed",
"pr-open",
"pr-closed",
"pr-merged"
]
},
"labels": {
"type": "array",
"items": {
"type": "string",
"pattern": "^\\S(?:.*\\S)?$",
"maxLength": 50
}
},
"conflicting": {
"type": "boolean"
}
},
"required": [
"itemKey",
"kind",
"number",
"title",
"url",
"state",
"labels",
"conflicting"
],
"additionalProperties": false
},
"minItems": 1
}
},
"required": [
"itemKey",
"kind",
"number",
"title",
"url",
"state",
"labels",
"conflicting",
"repository",
"items"
],
"additionalProperties": false
}
},
"errorTag": {
"type": "string",
"minLength": 1
},
"projects": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_ProjectViewEncoded"
}
},
"loops": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_LoopViewEncoded"
}
},
"needsYou": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_UpgradeDrainNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_WebhookSilenceNeedEncoded"
},
{
"$ref": "#/components/schemas/CycleBudgetNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ApprovalNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_BoardProjectionNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_RunFailureNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_PollFailureNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_PreflightFindingNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ScheduleFailureNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ConfigFileNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_UnconfiguredWorkerNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_UnconfirmedStopNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_UnresponsiveWorkerNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_WorkerPreflightNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_WorkerQuotaNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_WorkerPausedNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_PoolLimitNeedEncoded"
}
]
}
},
"dismissedNeeds": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_UpgradeDrainNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_WebhookSilenceNeedEncoded"
},
{
"$ref": "#/components/schemas/CycleBudgetNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ApprovalNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_BoardProjectionNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_RunFailureNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_PollFailureNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_PreflightFindingNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ScheduleFailureNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ConfigFileNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_UnconfiguredWorkerNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_UnconfirmedStopNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_UnresponsiveWorkerNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_WorkerPreflightNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_WorkerQuotaNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_WorkerPausedNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_PoolLimitNeedEncoded"
}
]
}
}
},
"required": [
"_tag",
"errorTag",
"projects",
"loops",
"needsYou",
"dismissedNeeds"
],
"additionalProperties": false
}_usine_orchestrator_PoolLimitNeedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"PoolLimitNeed"
]
},
"id": {
"type": "string"
},
"pool": {
"type": "string",
"enum": [
"apiKeys",
"claudePlan",
"chatgptPlan"
]
},
"login": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"window": {
"type": "string",
"enum": [
"primary",
"secondary"
]
},
"usedPercent": {
"type": "number",
"minimum": 80
},
"resetsAt": {
"type": "string"
}
},
"required": [
"_tag",
"id",
"pool",
"login",
"window",
"usedPercent",
"resetsAt"
],
"additionalProperties": false
}_usine_orchestrator_WorkerPausedNeedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"WorkerPausedNeed"
]
},
"id": {
"type": "string"
},
"worker": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
}
},
"required": [
"_tag",
"id",
"worker"
],
"additionalProperties": false
}_usine_orchestrator_WorkerQuotaNeedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"WorkerQuotaNeed"
]
},
"id": {
"type": "string"
},
"worker": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"message": {
"type": "string"
}
},
"required": [
"_tag",
"id",
"worker",
"message"
],
"additionalProperties": false
}_usine_orchestrator_WorkerPreflightNeedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"WorkerPreflightNeed"
]
},
"id": {
"type": "string"
},
"worker": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"message": {
"type": "string"
}
},
"required": [
"_tag",
"id",
"worker",
"message"
],
"additionalProperties": false
}_usine_orchestrator_UnresponsiveWorkerNeedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"UnresponsiveWorkerNeed"
]
},
"id": {
"type": "string"
},
"worker": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"lastAnsweredAt": {
"type": "string"
},
"attempts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attemptId": {
"type": "string",
"minLength": 1
},
"attemptNumber": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"runId": {
"type": "string",
"minLength": 1
},
"repository": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
},
"loop": {
"type": "string",
"minLength": 1
}
},
"required": [
"attemptId",
"attemptNumber",
"runId",
"repository",
"loop"
],
"additionalProperties": false
},
"minItems": 1
}
},
"required": [
"_tag",
"id",
"worker",
"lastAnsweredAt",
"attempts"
],
"additionalProperties": false
}_usine_orchestrator_UnconfirmedStopNeedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"UnconfirmedStopNeed"
]
},
"id": {
"type": "string"
},
"repository": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
},
"runId": {
"type": "string",
"minLength": 1
},
"loop": {
"type": "string",
"minLength": 1
},
"attemptNumber": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"worker": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
}
},
"required": [
"_tag",
"id",
"repository",
"runId",
"loop",
"attemptNumber",
"worker"
],
"additionalProperties": false
}_usine_orchestrator_UnconfiguredWorkerNeedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"UnconfiguredWorkerNeed"
]
},
"id": {
"type": "string"
},
"worker": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"attempts": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"running": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"_tag",
"id",
"worker",
"attempts",
"running"
],
"additionalProperties": false
}_usine_orchestrator_ConfigFileNeedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"ConfigFileNeed"
]
},
"id": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"loop",
"agent"
]
},
"error": {
"$ref": "#/components/schemas/_usine_config_ConfigFileErrorEncoded"
}
},
"required": [
"_tag",
"id",
"kind",
"error"
],
"additionalProperties": false
}_usine_orchestrator_ScheduleFailureNeedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"ScheduleFailureNeed"
]
},
"id": {
"type": "string"
},
"failure": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_ScheduleAgentFailureEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ScheduleCronFailureEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ScheduleTickFailureEncoded"
}
]
}
},
"required": [
"_tag",
"id",
"failure"
],
"additionalProperties": false
}_usine_orchestrator_ScheduleTickFailureEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"ScheduleTickFailure"
]
},
"loop": {
"type": "string",
"minLength": 1
},
"repository": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
},
"scheduledAt": {
"type": "string"
},
"errorTag": {
"type": "string",
"minLength": 1
},
"message": {
"type": "string"
}
},
"required": [
"_tag",
"loop",
"repository",
"scheduledAt",
"errorTag",
"message"
],
"additionalProperties": false
}_usine_orchestrator_ScheduleCronFailureEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"ScheduleCronFailure"
]
},
"loop": {
"type": "string",
"minLength": 1
},
"cron": {
"type": "string"
},
"tz": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"_tag",
"loop",
"cron",
"tz",
"message"
],
"additionalProperties": false
}_usine_orchestrator_ScheduleAgentFailureEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"ScheduleAgentFailure"
]
},
"loop": {
"type": "string",
"minLength": 1
},
"agent": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"message": {
"type": "string"
}
},
"required": [
"_tag",
"loop",
"agent",
"message"
],
"additionalProperties": false
}_usine_orchestrator_PreflightFindingNeedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"PreflightFindingNeed"
]
},
"id": {
"type": "string"
},
"finding": {
"$ref": "#/components/schemas/_usine_orchestrator_LabelPreflightFindingEncoded"
}
},
"required": [
"_tag",
"id",
"finding"
],
"additionalProperties": false
}_usine_orchestrator_PollFailureNeedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"PollFailureNeed"
]
},
"id": {
"type": "string"
},
"failure": {
"$ref": "#/components/schemas/_usine_orchestrator_RepositoryPollFailureEncoded"
}
},
"required": [
"_tag",
"id",
"failure"
],
"additionalProperties": false
}_usine_orchestrator_RepositoryPollFailureEncoded
{
"type": "object",
"properties": {
"repository": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
},
"errorTag": {
"type": "string",
"minLength": 1
},
"message": {
"type": "string"
}
},
"required": [
"repository",
"errorTag",
"message"
],
"additionalProperties": false
}_usine_orchestrator_RunFailureNeedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"RunFailureNeed"
]
},
"id": {
"type": "string"
},
"repository": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
},
"runId": {
"type": "string",
"minLength": 1
},
"loop": {
"type": "string",
"minLength": 1
},
"failure": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_GitHubPushFailureViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_InfraFailureViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ProviderCapacityFailureViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_DefectFailureViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_AgentFailureViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_BlockedFailureViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_QuestionFailureViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_RunawayFailureViewEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ChildSessionBudgetFailureViewEncoded"
}
]
},
"fixRun": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_engine_CiFixRunEncoded"
},
{
"type": "null"
}
]
},
"unfinishedCiAttemptId": {
"type": "string",
"minLength": 1
}
},
"required": [
"_tag",
"id",
"repository",
"runId",
"loop",
"failure",
"fixRun"
],
"additionalProperties": false
}_usine_engine_CiFixRunEncoded
{
"type": "object",
"properties": {
"runId": {
"type": "string",
"minLength": 1
},
"state": {
"type": "string",
"enum": [
"Pending",
"Waiting",
"Queued",
"Running",
"AwaitingCi",
"Succeeded",
"HandedOff",
"Failed"
]
}
},
"required": [
"runId",
"state"
],
"additionalProperties": false
}_usine_orchestrator_BoardProjectionNeedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"BoardProjectionNeed"
]
},
"id": {
"type": "string"
},
"failure": {
"$ref": "#/components/schemas/_usine_orchestrator_BoardProjectionErrorEncoded"
}
},
"required": [
"_tag",
"id",
"failure"
],
"additionalProperties": false
}_usine_orchestrator_ApprovalNeedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"ApprovalNeed"
]
},
"id": {
"type": "string"
},
"repository": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
},
"runId": {
"type": "string",
"minLength": 1
},
"approvalReason": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"loop": {
"type": "string",
"minLength": 1
},
"item": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_BoardItemLinkEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"_tag",
"id",
"repository",
"runId",
"loop",
"item"
],
"additionalProperties": false
}CycleBudgetNeedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"CycleBudgetNeed"
]
},
"id": {
"type": "string"
},
"ask": {
"$ref": "#/components/schemas/CycleBudgetAskEncoded"
},
"itemLabel": {
"type": "string"
},
"itemUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"_tag",
"id",
"ask",
"itemLabel",
"itemUrl"
],
"additionalProperties": false
}_usine_orchestrator_WebhookSilenceNeedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"WebhookSilenceNeed"
]
},
"id": {
"type": "string"
},
"startedAt": {
"type": "string"
},
"publicUrl": {
"type": "string"
}
},
"required": [
"_tag",
"id",
"startedAt",
"publicUrl"
],
"additionalProperties": false
}_usine_orchestrator_UpgradeDrainNeedEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"UpgradeDrainNeed"
]
},
"id": {
"type": "string"
},
"wait": {
"$ref": "#/components/schemas/_usine_engine_UpgradeWaitEncoded"
},
"deferredRuns": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
},
"required": [
"_tag",
"id",
"wait",
"deferredRuns"
],
"additionalProperties": false
}_usine_orchestrator_LoopViewEncoded
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"trigger": {
"type": "string"
},
"agent": {
"type": "string",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"paused": {
"type": "boolean"
}
},
"required": [
"name",
"trigger",
"agent",
"paused"
],
"additionalProperties": false
}_usine_orchestrator_ReadyOverviewEncoded
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Ready"
]
},
"identities": {
"type": "array",
"items": {
"type": "object",
"properties": {
"itemKey": {
"type": "string",
"minLength": 1
},
"kind": {
"type": "string",
"enum": [
"issue",
"pr"
]
},
"number": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"title": {
"type": "string"
},
"url": {
"type": "string",
"minLength": 1
},
"state": {
"type": "string",
"enum": [
"issue-open",
"issue-closed",
"pr-open",
"pr-closed",
"pr-merged"
]
},
"labels": {
"type": "array",
"items": {
"type": "string",
"pattern": "^\\S(?:.*\\S)?$",
"maxLength": 50
}
},
"conflicting": {
"type": "boolean"
},
"repository": {
"type": "string",
"pattern": "^[A-Za-z0-9_.-]+\\/[A-Za-z0-9_.-]+$"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"itemKey": {
"type": "string",
"minLength": 1
},
"kind": {
"type": "string",
"enum": [
"issue",
"pr"
]
},
"number": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"title": {
"type": "string"
},
"url": {
"type": "string",
"minLength": 1
},
"state": {
"type": "string",
"enum": [
"issue-open",
"issue-closed",
"pr-open",
"pr-closed",
"pr-merged"
]
},
"labels": {
"type": "array",
"items": {
"type": "string",
"pattern": "^\\S(?:.*\\S)?$",
"maxLength": 50
}
},
"conflicting": {
"type": "boolean"
}
},
"required": [
"itemKey",
"kind",
"number",
"title",
"url",
"state",
"labels",
"conflicting"
],
"additionalProperties": false
},
"minItems": 1
}
},
"required": [
"itemKey",
"kind",
"number",
"title",
"url",
"state",
"labels",
"conflicting",
"repository",
"items"
],
"additionalProperties": false
}
},
"projects": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_ProjectViewEncoded"
}
},
"loops": {
"type": "array",
"items": {
"$ref": "#/components/schemas/_usine_orchestrator_LoopViewEncoded"
}
},
"needsYou": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_UpgradeDrainNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_WebhookSilenceNeedEncoded"
},
{
"$ref": "#/components/schemas/CycleBudgetNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ApprovalNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_BoardProjectionNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_RunFailureNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_PollFailureNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_PreflightFindingNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ScheduleFailureNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ConfigFileNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_UnconfiguredWorkerNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_UnconfirmedStopNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_UnresponsiveWorkerNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_WorkerPreflightNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_WorkerQuotaNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_WorkerPausedNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_PoolLimitNeedEncoded"
}
]
}
},
"dismissedNeeds": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_orchestrator_UpgradeDrainNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_WebhookSilenceNeedEncoded"
},
{
"$ref": "#/components/schemas/CycleBudgetNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ApprovalNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_BoardProjectionNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_RunFailureNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_PollFailureNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_PreflightFindingNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ScheduleFailureNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_ConfigFileNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_UnconfiguredWorkerNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_UnconfirmedStopNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_UnresponsiveWorkerNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_WorkerPreflightNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_WorkerQuotaNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_WorkerPausedNeedEncoded"
},
{
"$ref": "#/components/schemas/_usine_orchestrator_PoolLimitNeedEncoded"
}
]
}
}
},
"required": [
"_tag",
"projects",
"loops",
"needsYou",
"dismissedNeeds"
],
"additionalProperties": false
}_usine_orchestrator_UpgradeRequestEncoded
{
"type": "object",
"properties": {
"timing": {
"type": "string",
"enum": [
"idle",
"now"
]
},
"version": {
"type": "string",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-(?:0|[1-9]\\d*|\\d*[A-Za-z-][0-9A-Za-z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[A-Za-z-][0-9A-Za-z-]*))*)?(?:\\+[0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*)?$"
}
},
"required": [
"timing"
],
"additionalProperties": false
}_usine_orchestrator_UpgradeViewEncoded
{
"type": "object",
"properties": {
"running": {
"type": "string"
},
"channel": {
"type": "string",
"enum": [
"latest",
"next"
]
},
"mode": {
"type": "string",
"enum": [
"off",
"propose",
"automatic"
]
},
"supported": {
"type": "boolean"
},
"available": {
"anyOf": [
{
"type": "string",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-(?:0|[1-9]\\d*|\\d*[A-Za-z-][0-9A-Za-z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[A-Za-z-][0-9A-Za-z-]*))*)?(?:\\+[0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*)?$"
},
{
"type": "null"
}
]
},
"phase": {
"type": "string",
"enum": [
"idle",
"waiting",
"installing",
"failed"
]
},
"target": {
"anyOf": [
{
"type": "string",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-(?:0|[1-9]\\d*|\\d*[A-Za-z-][0-9A-Za-z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[A-Za-z-][0-9A-Za-z-]*))*)?(?:\\+[0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*)?$"
},
{
"type": "null"
}
]
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"outcome": {
"anyOf": [
{
"$ref": "#/components/schemas/_usine_core_UpgradeInstallingEncoded"
},
{
"$ref": "#/components/schemas/_usine_core_UpgradeGoodEncoded"
},
{
"$ref": "#/components/schemas/_usine_core_UpgradeRolledBackEncoded"
},
{
"$ref": "#/components/schemas/_usine_core_UpgradeFailedEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"running",
"channel",
"mode",
"supported",
"available",
"phase",
"message",
"outcome"
],
"additionalProperties": false
}_usine_core_UpgradeFailedEncoded
{
"type": "object",
"properties": {
"previous": {
"type": "string",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-(?:0|[1-9]\\d*|\\d*[A-Za-z-][0-9A-Za-z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[A-Za-z-][0-9A-Za-z-]*))*)?(?:\\+[0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*)?$"
},
"target": {
"type": "string",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-(?:0|[1-9]\\d*|\\d*[A-Za-z-][0-9A-Za-z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[A-Za-z-][0-9A-Za-z-]*))*)?(?:\\+[0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*)?$"
},
"status": {
"type": "string",
"enum": [
"failed"
]
},
"reason": {
"type": "string",
"minLength": 1
}
},
"required": [
"previous",
"target",
"status",
"reason"
],
"additionalProperties": false
}_usine_core_UpgradeRolledBackEncoded
{
"type": "object",
"properties": {
"previous": {
"type": "string",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-(?:0|[1-9]\\d*|\\d*[A-Za-z-][0-9A-Za-z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[A-Za-z-][0-9A-Za-z-]*))*)?(?:\\+[0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*)?$"
},
"target": {
"type": "string",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-(?:0|[1-9]\\d*|\\d*[A-Za-z-][0-9A-Za-z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[A-Za-z-][0-9A-Za-z-]*))*)?(?:\\+[0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*)?$"
},
"status": {
"type": "string",
"enum": [
"rolled-back"
]
},
"reason": {
"type": "string",
"minLength": 1
},
"failureStage": {
"type": "string",
"enum": [
"install",
"health-check",
"unknown"
]
}
},
"required": [
"previous",
"target",
"status",
"reason"
],
"additionalProperties": false
}_usine_core_UpgradeGoodEncoded
{
"type": "object",
"properties": {
"previous": {
"type": "string",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-(?:0|[1-9]\\d*|\\d*[A-Za-z-][0-9A-Za-z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[A-Za-z-][0-9A-Za-z-]*))*)?(?:\\+[0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*)?$"
},
"target": {
"type": "string",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-(?:0|[1-9]\\d*|\\d*[A-Za-z-][0-9A-Za-z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[A-Za-z-][0-9A-Za-z-]*))*)?(?:\\+[0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*)?$"
},
"status": {
"type": "string",
"enum": [
"good"
]
}
},
"required": [
"previous",
"target",
"status"
],
"additionalProperties": false
}_usine_core_UpgradeInstallingEncoded
{
"type": "object",
"properties": {
"previous": {
"type": "string",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-(?:0|[1-9]\\d*|\\d*[A-Za-z-][0-9A-Za-z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[A-Za-z-][0-9A-Za-z-]*))*)?(?:\\+[0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*)?$"
},
"target": {
"type": "string",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-(?:0|[1-9]\\d*|\\d*[A-Za-z-][0-9A-Za-z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[A-Za-z-][0-9A-Za-z-]*))*)?(?:\\+[0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*)?$"
},
"status": {
"type": "string",
"enum": [
"installing"
]
}
},
"required": [
"previous",
"target",
"status"
],
"additionalProperties": false
}Change notices and conditional reads
Section titled “Change notices and conditional reads”GET /api/changes returns text/event-stream. A change event contains {revision, reset, changes}, where each change has a kind and an entity id. Notice kinds include projects, items, runs, attempts, workers, configuration, attention, navigation, and activity. Notices contain identifiers only. Event IDs increase monotonically. Send Last-Event-ID to resume; a reset: true notice requests fresh reads when the cursor is unavailable. The server retains the latest 256 notices and filters live delivery and replay by the current permissions. Idle streams send a heartbeat every 15 seconds without computing read projections. Invalid or expired cursors, server restarts, and subscribers that fall behind produce a reset.
Successful operator JSON reads return an ETag. Authentication and setup responses use Cache-Control: no-store. Send it as If-None-Match; an unchanged response returns HTTP 304 with no body. Validators are private to the authenticated representation.
X-Usine-View: shell on /api/overview returns navigation and compact task identities. X-Usine-View: attention returns attention entries. X-Usine-View: board on /api/projects/:project returns settled lane counts; read their cards from /api/projects/:project/lanes/:lane/items?offset=0 in pages of 50. X-Usine-View: task on a repository task read returns the first 25 runs and runsTotal; read subsequent pages from /api/projects/:owner/:repository/tasks/:item/runs?offset=25. Page responses include nextOffset, which is null at the end. GET /api/workers returns worker configuration and slot usage.
The board representation includes board.cardedItemKeys for every linked item with a card, including cards in unloaded pages. Use these keys to distinguish runs without cards from runs on paginated cards.