How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OpenRelay Runners API

Managed GitHub Actions runner pools.

OpenRelay Runners API is one of 19 APIs that OpenRelay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Runners. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 9 operations across 7 paths, and defines 15 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

Requests are made against 3 base URLs: https://api.openrelay.inc, https://api.beta.openrelay.inc, http://localhost:8083.

9 operations 7 paths 15 schemas 1 DELETE5 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Base URL
https://api.openrelay.inc
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

OpenRelay Runners API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (apiKey).

  • apiKey — OpenRelay API key. Send it as Authorization: Bearer vl….

Paths & Operations 9

Across 7 paths, the API surfaces 9 operations — 1 DELETE, 5 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Runners 9

Managed GitHub Actions runner pools.

GET
/v1/orgs/{orgId}/runner-pools
List runner pools (with active/queued usage)
listRunnerPools 1 param → 200401403
POST
/v1/orgs/{orgId}/runner-pools
Create a runner pool
createRunnerPool 1 param body → 200400401403
GET
/v1/orgs/{orgId}/runner-pools/connect-url
GitHub connect URL (OAuth authorize when configured, else App install)
getRunnerConnectUrl 1 param → 200401403
POST
/v1/orgs/{orgId}/runner-pools/installations
List GitHub installations the user can connect (OAuth code exchange)
listRunnerInstallations 1 param body → 200400401403
DELETE
/v1/orgs/{orgId}/runner-pools/{id}
Delete (or drain) a runner pool
deleteRunnerPool 2 params → 200401403404
GET
/v1/orgs/{orgId}/runner-pools/{id}
Get a runner pool (with usage)
getRunnerPool 2 params → 200401403404
GET
/v1/orgs/{orgId}/runner-pools/{id}/jobs
List runner jobs for a pool
listRunnerJobs 4 params → 200400401403404
GET
/v1/orgs/{orgId}/runner-pools/{id}/metrics
Runner pool job metrics (last 30 days) + cost comparison
getRunnerJobMetrics 2 params → 200401403404
POST
/v1/orgs/{orgId}/runner-pools/{id}/resize
Resize a runner pool's RAM tier
resizeRunnerPool 2 params body → 200400401403404

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are RunnerPoolItem (19 properties), RunnerPool (15 properties), RunnerJob (15 properties), CreateRunnerPoolRequest (7 properties). Each schema is shown below with its type and property counts.

DeleteRunnerPoolResult
object
1 property 1 required
Error
object
2 properties 1 required
RunnerPool
object
15 properties 11 required
RunnerJob
object
15 properties 7 required
RunnerInstallationsRequest
object
2 properties 1 required
ResizeRunnerPoolRequest
object
1 property 1 required
RunnerMetricsCost
object
3 properties 3 required
RunnerPoolItem
object
19 properties 15 required
RunnerMetricsDaily
object
5 properties 5 required
RunnerMetricsSummary
object
5 properties 5 required
RunnerInstallation
object
5 properties 5 required
RunnerInstallationsResult
object
1 property 1 required
RunnerConnectUrl
object
3 properties 3 required
CreateRunnerPoolRequest
object
7 properties 1 required
RunnerMetrics
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openrelay-runners-api-openapi.yml Raw ↑

Other APIs OpenRelay publishes across the network.

OpenRelay Inference API
OpenRelay Account API
OpenRelay API Keys API
OpenRelay Batches API
OpenRelay Billing API
OpenRelay Catalog API
OpenRelay Clusters API
OpenRelay Files API
OpenRelay Internal API
OpenRelay Organizations API
OpenRelay Provider API
OpenRelay Registry Credentials API
Where this information came from

This is an independent, third-party profile of OpenRelay Runners API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.