Keep client records synchronized
Create organization-scoped client records and maintain structured personalization context with explicit consent fields.
PsyMind API v1
Build personalized audio meditation workflows into your product.
A versioned API for organizations that need structured clients, personalized audio meditations and practices, assignment lifecycle events, and measurable outcomes.
Designed for a first authenticated API call in under 10 minutes.
curl https://psymind.app/api/v1/voices?language=en \
-H "Authorization: Bearer $PSYMIND_API_TOKEN"
# 200 · application/json
{
"data": [
{ "id": "…", "language": "en" }
]
}
ClientPracticeAssignmentOutcome
VersionedStable
/v1 contractScopedOrganization-bound access
ObservableRequest IDs and signed events
Use cases
One contract, from client context to outcome.
Promoted workflows are limited to capabilities present in the current API contract.
Request personalized audio meditations
Create a practice for a client goal, then poll its status and retrieve its generated audio when complete.
Track the delivery lifecycle
Assign a practice to a client and record started and completed lifecycle transitions idempotently.
Capture structured measurements
Submit pre- or post-practice metrics against the relevant client, practice, or assignment.
React to signed events
Receive signed practice, audio, assignment, and outcome events through controlled webhook onboarding.
Operate in a tenant boundary
Use organization-bound service credentials and explicit scopes for machine-to-machine integrations.
Core workflow
A clear path through the domain model.
Resources are explicit so your product can own orchestration without guessing state.
Register the client
Map your identifier with external_id.
Create the meditation practice
Send the client goal and supported options, then retrieve generated audio when ready.
POST /v1/practicesAssign and observe
Move through started and completed states.
POST /v1/practices/{id}/assignRecord the outcome
Attach a structured measurement to the workflow.
POST /v1/assignments/{assignmentId}/outcomesQuickstart
Make an authenticated request.
Use a service credential provided during controlled onboarding. The credential is bound to one organization and should remain server-side.
- 1Store the credential as
PSYMIND_API_TOKEN. - 2Call a read endpoint to verify authentication.
- 3Use the returned request ID when contacting support.
curl "https://psymind.app/api/v1/voices?language=en" \
-H "Authorization: Bearer $PSYMIND_API_TOKEN"const response = await fetch(
'https://psymind.app/api/v1/voices?language=en',
{ headers: { Authorization: `Bearer ${process.env.PSYMIND_API_TOKEN}` } }
);
if (!response.ok) throw new Error(`PsyMind ${response.status}`);
const payload = await response.json();import os
import requests
response = requests.get(
"https://psymind.app/api/v1/voices",
params={"language": "en"},
headers={"Authorization": f"Bearer {os.environ['PSYMIND_API_TOKEN']}"},
timeout=10,
)
response.raise_for_status()
payload = response.json()Contract essentials
Built for predictable integration.
Bearer authentication
Supabase JWTs for human actors or organization-bound service credentials for server integrations.
Idempotent writes
Supported write operations can reuse an idempotency key safely for the same payload.
Opaque pagination
List endpoints use bounded limits and signed cursors; clients should deduplicate resource IDs.
Consistent errors
Errors share a structured envelope with code, message, request ID, and optional details.
Controlled access
Bring personalized audio meditations into your product workflow.
Tell us about your organization, integration use case, expected traffic, and required scopes. Access and webhook setup are provisioned during controlled onboarding.