API Overview
The S-Launch API is a RESTful HTTP API that powers every feature of the platform. It is the same surface used by the S-Launch web client, so anything you can do in the UI is available programmatically.
This guide assumes you are comfortable making authenticated HTTP requests and parsing JSON responses. Each section elaborates on platform-specific behavior — scope-based access, the factory/blueprint workflow model, cursor pagination, and filter-metadata endpoints — but does not re-explain general HTTP or REST concepts.
Base URL
All endpoints are served under the /api prefix on your S-Launch tenant host:
https://<your-tenant>.s-launch.com/apiThe OpenAPI specification (openapi.json) describes the full surface in OpenAPI 3.x format and can be imported into Postman, Insomnia, Stoplight, or any other OpenAPI-compatible tool.
Authentication
Two authentication methods are supported:
| Method | Best for | How |
|---|---|---|
| OAuth2 (password / refresh) | Interactive sessions, first-party clients | POST /api/login/access-token returns an access + refresh token. Send Authorization: Bearer <token> on every request. |
| API Key | Server-to-server integrations, automation | Send X-API-Key: <key> on every request. Keys are minted and scoped from the API Keys admin endpoints. |
A full walkthrough of every flow — including Google OAuth — lives on the Authentication page.
Authorization Model
Every endpoint declares the scopes it requires. Scopes are coarse-grained capability claims like store:read, forms:submit, or admin. A user's effective scope set is the union of scopes attached directly to their account plus those inherited from any Scope Sets they belong to.
The complete scope catalogue and the endpoints each scope unlocks is documented on the Scopes page. Every endpoint entry in this guide also links back to its required scope.
Browsing the API
Two complementary references are available:
- This guide (left sidebar) — hand-written documentation grouped by feature area. Use this when you want to understand a resource, see its scopes, and skim its endpoints.
- Interactive Reference — a Swagger-style renderer of
openapi.json. Use this to inspect full request/response schemas, expand examples, and copy endpoint signatures.
Where to Start
| If you want to… | Go to |
|---|---|
| Authenticate a user or service | Authentication |
| Understand how scopes gate access | Scopes |
| Learn the pagination, filtering, and error patterns used everywhere | Conventions |
| Manage assets, folders, shares | Asset Store |
| Build or run workflows | Factory |
| Build, serve, or process dynamic forms | Forms |
| Manage users, groups, API keys, or system config | Administration |