Core REST API
Core REST API
The few REST routes on the Core API, for uploading files and themes, with the gateway URL, headers and scopes.
What is the Core REST API?
Almost everything in the Core API is GraphQL. REST covers the things GraphQL is bad at: uploading files. Use it to upload media and Fluid theme zips from your own tooling.
https://api.storeos.dev/core/...Headers
| Header | Value |
|---|---|
x-storeos-key | sos_live_… key with a core: scope |
Authorization | Bearer <staff access token>. Get one from identity__login |
GET requests need core:query. POST and DELETE need core:mutation. core:all covers both.
Routes
Each reference page has a Try it button that opens an API playground (Scalar). Paste your key and token to send real requests.
| Route | What it does |
|---|---|
POST /files | Upload up to 20 files |
DELETE /files | Delete uploaded files by key |
GET /files/download | Stream a file from your library |
POST /storefront/fluid-themes | Upload a Fluid theme zip |
The Core API has other routes, such as sign-in callbacks and test helpers. They are internal and aren't covered here. The interactive spec is at api.storeos.dev/core/docs.