API overview
The Superheat REST API under /v1 — what it can do, what it cannot, and your first authenticated request.
Authentication
How to authenticate API requests with a session token or an shk_ API key, and how X-Org-Id selects the organization.
API keys
Create, scope and revoke the shk_ keys that let scripts and CI call the Superheat API as a member of your organization.
Offers
Query the marketplace catalog — list offers with every filter and sort, page through them, read the catalog summary, fetch one offer, and check catalog freshness.
Templates
List templates, fetch one by id or by share hash, and duplicate a template into your own organization.
Instances
Deploy, inspect, stop, start, destroy and tail the logs of an instance, with a complete curl walkthrough.
Errors
The error envelope, what each HTTP status means, and the failures a renter actually hits when automating deploys.