Runner Jobs REST API
Claim a job
⚠️ Breaking Changes: The Bencher API is in beta and under active development. We may introduce breaking changes in future releases. We will announce any breaking changes in the release notes.
➕ Bencher Plus: Long-poll to claim a pending job for execution. Authenticated via runner token. Returns a job if one is available, or empty response on timeout.
Headers
Content-Type string
Required
Set to application/json.
Authorization string
Required
Set to Bearer BENCHER_API_TOKEN, where BENCHER_API_TOKEN is a vaild Bencher API token.
Path Parameters
runnerRequired
The slug or UUID for a runner.
Body Parameters
poll_timeoutinteger
Maximum time to wait for a job (long-poll), in seconds (1-900)
POST
/v0/runners/{runner}/jobs | Bencher Cloud | https://api.bencher.dev |
| Bencher Self-Hosted | http://localhost:61016 |
View OpenAPI Spec
WebSocket channel for job execution
⚠️ Breaking Changes: The Bencher API is in beta and under active development. We may introduce breaking changes in future releases. We will announce any breaking changes in the release notes.
➕ Bencher Plus: Establishes a persistent connection for heartbeat and status updates. Authentication is via runner token in the Authorization header.
Headers
Content-Type string
Required
Set to application/json.
Authorization string
Required
Set to Bearer BENCHER_API_TOKEN, where BENCHER_API_TOKEN is a vaild Bencher API token.
Path Parameters
jobstring
Required
The UUID for a job.
runnerRequired
The slug or UUID for a runner.
GET
/v0/runners/{runner}/jobs/{job} | Bencher Cloud | https://api.bencher.dev |
| Bencher Self-Hosted | http://localhost:61016 |
View OpenAPI Spec