Raster

REST API

Make your first authenticated request to the Raster REST API.

The Raster REST API gives you read and write access to your libraries through resource-oriented HTTP endpoints you can call with curl, any HTTP client, or a no-code tool.

The REST API is in Alpha. Endpoints, response shapes, and behavior may change before the Beta release. Send the Api-Version header (see below) and track every change in the changelog.

The endpoint

Organization resources live under this base URL (GET /me and the anonymous POST /libraries sit at https://api.raster.app):

https://api.raster.app/organizations

Requests must be made over HTTPS and must include an Api-Version header and, except on the anonymous POST /libraries, an API key or OAuth access token. See Authentication for the full header contract.

Required headers

Every REST request carries these headers:

HeaderValueNotes
AuthorizationBearer <API_KEY>API key or OAuth access token with the right access to the libraries you target; omit it on the anonymous POST /libraries.
Api-Version2026-07-08Date string. The current version is 2026-07-08.

Every response carries Vary: Api-Version so HTTP caches key bodies per version. Your CDN or browser never serves a body shaped for a different version of the API.

Response envelope

Every response is one of two shapes:

// Success
{ "data": <result> }

// Failure
{ "error": { "code": "ERROR_CODE", "message": "Human-readable message." } }

The shape is stable across endpoints, so a generic client can dispatch on "data" in response without parsing per-endpoint payloads. See Errors for the full code reference.

Quickstart

To confirm your key works, list the libraries it can reach.

Create an API key

In your organization settings, generate a key and enable Read access for at least one library. Full instructions are in Authentication.

List your libraries

Replace <API_KEY> with your key and acme-co with your organization slug:

Terminal
curl --request GET \
  --header 'Authorization: Bearer <API_KEY>' \
  --header 'Api-Version: 2026-07-08' \
  --url 'https://api.raster.app/organizations/acme-co/libraries'

The response is {"data": [ { "id": "barcelona", "name": "Barcelona", ... } ] }.

List the assets in a library

Pick a library from the previous response and fetch its assets:

Terminal
curl --request GET \
  --header 'Authorization: Bearer <API_KEY>' \
  --header 'Api-Version: 2026-07-08' \
  --url 'https://api.raster.app/organizations/acme-co/libraries/barcelona/assets?page=1&pageSize=20'

Where to go next

  • Authentication: API keys, the Api-Version header, and the access-level rules every request is checked against.
  • Endpoints: every route, the parameters it takes, and a runnable curl example.
  • Errors: the error envelope, every code, and the HTTP status each one maps to.
  • Changelog: every notable change, by version.

On this page