REST API

Build on top of your Skimle projects

JSON endpoints for reading and writing project data, and for running a project end to end. Authenticate with a Bearer key, send an action, get JSON back.

Get started in three steps

From zero to your first authenticated call.

Create an API key

A project key reaches one project. An account key reaches one team and can create projects in it. Both come in read and edit levels.

1. Open the API keys page
2. Pick the project the key should access and choose read or edit access
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.

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, edit keys end in e. Project keys call /api/skimle-read and /api/skimle-write. Account keys call /api/skimle-account.

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 reference Read endpoints →Write endpoints →Project 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 key Use MCP instead