Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
Skip to Content
PricingDashboard
GuidesAPI ReferenceCLI
API ReferenceProvidersProvider

Get the one-command node installer

Returns a self-contained shell installer, run on the host with curl piped to sudo bash, that enrolls the machine as a provider node in the community pool. With a bearer org API key it mints a fresh provisioning token (24 hours, any number of nodes); with ?token=otk_… (e.g. minted from the dashboard) it self-auths and embeds that token instead. name only applies when minting (the token already carries it). The runtime is detected on the box, not chosen here: a bare metal host enrolls as a qemu VM host with VFIO passthrough, and a virtualised guest enrolls as a runc pod host on its native NVIDIA or AMD driver.

Required permission

With an API key: checked against the provider.write permission for the resource it acts on. See Permissions for the roles and API key permissions that include it.

GET
/v1/provider/bootstrap

Authorization

apiKey
headerAuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer or_… (legacy vl_… keys still work).

Query Parameters

token?string

Pre-minted provisioning token (otk_…); replaces bearer auth

gpu?string

Accepted for backward compatibility and ignored; it selects nothing. The installer detects the runtime on the box (systemd-detect-virt) and takes --gpu only to discard it.

name?string

Token label; mint path only

Response Body

The installer script (contains a secret provisioning token, never cached)

response?stringtext/x-shellscript
Example Request
curl -X GET 'https://api.openrelay.inc/v1/provider/bootstrap'
Example Response
"string"

Overview

For GPU providers: applications, nodes, provisioning tokens, and earnings, plus the one-command node installer, node lifecycle status and offboarding.

Get the interruptible container installer GET

Returns a POSIX sh installer that enrolls the container it runs in as an interruptible node. It needs no root, systemd or capabilities to run. Run it inside the container as `curl -fsSL "<url>" | sh` or `wget -qO- "<url>" | sh`. It downloads the interruptible agent for the container's architecture, verifies its sha256, and runs it; the agent enrolls the container and detaches. The token must be an interruptible one (orl provider provisioning-token create --class interruptible).