Auth Calm Calm Partner API
74
AI ReadinessAI-Aware (A-)74/100
Agent-ready OpenAPI document · curated by JenticIdentity AuthAuthenticationbearer3 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Authenticate a Calm partner service, link partner users to Calm accounts, and cancel partner-provisioned subscriptions via JWT-based REST endpoints.
Use for: Authenticate the partner service with Calm, Link an employee to a Calm account using their partner user ID, Cancel a Calm subscription when a member leaves the benefit, Refresh the partner JWT before it expires
Not supported: Does not handle consumer Calm app sign-up, in-app content, or end-user authentication - use for Calm B2B partner provisioning, linking, and cancellation only.
Jentic publishes the only available OpenAPI specification for Calm Partner API, keeping it validated and agent-ready. The Calm Partner API lets approved business partners integrate Calm subscriptions into their own platforms - for example, a health insurer or employer wellbeing benefit that wants to grant Calm access to its members. Three endpoints cover the full integration: authenticate the partner service, link a partner user to a Calm account, and cancel a user's subscription. Authentication is JWT-based and shared between the auth.calm.com production endpoint and a development endpoint.
Install Jentic One Beta
Connect the Calm Partner API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Calm Partner API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fauth.calm.com%2Fcalm-partner" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fauth.calm.com%2Fcalm-partner" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Calm Partner API.
Authenticate the partner service and obtain a JWT via POST /v0/authorize
Link a partner user to a Calm account through POST /v0/b2b/users/link
Cancel a partner-provisioned subscription via DELETE /v0/b2b/users/{partner_user_id}
Use the same auth flow against the production and development environments
Provision Calm access at scale from an HRIS, benefits, or insurance platform
Use Cases
Patterns agents use Calm Partner API for, with concrete tasks.
★ Employer wellbeing benefit provisioning
An employer offering Calm as a wellbeing benefit needs every active employee to receive Calm access automatically and lose it when they leave. The partner platform calls POST /v0/authorize to get a JWT, POST /v0/b2b/users/link to provision a new hire, and DELETE /v0/b2b/users/{partner_user_id} when an HRIS termination event arrives. Provisioning becomes a side effect of payroll changes rather than a manual admin task.
On an HRIS new-hire event, POST /v0/authorize, then POST /v0/b2b/users/link with the employee's partner_user_id and email.
Health-insurance member access
Health insurers offering Calm as a covered benefit link the insurer's member ID to a Calm account so the member can sign in with single-sign-on or a deep link. POST /v0/b2b/users/link takes the partner_user_id (the insurer's member ID) and the user's identifying details and returns a Calm account binding. Member churn flows through DELETE so cancelled policies do not retain Calm access.
For each member in an eligibility file, POST /v0/b2b/users/link with their member ID and email, and record the Calm response on the member record.
Subscription lifecycle audit
A partner program manager needs to keep the count of active Calm subscriptions consistent with the count of eligible members. The partner runs a reconciliation job that authenticates via POST /v0/authorize, iterates over expected partner_user_ids, and calls DELETE /v0/b2b/users/{partner_user_id} for any that should no longer be active. The audit reduces overpayment to Calm and removes lingering access for departed users.
POST /v0/authorize, then for each partner_user_id flagged as terminated, DELETE /v0/b2b/users/{partner_user_id} and log the response.
AI agent integration via Jentic
An HR-ops or benefits agent built on Jentic can run Calm provisioning without storing the partner JWT in prompt memory. The agent searches an intent like 'link a user to a Calm subscription', Jentic returns the matching POST /v0/b2b/users/link operation with its input schema, and execution uses the JWT resolved from your Jentic One instance. Token refresh against POST /v0/authorize is handled automatically.
Use Jentic search 'link a user to a Calm subscription', load the schema for POST /v0/b2b/users/link, and execute it with partner_user_id and email.
Key Endpoints
3 endpoints — jentic publishes the only available openapi specification for calm partner api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
POST
/v0/authorize
Authenticate the partner service and obtain a JWT
POST
/v0/b2b/users/link
Link a partner user to a Calm account
DELETE
/v0/b2b/users/{partner_user_id}
Cancel a partner-provisioned subscription
POST
/v0/authorize
Authenticate the partner service and obtain a JWT
POST
/v0/b2b/users/link
Link a partner user to a Calm account
DELETE
/v0/b2b/users/{partner_user_id}
Cancel a partner-provisioned subscription
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
C
Calm Partner API
- AI-Aware (A-)74/100
100
Foundational Compliance63
Developer Experience & Jentic Compatibility56
AI-Readiness & Agent Experience94
Agent Usability75
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
100
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A+Signals: 4
99%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
100%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
63
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B-Signals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
56
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: CSignals: 4
74%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
50%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
75
Security
Trust, risk posture, and security compliance.
Grade: A-Signals: 1
75%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Calm Partner API by hand means calling its authorize endpoint for a JWT, refreshing it on expiry, and managing B2B user linking and cancellation yourself. Through Jentic you install once, import the Calm Partner API from the API Directory, store the partner credentials once, and your agent calls it while Jentic manages the JWT.
Permission scoping
Calm puts the partner user id in the URL path (/v0/b2b/users/{partner_user_id}) for cancellation, while authorize and link carry their target in the request body, so limit the agent to the operations it needs, such as authorizing or linking a user. You choose the operations it may call, so user cancellation is not included unless you add it.
Credential isolation
Your Calm partner credentials and the resulting JWT are stored once, encrypted, by your own Jentic One instance, which refreshes the JWT via the authorize endpoint and injects it at execution time. The raw secret never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'link a user to Calm', and Jentic returns the matching operation with its input schema so the agent picks /v0/authorize, /v0/b2b/users/link, or /v0/b2b/users/{partner_user_id} without reading the partner docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
Complementary
Stripe API
Stripe handles billing for the partner platform that wraps the Calm benefit.
Choose Stripe to bill the employer or insurer; use Calm to provision the underlying subscription for the member.
FAQs
Specific to using Calm Partner API through Jentic.
Why is there no official OpenAPI spec for Calm Partner API?
Calm publishes prose partner documentation at partner.calm.com/docs/api but does not distribute an OpenAPI file. Jentic generates and maintains this spec so that AI agents and developers can call Calm Partner API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.
What authentication does the Calm Partner API use?
The Calm Partner API uses JWT-based authentication. The partner service calls POST /v0/authorize with its credentials and receives a JWT, which is then sent as a Bearer token on POST /v0/b2b/users/link and DELETE /v0/b2b/users/{partner_user_id}. Through Jentic the partner credentials and JWT are held in the vault.
Can I link an employee to a Calm subscription with the Calm Partner API?
Yes. POST /v0/b2b/users/link takes a partner_user_id (the partner's internal ID for the employee or member) plus identifying fields and binds them to a Calm account. The same partner_user_id is used to cancel via DELETE /v0/b2b/users/{partner_user_id}.
What are the rate limits for the Calm Partner API?
Rate limits are not declared in the spec. Calm gates partner traffic per agreement; production integrations should pace bulk eligibility loads and back off on 429 responses rather than retry tightly. Pre-coordinate with Calm before sending eligibility files larger than tens of thousands of users.
How do I provision a Calm benefit through Jentic?
Run jentic search 'link a user to Calm', load the schema for POST /v0/b2b/users/link, and execute it with the partner_user_id and email. The JWT is refreshed against POST /v0/authorize and resolved from your Jentic One instance at execution time. With pip install jentic the call is one async invocation.
Is the Calm Partner API free?
No. Access is commercial and tied to a Calm partner agreement, typically with employers, insurers, or wellness platforms. The credentials needed for POST /v0/authorize are issued only after the partner contract is in place.
Can I limit what my agent is allowed to do with the Calm Partner API?
Yes. Because you run Jentic One yourself, you decide which of the Calm Partner API operations your agent may call, so you can allow it to authenticate via POST /v0/authorize and link members via POST /v0/b2b/users/link while withholding cancellation. Subscription cancellation through DELETE /v0/b2b/users/{partner_user_id} is only available to the agent if you explicitly add it to the operations it may use. Your partner credentials and the JWT stay in your own instance and are injected at execution time rather than exposed to the agent, so the agent can only act within the scope your rules define.
GET STARTED