Skip to content

OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.

API Reference Pricing Dashboard

API Reference Pricing Dashboard

Getting Started

Introduction Quickstart Authentication VM billing and burn rate Providers Provider nodes Errors Pagination

Command Line

Inference API

API Reference

Overview List runner pools (with active/queued usage) GET Create a runner pool POST GitHub connect URL (OAuth authorize when configured, else App install) GET List GitHub installations the user can connect (OAuth code exchange) POST Get a runner pool (with usage) GET Delete (or drain) a runner pool DELETE Resize a runner pool's RAM tier POST List runner jobs for a pool GET Runner pool job metrics (last 30 days) + cost comparison GET

Runners

Overview

Managed GitHub Actions runner pools.

Runners

Managed GitHub Actions runner pools.

Create a runner pool

Delete (or drain) a runner pool

Get a runner pool (with usage)

GitHub connect URL (OAuth authorize when configured, else App install)

List GitHub installations the user can connect (OAuth code exchange)

List runner jobs for a pool

List runner pools (with active/queued usage)

Resize a runner pool's RAM tier

Runner pool job metrics (last 30 days) + cost comparison

Provider earnings from usage records (+ payout history) GET

Previous Page

List runner pools (with active/queued usage) GET

Next Page

On this page