SlimWiki API · version 1.0.0
API reference
Read and write the wikis and pages you have access to in SlimWiki. Requests are authenticated with a personal API key and act as the person who created it.
Base URL
https://api.slimwiki.comRequests and responses are JSON. Endpoint paths include the version, for example /v1/me. See Versioning.
Authentication
Every request needs a personal API key in the Authorization header, as Bearer swk_…. Create a key in SlimWiki under Profile → API keys. A key acts as the person who created it, with exactly their access, and is either read-only or read-and-write. Each key can make 120 requests per minute. See Authentication and Rate limits.
Endpoints
Users
The owner of the API key.
| Method | Path | Summary |
|---|---|---|
| get | /v1/me | Retrieve the key owner |
Accounts
The accounts (workspaces) you belong to.
| Method | Path | Summary |
|---|---|---|
| get | /v1/accounts | List accounts |
Wikis
Wikis inside an account.
| Method | Path | Summary |
|---|---|---|
| get | /v1/wikis | List wikis |
| get | /v1/wikis/{wiki_id} | Retrieve a wiki |
Pages
Pages inside a wiki.
| Method | Path | Summary |
|---|---|---|
| get | /v1/wikis/{wiki_id}/pages | List pages in a wiki |
| get | /v1/wikis/{wiki_id}/pages/search | Search pages in a wiki |
| get | /v1/wikis/{wiki_id}/pages/lookup | Find a page by slug or hash |
| post | /v1/pages | Create a page |
| get | /v1/pages/{page_id} | Retrieve a page |
| delete | /v1/pages/{page_id} | Delete a page |
| post | /v1/pages/{page_id}/archive | Archive a page |
| post | /v1/pages/{page_id}/restore | Restore a page |