Skip to content

Schemas

Every type of the API contract (openapi/openapi.yaml). The server also serves this document at /api/v1/openapi.yaml and /api/v1/openapi.json.

Schema Description
ErrorCode Stable machine-readable error code.
ErrorResponse
HealthResponse
SandboxProfile Versioned seccomp policy.
FileId Lowercase hex SHA-256 of the file content
InlineFile
FileReference
FileInput A file to create in the workspace before the task starts.
Task
ParallelStep Tasks that run concurrently.
Step
StepList
ExecuteRequest
TaskOutcome How the task ended
TaskStats
CompletedTaskResult The task's process was created; its exit status and output are reported.
FailedTaskResult The task did not run to an exit status: its sandbox could not be set up for it (for example a missing working_dir, outcome infrastructure_failure), or it never started because an earlier step failed (stop_on_failure) or the overall deadline had passed (outcome not_started).
TaskResult
StepResult
StepResultList
CacheSummary
ExecuteResponse
UploadResponse
FileInfo
FileList
CacheClearResponse
Toolchain
ServiceLimits Limits applied to every task; requests cannot raise them.
ServiceInfo