Read-only API index and authentication guide

Public discovery endpoints plus authenticated account routes for pods, machines, templates, contracts, audit history, and earnings. Bearer + secure API key compatible

Documentation

Three Swagger entry points

Read-only Swagger

Full OpenAPI docs for catalog, account, pod, machine, template, and history endpoints.

Open Swagger

Read-write Swagger

Companion docs for authentication, pod lifecycle, storage, host store, and write operations.

Open Swagger

Secure API keys

Direct entry point for secure API key creation, listing, revocation, and key-enabled workflows.

Open keys docs

Authentication

Two compatible credential types

Credentials

Bearer authentication

Use Authorization: Bearer <token> for interactive sessions and admin-only routes.

Secure API keys

Use a qpk_... key with X-API-Key or Authorization: ApiKey <key>.

Scoped compatibility routes

Routes like /auth/me, /mypods, /mymachines, and /templates accept either credential with the right scope.

Common routes

Catalog, account, and admin

Public

GET/rentable/rentable_cpu

Available GPU and CPU offers.

GET/public_templates/community_templates

Public and community template catalogs for GPU and CPU workloads.

GET/gpupricing/gpu_distribution/availablegputypes

Marketplace discovery and aggregate platform data.

Authenticated

GET/auth/me

Current user or host profile.

GET/mypods/mypods_cpu/my_pods_history

Current and historical pod views.

GET/mymachines/mymachine_contracts

Host machine inventory and contract history.

GET/templates/audit_log/host_earnings_history

Saved templates, request history, and account-linked reporting.

Admin (bearer only)

GET/admin_internal_dashboard

Internal operations dashboard data.

GET/mymachines_admin/mypods_admin

Admin views of platform-wide machines and pods, with paginated variants.

GET/admin_top_burners/admin_transactions

Top accounts by spend and admin transaction history.