Book a demoSign up for freeLog in

REST API

Build on top of your Skimle projects

A single endpoint per direction — read or write — for every project resource. Authenticate with a per-project API key, send a JSON action, get JSON back.

Get started in three steps

From zero to your first authenticated call.

1

Create an API key

API keys are scoped to a single project and a single access level (read or edit).

  1. 1. Open the API keys page
  2. 2. Pick the project the key should access and choose read or edit access
  3. 3. Copy the key — Skimle only stores its hash

Copy the key immediately.

The full key value is shown once at creation. After you close the dialog, only the hash remains on our side — a lost key has to be re-issued.

2

Send your first request

Pass the key as a Bearer token and the action in the JSON body. Every endpoint takes JSON and returns JSON.

curl -X POST https://app.skimle.com/api/skimle-read \
  -H "Authorization: Bearer skm_…r" \
  -H "Content-Type: application/json" \
  -d '{ "action": "get_categories" }'

Read keys end in r and can only call /api/skimle-read. Edit keys end in e and can call both endpoints.

3

Open the API reference

Browse every endpoint with descriptions, request shapes, and a try-it-out panel. Each route accepts a discriminated union body keyed on action.

Open the referenceRead endpoints →Write endpoints →

The raw OpenAPI 3.1 spec is available at /api/openapi.json.

Ready to build?

Manage your project keys, or check out the MCP server for agentic clients.

Create an API keyUse MCP instead