Tarot: Compatibility API
AvailableDraws cards for the Compatibility spread and returns them with a reading.
Call it with POST /v1/tarot/tarot-compatibility. Input: name. Output: JSON, as a direct response. Each successful call costs 1 credit.
- Endpoint
- POST /v1/tarot/tarot-compatibility
- Input
- Name
- Output
- JSON
- Delivery
- Direct response
- Cost
- 1 credit
- Compute class
- Light
Example response
Fields in data (inferred from the example)
reading_type· stringperson_1· stringperson_2· stringcards· array of objectcompatibility_score· integerelement_1· stringelement_2· stringcompatibility_description· stringscore_basis· stringverdict· stringdominant_element· stringsummary· string
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 Tarot reference.
Tarot: Compatibility API: common questions
What does the Tarot: Compatibility API return?
Draws cards for the Compatibility spread and returns them with a reading. The response's data object includes reading_type, person_1, person_2, cards, compatibility_score, element_1, element_2 and compatibility_description. See the reference for an example response.
What input does Tarot: Compatibility need?
Name.
How much does a Tarot: Compatibility call cost?
1 credit 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.