Skip to content

API

Slipmat.io has a public API. The site runs on it, and you can build on it too.

The interactive documentation is made from the OpenAPI schema, a machine-readable description of the API in the OpenAPI format. Both come directly from the running code, so they always show what is available now: which endpoints exist, what they return, and which ones need you to sign in. If this page and the schema do not agree, trust the schema.

  • All requests use HTTPS, and all responses are JSON.
  • Most documented endpoints are read-only: they return information and change nothing.

Most endpoints need an API key: a long secret string that replaces your login when you work outside the browser. The interactive documentation shows which endpoints need one.

Open the API Key page in your account and click Create API key.

You have one key at a time.

If you lost your key or want a new one, click Reset key on the same page. The old key stops working immediately, and Slipmat shows the new key once. Everything that uses the old key stops working until you give it the new key.

Send the key in the Authorization header of each request, after the word Bearer:

Authorization: Bearer YOUR_API_KEY

For example, with curl:

Terminal window
curl -H "Authorization: Bearer YOUR_API_KEY" https://api.slipmat.io/account/hello/

To let an AI assistant work with your account without code, see Connecting an AI Assistant. It uses your normal login, so it needs no API key.

Everything on the site comes from the API. If you can do it on the site, there is an API endpoint for it. Ask an AI agent to log in to the site for you and study the traffic, or ask for help on Backstage. We allow this, and we encourage it. Slipmat is an instrument: it is yours to tweak and experiment with.

In return, we ask you to publish what you make on Backstage, so others can see it.

Happy hacking!