Developer platform

SoLoRecall API

Build external apps with the same SoLoDocs capabilities available in the web app: blocks, page exports, comments, mentions, backlinks, synced blocks, and media.

Open interactive docs OpenAPI JSON Agent brief

documented endpoints

API groups

API Key

bearer auth

Quickstart

curl -X POST "https://api.solorecall.com/api/v1/blocks" \
  -H "Authorization: Bearer $SOLORECALL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "paragraph",
  "properties": {
    "content": "Created from the SoLoRecall API"
  }
}'

Open the SoLoRecall web app, go to Settings -> API Keys, and create an API key.

Send the key with every request as Authorization: Bearer $SOLORECALL_API_KEY.

Use the endpoint explorer below or the OpenAPI JSON for exact paths and methods.

Overview

The SoLoRecall API is organized around SoLoDocs resources. Use the public reference for discovery, then use the OpenAPI JSON as the exact machine-readable contract for generated clients and integration tests.

Base URL

https://api.solorecall.com

Canonical Spec

https://api.solorecall.com/documentation/openapi.json

Authentication

Create an API key in Settings -> API Keys, then pass it in the Authorization header.

Authorization: Bearer $SOLORECALL_API_KEY

For AI agents

Building with Codex, Cursor, custom agents, or automation scripts? The endpoint explorer and OpenAPI JSON cover paths and methods, but agents also need SoLoRecall's editor content schema, database row rules, and worked examples.

Put page bodies in top-level content, not only properties.content
Use heading-1/2/3 and bulleted-list, not TipTap names like heading or bulletListItem
Put database row field values in properties when calling POST /api/v1/pages

Open agent brief OpenAPI JSON

Endpoint Explorer

Search the public SoLoDocs API surface and inspect a request example for each endpoint.

API Keys

GET/api/v1/api-keys

List masked API keys

curl -X GET "https://api.solorecall.com/api/v1/api-keys" \
  -H "Authorization: Bearer $SOLORECALL_API_KEY"

Example response shape

{
  "id": "block_123",
  "type": "paragraph",
  "properties": {
    "content": "Created from the SoLoRecall API"
  },
  "created_by": "user_123",
  "last_edited_by": "user_123"
}

Response fields vary by endpoint. Use the OpenAPI JSON for exact request and response schemas.

API Keys

Create, list, rename, and revoke SoLoRecall API keys from an authenticated app session.

GET/api/v1/api-keysList masked API keys

POST/api/v1/api-keysCreate a new API key

PATCH/api/v1/api-keys/{id}Rename an API key

DELETE/api/v1/api-keys/{id}Revoke an API key

Blocks

Create, read, update, move, archive, trash, restore, duplicate, convert, and delete SoLoDocs blocks.

GET/api/v1/blocksList and search visible blocks

POST/api/v1/blocksCreate a block

GET/api/v1/blocks/{id}Fetch one block

PATCH/api/v1/blocks/{id}Update a block

DELETE/api/v1/blocks/{id}Permanently delete a block

GET/api/v1/blocks/{id}/childrenList child blocks

GET/api/v1/blocks/{id}/hierarchyFetch a block hierarchy

POST/api/v1/blocks/{id}/duplicateDuplicate a block

POST/api/v1/blocks/{id}/convertConvert a block type

POST/api/v1/blocks/{id}/archiveArchive or unarchive a block

POST/api/v1/blocks/{id}/trashMove a block to trash

POST/api/v1/blocks/{id}/restoreRestore a trashed block

POST/api/v1/blocks/{id}/moveMove or reorder a block

Pages And Exports

Compatibility endpoints for page-like blocks and markdown, HTML, JSON, and batch exports.

GET/api/v1/pagesList page-like blocks

POST/api/v1/pagesCreate a page-like block

GET/api/v1/pages/{id}Fetch one page-like block

PUT/api/v1/pages/{id}Update a page-like block

DELETE/api/v1/pages/{id}Trash or permanently delete a page

GET/api/v1/pages/{id}/exportExport as md, html, or json

GET/api/v1/pages/export/batchBatch export pages

Comments

Threaded collaboration primitives for blocks and page-like blocks.

GET/api/v1/comments/block/{blockId}List block comments

GET/api/v1/comments/page/{pageId}List page comments

POST/api/v1/commentsCreate a comment

PATCH/api/v1/comments/{id}Update a comment

DELETE/api/v1/comments/{id}Delete a comment

POST/api/v1/comments/{id}/resolveResolve a comment

POST/api/v1/comments/{id}/unresolveReopen a comment

Mentions

Inline mention creation, lookup, update, delete, and sync.

GET/api/v1/mentions/block/{blockId}List block mentions

GET/api/v1/mentions/page/{pageId}List page mentions

POST/api/v1/mentionsCreate a mention

POST/api/v1/mentions/syncSync mentions from content

PATCH/api/v1/mentions/{id}Update a mention

DELETE/api/v1/mentions/{id}Delete a mention

Backlinks

Discover incoming references for SoLoDocs pages.

GET/api/v1/backlinks/{targetPageId}List backlinks

GET/api/v1/backlinks/{targetPageId}/countCount backlinks

Synced Blocks

Manage source blocks, synced instances, propagation, and unlinking.

GET/api/v1/synced-blocks/source/{sourceBlockId}List synced instances for a source

GET/api/v1/synced-blocks/instance/{instanceBlockId}Fetch synced block metadata

POST/api/v1/synced-blocksCreate synced block metadata

POST/api/v1/synced-blocks/source/{sourceBlockId}/propagatePropagate source changes

POST/api/v1/synced-blocks/instance/{instanceBlockId}/unlinkUnlink an instance

Media

Upload, search, fetch URLs, update metadata, and delete SoLoDocs media.

GET/api/v1/mediaList media files

POST/api/v1/media/uploadUpload media

GET/api/v1/media/searchSearch media

GET/api/v1/media/{id}/urlGet a signed media URL

GET/api/v1/media/{id}/metadataFetch media metadata

PATCH/api/v1/media/{id}/metadataUpdate media metadata

DELETE/api/v1/media/{id}Delete media

Production Access

External API access is intended for SoLoRecall workspace integrations. Contact support for production access, rate-limit planning, and API key provisioning.

Contact Support Swagger UI OpenAPI JSON