Health Report API
AvailableIn-depth health reading: an overview score, scored sections with the chart evidence behind each, timing windows, remedies, a summary and a confidence statement.
Call it with POST /v1/reports/report-health. Input: birth details. Output: JSON, as a direct response (json); pdf via /v1/jobs/pdf. Each successful call costs 10 credits.
- Endpoint
- POST /v1/reports/report-health
- Input
- Birth details
- Output
- JSON
- Delivery
- Direct response (JSON); PDF via /v1/jobs/pdf
- Cost
- 10 credits
- Compute class
- Report
Example response
Fields in data (inferred from the example)
topic· stringtitle· stringascendant· objectruleset· stringdisclaimer· stringoverview· objectvitality· objectstress· objectrest· objectroutine· objectfitness· objectfood· objectthemes· objecttiming· objectrelocation· objectcities· objectspiritual· objectplan· objectremedies· objectsupporting_charts· objectsummary· objectconfidence· objectevidence· array of object
Example response
Captured from the live engine with a sandbox key (so credits_used is 0) and trimmed: long arrays keep their first items and images are replaced by a placeholder.
Loading the example…
Request schema and every field: the Reports reference.
Health Report API: common questions
What does the Health Report API return?
In-depth health reading: an overview score, scored sections with the chart evidence behind each, timing windows, remedies, a summary and a confidence statement. The response's data object includes topic, title, ascendant, ruleset, disclaimer, overview, vitality and stress. See the reference for an example response.
What input does Health Report need?
Birth details.
How much does a Health Report call cost?
10 credits per successful call; a failed call is not charged. Plans and top-ups are on the pricing page.
Can I try it before paying?
Yes. Every account gets sandbox keys and trial credits, so you can call it from your own code before choosing a plan.