Skip to content
Developers
GuidesAPI reference
slimwiki.comGet an API key

Guides

  • Quickstart
  • Authentication
  • Errors
  • Pagination
  • Rate limits
  • Content format
  • Versioning

Tools and agents

  • CLI
  • MCP server
  • Agent skill

API reference

  • Overview

Users

  • Retrieve the key ownerget

Accounts

  • List accountsget

Wikis

  • List wikisget
  • Retrieve a wikiget

Pages

  • List pages in a wikiget
  • Search pages in a wikiget
  • Find a page by slug or hashget
  • Create a pagepost
  • Retrieve a pageget
  • Delete a pagedelete
  • Archive a pagepost
  • Restore a pagepost

Guides

Quickstart

Create an API key, check that it works, find a wiki and create a page in it. You need a SlimWiki account and a terminal with curl.

On this page

  • 1. Create an API key
  • 2. Check the key
  • 3. List your accounts
  • 4. List the wikis in an account
  • 5. Create a page

1. Create an API key

In SlimWiki, open Profile → API keys and create a key. To follow every step of this guide, give it read-and-write access.

The key starts with swk_ and is shown once, so copy it straight away. Put it in an environment variable; the examples on this site read it from SLIMWIKI_API_KEY.

Terminal
export SLIMWIKI_API_KEY="swk_your_key"

2. Check the key

get/v1/me returns the person the key belongs to. It is the quickest way to confirm that a key works.

Request
curl "https://api.slimwiki.com/v1/me" \
  -H "Authorization: Bearer $SLIMWIKI_API_KEY"
Response · 200
{
  "object": "user",
  "id": "0b9f6a52-3c1d-4e8a-b7f4-2d5c8e1a9f30",
  "name": "Ada Lovelace",
  "email": "ada@example.com"
}

If you get a 401 instead, the key is missing, mistyped, revoked or expired. See Authentication.

3. List your accounts

Wikis live inside accounts (workspaces). get/v1/accounts returns every account you are a member of.

Request
curl "https://api.slimwiki.com/v1/accounts" \
  -H "Authorization: Bearer $SLIMWIKI_API_KEY"
Response · 200
{
  "object": "list",
  "data": [
    {
      "object": "account",
      "id": "c4a7e2b8-5d3f-4a16-9c0e-7b2f1d8a6e45",
      "name": "Acme",
      "slug": "acme",
      "role": "owner",
      "default_wiki_id": "6f1c2d0e-8a3b-4c5d-9e7f-0a1b2c3d4e5f"
    }
  ],
  "has_more": false
}

Copy the id of the account you want to work in.

4. List the wikis in an account

Pass the account ID to get/v1/wikis as account_id. You get the wikis in that account that you can open.

Request
curl "https://api.slimwiki.com/v1/wikis?account_id=c4a7e2b8-5d3f-4a16-9c0e-7b2f1d8a6e45" \
  -H "Authorization: Bearer $SLIMWIKI_API_KEY"
Response · 200
{
  "object": "list",
  "data": [
    {
      "object": "wiki",
      "id": "6f1c2d0e-8a3b-4c5d-9e7f-0a1b2c3d4e5f",
      "account_id": "c4a7e2b8-5d3f-4a16-9c0e-7b2f1d8a6e45",
      "name": "Handbook",
      "slug": "handbook",
      "is_private": false,
      "updated_at": "2026-01-14T16:05:00.000Z"
    }
  ],
  "has_more": false
}

Copy the id of the wiki the new page should go in.

5. Create a page

Send the wiki ID, a title and, if you like, the page body to post/v1/pages. The body is a list of content nodes; the content format guide explains them.

Request
curl -X POST "https://api.slimwiki.com/v1/pages" \
  -H "Authorization: Bearer $SLIMWIKI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "wiki_id": "6f1c2d0e-8a3b-4c5d-9e7f-0a1b2c3d4e5f",
  "title": "Release checklist",
  "content": [
    {
      "type": "paragraph",
      "content": [
        {
          "type": "text",
          "text": "Steps we follow for every release."
        }
      ]
    }
  ]
}'
Response · 201
{
  "object": "page",
  "id": "a3d8f1c6-2b4e-4f7a-8d9c-5e6f7a8b9c0d",
  "wiki_id": "6f1c2d0e-8a3b-4c5d-9e7f-0a1b2c3d4e5f",
  "title": "Release checklist",
  "slug": "release-checklist",
  "hash": "string",
  "archived": false,
  "created_at": "2026-01-12T09:30:00.000Z",
  "updated_at": "2026-01-14T16:05:00.000Z",
  "content": [
    {
      "type": "paragraph",
      "content": [
        {
          "type": "text",
          "text": "Steps we follow for every release."
        }
      ]
    }
  ]
}

The page now appears at the top level of the wiki's page tree.

Got a 403?

A read-only key cannot create pages; the request fails with insufficient_scope. Create a key with read-and-write access, and make sure you are allowed to edit the wiki.

Next

Authentication
How API keys work: sending one, what it can access, scopes, expiry and revoking.

SlimWiki Developers

slimwiki.com