Karakeep API

import ApiLogo from "@theme/ApiLogo"; import Heading from "@theme/Heading"; import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; import Export from "@theme/ApiExplorer/Export";

<span className={"theme-doc-version-badge badge badge--secondary"} children={"Version: 1.0.0"}

<Heading as={"h1"} className={"openapi__heading"} children={"Karakeep API"}

Karakeep is a self-hostable bookmarking and read-it-later service. This API allows you to manage bookmarks, lists, tags, highlights, assets, and backups programmatically.

Authentication

All endpoints require a Bearer token passed in the Authorization header. You can generate an API key from the Karakeep web UI under Settings > API Keys.

Pagination

List endpoints support cursor-based pagination via cursor and limit query parameters. The response includes a nextCursor field — pass it as the cursor parameter to fetch the next page. A null value for nextCursor indicates there are no more results.

Bookmark Types

Bookmarks can be one of three types:

• link — A URL bookmark with optional crawled metadata.
• text — A plain text note.
• asset — An uploaded file (image or PDF).

  <div>
    <table>
      <tbody>
        <tr>
          <th>
            Security Scheme Type:
          </th><td>
            http
          </td>
        </tr><tr>
          <th>
            HTTP Authorization Scheme:
          </th><td>
            bearer
          </td>
        </tr><tr>
          <th>
            Bearer format:
          </th><td>
            JWT
          </td>
        </tr>
      </tbody>
    </table>
  </div>
</TabItem>