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 VMs API

GPU virtual machines: lifecycle, disks, SSH access, and console links.

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

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

This API exposes 14 operations across 13 paths, and defines 14 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.

14 operations 13 paths 14 schemas 6 GET8 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 VMs 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 14

Across 13 paths, the API surfaces 14 operations — 6 GET, 8 POST. Each is listed below with its method, path, parameters, and response codes.

VMs 14

GPU virtual machines: lifecycle, disks, SSH access, and console links.

GET
/v1/orgs/{orgId}/vms
List an org's VMs (cursor-paginated)
listOrgVms 3 params → 200400401403
POST
/v1/orgs/{orgId}/vms/create
Create a VM
createVm 1 param body → 200400401403409
GET
/v1/vms/{id}
Get a VM by id
getVm 1 param → 200401403404
GET
/v1/vms/{id}/burn
Live burn rate, session cost so far, and org runway for a VM
getVmBurn 1 param → 200401403404
GET
/v1/vms/{id}/detail
Get a VM with its GPU/node/template info and price
getVmDetail 1 param → 200401403404
POST
/v1/vms/{id}/reboot
Reboot a VM
rebootVm 1 param → 204400401403404
POST
/v1/vms/{id}/resize-disk
Resize a stopped VM's disk
resizeVmDisk 1 param body → 204400401403404
POST
/v1/vms/{id}/restart
Restart a VM
restartVm 1 param → 200401403404409
GET
/v1/vms/{id}/ssh-keys
SSH keys attached to a VM + the org's keys
getVmSshKeys 1 param → 200401403404
POST
/v1/vms/{id}/ssh-keys
Attach an org SSH key to a VM
attachVmSshKey 1 param body → 204400401403404
POST
/v1/vms/{id}/stop
Stop a VM
stopVm 1 param → 200401403404409
GET
/v1/vms/{id}/telegram-link
Get a VM's embedded Telegram link
getVmTelegramLink 1 param → 200401403404
POST
/v1/vms/{id}/terminate
Terminate a VM
terminateVm 1 param → 200401403404
POST
/v1/vms/{id}/visibility
Set a VM's endpoint visibility
setVmVisibility 1 param body → 200400401403404

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are VmDetail (38 properties), CreateVmRequest (22 properties), VmSummary (17 properties), VmBurn (14 properties). Each schema is shown below with its type and property counts.

VmDetail
object
38 properties 11 required
CreateVmRequest
object
22 properties 1 required
Error
object
2 properties 1 required
VmPage
object
2 properties 1 required
VmSummary
object
17 properties 4 required
TelegramLinkResult
object
6 properties 1 required
VmTemplateInfo
object
3 properties 2 required
VmSshKeyItem
object
6 properties 5 required
VmBurn
object
14 properties 10 required
ResizeDiskRequest
object
1 property 1 required
VmNodeInfo
object
2 properties 1 required
AttachSshKeyRequest
object
1 property 1 required
VmGpuInfo
object
3 properties 2 required
SetVmVisibilityRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openrelay-vms-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 VMs 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.