# Docs


- **Getting Started**
- [Introduction](/docs): The OpenRelay REST API — deploy GPU VMs and inference clusters, manage organizations and billing, and automate your infrastructure.
- [Quickstart](/docs/quickstart): From an API key to your first running GPU VM in a few minutes.
- [Authentication](/docs/authentication): Authenticate every request with an OpenRelay API key (vl_…) sent as a Bearer token.
- [Errors](/docs/errors): How the OpenRelay API reports errors — status codes and the JSON error body.
- [Pagination](/docs/pagination): How to page through OpenRelay list endpoints with cursors.

- **API Reference**
- Account: The signed-in user: profile, memberships, and first-time onboarding.
  - [Overview](/docs/account/overview): The signed-in user: profile, memberships, and first-time onboarding.
  - [Create the caller's profile + first org (idempotent). Supabase-JWT only.](/docs/account/bootstrap)
  - [Current user profile + org memberships](/docs/account/getMe)
  - [Update the caller's profile](/docs/account/updateProfile)
- Organizations: Organizations and their members. Most resources are scoped to an org.
  - [Overview](/docs/organizations/overview): Organizations and their members. Most resources are scoped to an org.
  - [List an org's members](/docs/organizations/listOrgMembers)
  - [Create an organization (caller becomes owner). Supabase-JWT only.](/docs/organizations/createOrg)
  - [Get an organization](/docs/organizations/getOrg)
  - [Update an organization (owner/admin)](/docs/organizations/updateOrg)
  - [Add a member by email (owner/admin)](/docs/organizations/addOrgMember)
  - [Update a member's role (owner/admin)](/docs/organizations/updateOrgMemberRole)
  - [Remove a member (owner/admin)](/docs/organizations/removeOrgMember)
- Clusters: Autoscaling inference clusters that serve a container image behind an endpoint.
  - [Overview](/docs/clusters/overview): Autoscaling inference clusters that serve a container image behind an endpoint.
  - [Get a cluster by id](/docs/clusters/getCluster)
  - [Get a cluster with its replicas and GPU model](/docs/clusters/getClusterDetail)
  - [List an org's clusters (cursor-paginated)](/docs/clusters/listOrgClusters)
  - [Create a cluster](/docs/clusters/createCluster)
  - [Stop a cluster](/docs/clusters/stopCluster)
  - [Restart a cluster](/docs/clusters/restartCluster)
  - [Terminate a cluster](/docs/clusters/terminateCluster)
  - [Scale a cluster's replica count](/docs/clusters/scaleCluster)
- V Ms: GPU virtual machines: lifecycle, disks, SSH access, and console links.
  - [Overview](/docs/vms/overview): GPU virtual machines: lifecycle, disks, SSH access, and console links.
  - [List an org's VMs (cursor-paginated)](/docs/vms/listOrgVms)
  - [Get a VM by id](/docs/vms/getVm)
  - [Get a VM with its GPU/node/template info and price](/docs/vms/getVmDetail)
  - [Create a VM](/docs/vms/createVm)
  - [Stop a VM](/docs/vms/stopVm)
  - [Restart a VM](/docs/vms/restartVm)
  - [Terminate a VM](/docs/vms/terminateVm)
  - [Reboot a VM](/docs/vms/rebootVm)
  - [Resize a stopped VM's disk](/docs/vms/resizeVmDisk)
  - [Get a VM's embedded Telegram link](/docs/vms/getVmTelegramLink)
  - [SSH keys attached to a VM + the org's keys](/docs/vms/getVmSshKeys)
  - [Attach an org SSH key to a VM](/docs/vms/attachVmSshKey)
- Snapshots: Point-in-time VM snapshots and forking new VMs from them.
  - [Overview](/docs/snapshots/overview): Point-in-time VM snapshots and forking new VMs from them.
  - [Create a snapshot of a VM](/docs/snapshots/createVmSnapshot)
  - [List an org's VM snapshots (optionally filtered by source VM)](/docs/snapshots/listOrgSnapshots)
  - [Soft-delete a snapshot](/docs/snapshots/deleteSnapshot)
  - [Fork a new VM from a snapshot](/docs/snapshots/forkVm)
- S S H Keys: Org-level SSH public keys that can be attached to VMs.
  - [Overview](/docs/ssh-keys/overview): Org-level SSH public keys that can be attached to VMs.
  - [List an org's SSH public keys](/docs/ssh-keys/listOrgSshKeys)
  - [Add an SSH public key (computes fingerprint)](/docs/ssh-keys/createOrgSshKey)
  - [Delete an SSH public key](/docs/ssh-keys/deleteOrgSshKey)
- A P I Keys: Programmatic access keys (vl_…) used to authenticate with this API.
  - [Overview](/docs/api-keys/overview): Programmatic access keys (vl_…) used to authenticate with this API.
  - [List an org's API keys (no secrets)](/docs/api-keys/listOrgApiKeys)
  - [Create an API key (returns the plaintext once)](/docs/api-keys/createOrgApiKey)
  - [Revoke an API key](/docs/api-keys/revokeOrgApiKey)
- Registry Credentials: Private container-registry credentials for pulling images.
  - [Overview](/docs/registry-credentials/overview): Private container-registry credentials for pulling images.
  - [List an org's registry credentials (no secrets)](/docs/registry-credentials/listOrgRegistryCredentials)
  - [Create a registry credential (credentials stored encrypted)](/docs/registry-credentials/createOrgRegistryCredential)
  - [Delete a registry credential](/docs/registry-credentials/deleteOrgRegistryCredential)
- Webhooks: Subscribe to platform events with signed HTTP callbacks.
  - [Overview](/docs/webhooks/overview): Receive signed, automatically-retried HTTP callbacks when events happen in your organization.
  - [List an org's webhooks (no secrets)](/docs/webhooks/listOrgWebhooks)
  - [Create a webhook (returns the signing secret once)](/docs/webhooks/createOrgWebhook)
  - [Update a webhook (name/url/events)](/docs/webhooks/updateOrgWebhook)
  - [Delete a webhook](/docs/webhooks/deleteOrgWebhook)
  - [Enable/disable a webhook](/docs/webhooks/toggleOrgWebhook)
  - [Regenerate a webhook's signing secret (returned once)](/docs/webhooks/regenerateOrgWebhookSecret)
  - [Recent delivery attempts for a webhook](/docs/webhooks/listOrgWebhookDeliveries)
- Billing: Prepaid balance, saved cards, deposits, and auto-recharge.
  - [Overview](/docs/billing/overview): Prepaid balance, saved cards, deposits, and auto-recharge.
  - [Org balance + recent transactions](/docs/billing/getBalance)
  - [Start saving a card (Stripe SetupIntent for inline Elements)](/docs/billing/createBillingSetupIntent)
  - [Charge the saved card to top up prepaid balance](/docs/billing/createBillingDeposit): Charges the org's default saved card off-session. The balance credit is applied by the payment_intent.succeeded webhook (the authoritative money signal), not this response — poll the balance after success.
  - [Read the org's auto-recharge policy](/docs/billing/getAutoRecharge)
  - [Set the org's auto-recharge policy](/docs/billing/updateAutoRecharge)
  - [List saved cards (brand/last4/exp only)](/docs/billing/listBillingPaymentMethods)
  - [Remove a saved card](/docs/billing/deleteBillingPaymentMethod)
- Usage: Current-period usage and cost breakdowns.
  - [Overview](/docs/usage/overview): Current-period usage and cost breakdowns.
  - [Current-month usage (cents/hours + per gpuModel-tier breakdown)](/docs/usage/getCurrentUsage)
- Transfers: Move resources between organizations you belong to.
  - [Overview](/docs/transfers/overview): Move resources between organizations you belong to.
  - [Orgs the caller belongs to (for the transfer target dropdown)](/docs/transfers/listTransferTargetOrgs)
  - [Initiate a resource transfer to another org (owner/admin)](/docs/transfers/initiateTransfer)
  - [Pending incoming transfers (enriched)](/docs/transfers/listIncomingTransfers)
  - [Outgoing transfers, all statuses (enriched)](/docs/transfers/listOutgoingTransfers)
  - [Count of pending incoming transfers](/docs/transfers/getTransferPendingCount)
  - [Cancel a pending outgoing transfer (source org)](/docs/transfers/cancelTransfer)
  - [Accept a pending incoming transfer (target org owner/admin)](/docs/transfers/acceptTransfer)
  - [Reject a pending incoming transfer (target org owner/admin)](/docs/transfers/rejectTransfer)
- Provider: For GPU providers: applications, nodes, provisioning tokens, and earnings.
  - [Overview](/docs/provider/overview): For GPU providers: applications, nodes, provisioning tokens, and earnings.
  - [Provider status (isProvider + application status)](/docs/provider/getProviderStatus)
  - [Submit a provider application](/docs/provider/applyForProvider)
  - [List the org's provisioning tokens (provider only)](/docs/provider/listProvisioningTokens)
  - [Generate a one-time provisioning token (owner/admin, provider only)](/docs/provider/generateProvisioningToken)
  - [Revoke a provisioning token (owner/admin)](/docs/provider/revokeProvisioningToken)
  - [List the provider org's nodes (with GPUs + location)](/docs/provider/listProviderNodes)
  - [Set a node's operator lifecycle status (drain / maintenance / remove / online)](/docs/provider/updateProviderNode)
  - [Provider node + token stats](/docs/provider/getProviderStats)
  - [Provider earnings from usage records (+ payout history)](/docs/provider/getProviderEarnings)
- Runners: Managed GitHub Actions runner pools.
  - [Overview](/docs/runners/overview): Managed GitHub Actions runner pools.
  - [List runner pools (with active/queued usage)](/docs/runners/listRunnerPools)
  - [Create a runner pool](/docs/runners/createRunnerPool)
  - [Get a runner pool (with usage)](/docs/runners/getRunnerPool)
  - [Delete (or drain) a runner pool](/docs/runners/deleteRunnerPool)
  - [Resize a runner pool's RAM tier](/docs/runners/resizeRunnerPool)
  - [List runner jobs for a pool](/docs/runners/listRunnerJobs)
  - [Runner pool job metrics (last 30 days) + cost comparison](/docs/runners/getRunnerJobMetrics)
- A I Proxy: OpenAI-compatible proxy connection details and usage.
  - [Overview](/docs/ai-proxy/overview): OpenAI-compatible proxy connection details and usage.
  - [AI proxy connection info + proxy-scoped keys](/docs/ai-proxy/getAiProxy)
  - [AI proxy usage (daily + totals)](/docs/ai-proxy/getAiProxyUsage)
- Catalog: Public catalog: GPU models, availability, pricing, templates, and locations.
  - [Overview](/docs/catalog/overview): Public catalog: GPU models, availability, pricing, templates, and locations.
  - [GPU availability by model](/docs/catalog/getGpuAvailability)
  - [GPU model catalog](/docs/catalog/listGpuModels)
  - [GPU + CPU pricing](/docs/catalog/getPricing)
  - [VM template catalog](/docs/catalog/listVmTemplates)
  - [Locations / regions](/docs/catalog/listLocations)