CollectiveX Health Partner API
  • Get Started
  • Reference
  • Operations
  • API Reference
Information
partner
    Partner biomarker-contextual recommendationpostTenant pre-flightget
health
    Tenant pre-flightget
Other endpoints
    Gateway liveness probeget
powered by Zuplo
CxH Partner API Gateway
CxH Partner API Gateway

partner


Partner biomarker-contextual recommendation

POST
https://partners.collectivex.health
/v1/{tenant}/recommendation

Accepts a partner-supplied biomarker payload + women's-health cycle context; returns a written recommendation grounded in peer-reviewed research, with citations. Mirrors the the Health platform Insights service recommendation surface 1:1 — Zuplo adds partner auth + rate limit + origin verification at the edge, origin still runs the actual reasoning pipeline.

Partner biomarker-contextual recommendation › Headers

Authorization
​string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format ApiKey YOUR_KEY_HERE.

Partner biomarker-contextual recommendation › Responses

Recommendation served or suppressed (see suppression_reason in body).

No data returned
POST/v1/{tenant}/recommendation
curl --request POST \ --url https://partners.collectivex.health/v1/:tenant/recommendation \ --header 'Authorization: <string>'
shell
Example Responses
No example specified for this content type

Tenant pre-flight

GET
https://partners.collectivex.health
/v1/health/me

Returns the calling partner's tenant identifier, consent state, scopes, and rate-limit ceiling. Use this before debugging recommendation calls — a freshly-issued sandbox key whose tenant has not been provisioned yet returns consent_state=not_provisioned without burning recommendation compute. Issue #405 partner-DX burndown item 8.

Tenant pre-flight › Headers

Authorization
​string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format ApiKey YOUR_KEY_HERE.

Tenant pre-flight › Responses

Pre-flight state for the calling tenant.

No data returned
GET/v1/health/me
curl --request GET \ --url https://partners.collectivex.health/v1/health/me \ --header 'Authorization: <string>'
shell
Example Responses
No example specified for this content type

health