RunWhen workspaces API is one of 51 APIs that RunWhen publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Workspaces. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
80 operations
across 72 paths,
and defines 55 schemas.
It is described by OpenAPI 3.2.0, at version 2.0.0.
Requests are made against a single base URL, https://papi.beta.runwhen.com.
The identity and technical contract details declared by the specification.
TaskSearchRequest
object
Request for workspace task search.
4 properties
1 required
WorkspaceSpec
object
Workspace spec (reconstructed from individual columns for UI compatibility). The Django model stores all these in a body.spec JSON field. The FastAPI model sto…
8 properties
SearchScopeResponse
object
Search scope response.
3 properties
SloAlertInWorkspace
object
SLO firing alert for workspace response.
9 properties
4 required
HTTPValidationError
object
1 property
WorkspaceUpdate
object
Schema for updating a workspace (partial update). All fields are optional; only non-None values are applied.
8 properties
MergeModeEnum
string
Merge mode for workspace upload.
SecretsKeysResponse
object
Response containing list of secret key names.
1 property
SecretDeleteResponse
object
Response after deleting a single workspace secret.
3 properties
2 required
_ProvisioningStages
object
6 properties
SlxSpecInWorkspace
object
SLX spec for workspace response (matches frontend SlxSpec interface).
8 properties
RunbookInWorkspace
object
Runbook schema for workspace response with tasks.
6 properties
3 required
AnonymousModeResponse
object
Response for anonymous mode toggle.
3 properties
3 required
AnonymousModeRequest
object
Request body for toggling anonymous mode.
1 property
1 required
UploadConfigResponse
object
Response containing upload credentials and PAPI URL for workspace-builder.
2 properties
2 required
ReprovisionWorkspaceInfraResponse
object
Response from reprovisioning workspace runner infrastructure.
3 properties
3 required
WorkspaceUploadResponse
object
Schema for workspace upload response.
3 properties
1 required
WorkspacePermissionUpdate
object
A single permission entry for workspace update requests. Mirrors WorkspaceSpecPermission but is used for incoming PATCH payloads. Either user (email) or group…
3 properties
1 required
WorkspaceSpecPermission
object
AutocompleteRequest
object
Request for search autocomplete.
1 property
1 required
ResetServiceAccountResponse
object
Response from resetting a service account.
2 properties
1 required
OwnerResponse
object
Schema for owner info in workspace response.
3 properties
1 required
GalleryUser
object
Schema for user info in workspace gallery.
3 properties
1 required
UploadStatusResponse
object
Schema for upload status check response.
4 properties
2 required
WorkspaceUploadRequest
object
Schema for workspace upload request (matches runner format).
7 properties
1 required
RunbookTaskInWorkspace
object
Individual task in a runbook for workspace response.
4 properties
2 required
ResourceScrubberConfigEnum
string
Configuration for resource scrubbing before LLM calls.
GalleryPersona
object
Schema for persona info in workspace gallery.
3 properties
2 required
SecretUsageResponse
object
Response listing where a workspace secret is referenced.
2 properties
1 required
ResetServiceAccountRequest
object
Request to reset a workspace service account password.
1 property
1 required
WorkspaceStatusResponse
object
Response for workspace creation status check.
2 properties
2 required
WorkspaceGitCreate
object
Schema for Git-first workspace creation.
2 properties
1 required
SlxTag
object
Tag with name-value structure for SLX.
2 properties
2 required
SecretsCreateResponse
object
Response after creating/updating secrets.
3 properties
SloBasicInWorkspace
object
Basic SLO info for workspace SLX response (matches Django SloSerializer).
8 properties
3 required
_ProvisioningStatusResponse
object
4 properties
ValidationError
object
5 properties
3 required
SecretsCreateRequest
object
Request to create/update workspace secrets.
1 property
1 required
SearchScopeSlx
object
SLX item in search scope.
10 properties
3 required
WorkspaceListResponse
object
Schema for paginated workspace list response.
4 properties
2 required
WorkspaceCreateResponse
object
Response for workspace creation. Synchronous creation returns status="ready". Async GitOps-based creation (if re-enabled) returns status="provisioning" and req…
4 properties
3 required
WorkspaceDeletionResponse
object
Response from workspace deletion endpoint.
4 properties
3 required
DeletionStep
object
Status of a single deletion step.
4 properties
3 required
FinalizeActionEnum
string
Finalize action after workspace upload.
WorkspaceResponse
object
Schema for workspace response with all fields (camelCase for UI).
33 properties
2 required
AnonymousModeStatusResponse
object
Response for anonymous mode status check.
2 properties
2 required
SearchScopeGroup
object
SLX group in search scope.
3 properties
1 required
SATokenResponse
object
Response containing a service account token.
1 property
1 required
WorkspaceRoleEnum
string
Workspace permission roles.
SecretUsageItem
object
A single SLI/Runbook that references a workspace secret.
3 properties
3 required
SlxInWorkspace
object
SLX summary for workspace response (camelCase for UI compatibility).
15 properties
3 required
SliAlertInWorkspace
object
SLI firing alert for workspace response.
7 properties
4 required
SliBasicInWorkspace
object
Basic SLI info for workspace SLX response (matches Django SliSerializer).
5 properties
3 required
AuthorizedRunner
object
Authorized runner for a workspace.
5 properties
2 required
RunSessionCount
object
Schema for run session count by date.
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs RunWhen publishes across the network.