docmost-sdk 1.0.0

Python client for the Docmost REST API. Supports API token (Bearer) and email/password (cookie) authentication.

docmost-sdk (Python)

Python client for the Docmost REST API — same surface as the .NET client.

Installation

pip install docmost-sdk

Requires Python 3.10+.

From source:

cd python
pip install .

Quick start

API token (Bearer)

from docmost import DocmostClient
from docmost.models import PaginationOptions, User
from docmost.response import parse_data

with DocmostClient("https://docs.example.com", api_token="your-api-key") as client:
    me = client.users.get_user_info()
    user = parse_data(me, User)
    print(user.email if user else None)

Email and password (cookie session)

with DocmostClient(
    "https://docs.example.com",
    email="[e-mail]",
    password="secret",
) as client:
    spaces = client.spaces.get_workspace_spaces(PaginationOptions(limit=20))

Advanced options

import os

client = DocmostClient(
    "https://docs.example.com",
    api_token=os.environ["DOCMOST_API_TOKEN"],
    login_on_startup=False,
    timeout=60.0,
)

API surface

DocmostClient exposes grouped APIs (snake_case), matching OpenAPI tags:

Attribute	Description
auth	Login, logout, password reset, setup
users	Current user profile
workspace	Workspace settings, members, invites
spaces	Spaces and membership
pages	Pages, history, tree
comments	Page comments
attachments	Uploads and file downloads
search	Full-text search
shares	Public sharing
groups	User groups
export / import_	Export and import (import_ — reserved keyword)
health / version	Health and version
api_keys, mfa, license, sso, ai, cloud	Enterprise features

Methods return ApiResponse with a data field (usually dict). Use parse_data(response, Model) for typed Pydantic models from docmost.models.

Authentication

Mode	Constructor
API token	DocmostClient(url, api_token="...")
Cookie session	DocmostClient(url, email="...", password="...")

Do not pass both api_token and email/password.

Regenerate from OpenAPI

python3 scripts/generate_sdk.py   # from repo root: python3 python/scripts/generate_sdk.py

License

MIT