Documentation
Client API
Use the local client API to automate deck operations and sync workflows.The Client API is a local service inside the app for advanced automation. It is not the public cloud API.
Typical uses
- Trigger sync from a local workflow.
- Create or update decks from trusted scripts.
- Search cards from a helper tool.
- Upload or delete deck resources.
Authentication
Protected endpoints require the app’s login state and a local secret through the X-API-SECRET header or the secret query parameter. Treat the secret like a credential.
Endpoint groups
The app includes endpoint groups for authentication, sync, decks, categories, cards, and resources.
Safety guidance
Use the local API only on trusted machines. Do not expose it to public networks. Check the app implementation when you need exact payload shapes, error formats, and permissions.