Product teams
Embed personalized audio-meditation workflows in an existing product while your service owns orchestration and user experience.
Integration paths
Choose the contract that is ready for your team.
REST, released server-side SDKs, and the controlled-access MCP server are current integration surfaces. Each page stays aligned to its published contract.
01 · REST API
Integrate from your existing backend.
Use the current OpenAPI contract when you need direct control over client context, practices, assignments, outcomes, and webhooks.
Platform teams
Connect organization-bound service credentials from a backend, preserve idempotency, and consume the versioned contract directly.
Operations teams
Use assignment lifecycle events and structured outcomes to coordinate delivery and measurement workflows.
Event handling
Webhook endpoint management, test delivery, history, retry, and atomic tenant-scoped secret rotation are represented as public OpenAPI routes. Read the signed Webhooks guide for the complete event catalog and verifier examples.
Start here
Quickstart explains authentication; the API Reference is generated from OpenAPI.
02 · SDKs
Use the official server-side clients.
TypeScript and Python packages wrap API v1 with typed resources, pagination helpers, retries, idempotency, and webhook verification.
TypeScript · 1.0.0
@psymind/sdk
Node.js 20.11+; no runtime dependencies. Install from npm and keep the credential server-side.
Python · 1.0.0
psymind
Python 3.11+; no runtime dependencies. Install from PyPI and use the synchronous client on a trusted backend.
03 · MCP
Use PsyMind from protocol-compatible AI clients.
The official server is a thin transport over API v1. It adds validation and protocol handling, not parallel PsyMind business logic.
Controlled access
Connect to https://psymind.app/api/mcp with an organization-bound service credential in a server-side bearer header. OAuth discovery and Dynamic Client Registration are not part of the current credential contract.
| Tool | API v1 operation | Scope |
|---|---|---|
create_practice | POST /practices | practices:write |
get_practice | GET /practices/{practiceId} | practices:read |
list_practices | GET /practices | practices:read |
get_client | GET /clients/{clientId} | clients:read |
assign_practice | POST /practices/{practiceId}/assign | assignments:write |
get_practice_audio | GET /practices/{practiceId}/audio | practices:read |
Mutations require an idempotency key. Tool visibility follows exact service scopes, and the credential organization is the tenant boundary. GET /usage is available through REST and the Developer Portal dashboard, but it is not exposed by this fixed MCP tool set. Client history and safely paginated outcomes remain gaps.
Guides
Use the REST path without guessing.
These guides are limited to the existing API v1 contract and controlled onboarding model.
Authentication
Keep the organization-bound service credential server-side and start with the authenticated API authentication guide.
Lifecycle integration
Follow the verified flow from client to practice, assignment, and outcome.
Reliable writes
Use the documented idempotency, pagination, and error behavior.
Event handling
Use the webhook guide and the generated OpenAPI operations for endpoint setup, signed test delivery, history, retry, and secret rotation.
Access
Tell us which integration path you need.
Share your organization, use case, expected traffic, and required scopes. We will confirm the access model and the currently available contract.