RoxyAPI
Quick StartPlaygroundSDKMCP SetupFree TemplatesAGENTS.md
  1. Docs
  3. Agent Reference
  5. Agent Task Cheatsheet

Agent Task Cheatsheet

One-line semantics for the most-reached-for endpoints, grouped by API domain. Read this first when an agent needs a starting point. Full request and response schemas live in each per-product OpenAPI spec at /api/v2/{slug}/openapi.json.

Astrology

  • POST /astrology/natal-chart — Western birth chart with planets, houses, aspects, ascendant, midheaven.
  • GET /astrology/horoscope/{sign}/daily — Daily horoscope. Also /weekly and /monthly variants.
  • POST /astrology/synastry — Inter-chart aspect analysis between two people.
  • POST /astrology/compatibility-score — Percent plus category breakdowns and archetype.
  • POST /astrology/transits — Current sky. Pass optional natalChart for personalized aspects.
  • GET /astrology/moon-phase/current — Current moon phase, illumination, sign.

TypeScript SDK example

roxy.astrology.generateNatalChart({ body: { date: '1990-06-15', time: '14:30:00', latitude: 40.7128, longitude: -74.006, timezone: 'America/New_York' } })

Python SDK example

roxy.astrology.generate_natal_chart(date="1990-06-15", time="14:30:00", latitude=40.7128, longitude=-74.006, timezone="America/New_York")

PHP SDK example

$roxy->astrology->generateNatalChart(date: '1990-06-15', time: '14:30:00', latitude: 40.7128, longitude: -74.006, timezone: 'America/New_York')

C# SDK example

roxy.Astrology.NatalChart.PostAsync(new() { Date = new Date(1990, 6, 15), Time = "14:30:00", Latitude = 40.7128, Longitude = -74.006, Timezone = new() { String = "America/New_York" } })

Vedic

  • POST /vedic-astrology/birth-chart — Kundli with twelve rashi houses, planet placements, interpretations.
  • POST /vedic-astrology/panchang/detailed — Daily panchang with rahu kaal, muhurtas, gulika, chandrabalam, tarabalam.
  • POST /vedic-astrology/panchang/basic — Tithi, nakshatra, yoga, karana.
  • POST /vedic-astrology/panchang/choghadiya — Eight day and eight night electional periods.
  • POST /vedic-astrology/dasha/current — Current Mahadasha, Antardasha, Pratyantardasha.
  • POST /vedic-astrology/dasha/major — Full 120-year Vimshottari timeline.
  • POST /vedic-astrology/dosha/manglik — Mangal Dosha check.
  • POST /vedic-astrology/dosha/kalsarpa — Kaal Sarp Dosha check.
  • POST /vedic-astrology/dosha/sadhesati — Sade Sati (Saturn transit) check.
  • POST /vedic-astrology/compatibility — Guna Milan (36-point Ashtakoota matching).
  • POST /vedic-astrology/navamsa — D9 chart.
  • POST /vedic-astrology/kp/chart — KP chart with cusps, planets, sub-lords.
  • POST /vedic-astrology/kp/planets — KP planets with sub-lord and sub-sub-lord.
  • POST /vedic-astrology/kp/ruling-planets — KP ruling planets for horary.
  • GET /vedic-astrology/nakshatras/{id} — Single nakshatra detail (e.g. ashwini, pushya).

TypeScript SDK example

roxy.vedicAstrology.generateBirthChart({ body: { date: '1990-06-15', time: '14:30:00', latitude: 51.5074, longitude: -0.1278, timezone: 'Europe/London' } })

Python SDK example

roxy.vedic_astrology.generate_birth_chart(date="1990-06-15", time="14:30:00", latitude=51.5074, longitude=-0.1278, timezone="Europe/London")

PHP SDK example

$roxy->vedicAstrology->generateBirthChart(date: '1990-06-15', time: '14:30:00', latitude: 51.5074, longitude: -0.1278, timezone: 'Europe/London')

C# SDK example

roxy.VedicAstrology.BirthChart.PostAsync(new() { Date = new Date(1990, 6, 15), Time = "14:30:00", Latitude = 51.5074, Longitude = -0.1278, Timezone = new() { String = "Europe/London" } })

Numerology

  • POST /numerology/life-path — Pythagorean life path with master-number (11, 22, 33) and karmic-debt detection.
  • POST /numerology/chart — Full profile: life path, expression, soul urge, personality, birth day, maturity.
  • POST /numerology/compatibility — Couple matching by life-path / expression / soul urge. No birth time needed.
  • POST /numerology/personal-year — Annual forecast from birthdate plus target year.
  • POST /numerology/expression — Name-based destiny number.

TypeScript SDK example

roxy.numerology.calculateLifePath({ body: { year: 1990, month: 6, day: 15 } })

Python SDK example

roxy.numerology.calculate_life_path(year=1990, month=6, day=15)

PHP SDK example

$roxy->numerology->calculateLifePath(year: 1990, month: 6, day: 15)

C# SDK example

roxy.Numerology.LifePath.PostAsync(new() { Year = 1990, Month = 6, Day = 15 })

Tarot

  • POST /tarot/daily — Seeded daily card.
  • POST /tarot/draw — Custom draw of N cards (1-78).
  • POST /tarot/spreads/three-card — Past / present / future.
  • POST /tarot/spreads/celtic-cross — Ten-position spread.
  • POST /tarot/yes-no — One-question, one-card reading.
  • POST /tarot/spreads/love — Five-position relationship spread.
  • GET /tarot/cards — 78-card catalog.
  • GET /tarot/cards/{id} — Card detail with upright, reversed, and life-area meanings.

TypeScript SDK example

roxy.tarot.drawCards({ body: { count: 3 } })

Python SDK example

roxy.tarot.draw_cards(count=3)

PHP SDK example

$roxy->tarot->drawCards(count: 3)

C# SDK example

roxy.Tarot.Draw.PostAsync(new() { Count = 3 })

Human Design

No coordinates needed: Human Design uses the birth instant and ecliptic longitudes, not the observer location. Body is date, time, timezone (no latitude/longitude, no /location/search step).

  • POST /human-design/bodygraph — Full chart in one call: type, strategy, authority, profile, definition, incarnation cross, the 9 centers, defined channels, and all 26 gate activations.
  • POST /human-design/type — Energy type (Generator, Manifesting Generator, Projector, Manifestor, Reflector) with strategy and authority. The quiz-style entry point.
  • POST /human-design/connection — Two-person compatibility across the 36 channels (electromagnetic, dominance, compromise, companionship).
  • POST /human-design/profile — Profile (e.g. 5/1, 6/2) with personality and design line keynotes.
  • POST /human-design/transit — Today's planetary activations overlaid on a natal bodygraph. Body wraps birthData.
  • GET /human-design/gates/{number} — Single gate reference (1-64).

TypeScript SDK example

roxy.humanDesign.generateBodygraph({ body: { date: '1990-06-15', time: '14:30:00', timezone: 'America/New_York' } })

Python SDK example

roxy.human_design.generate_bodygraph(date="1990-06-15", time="14:30:00", timezone="America/New_York")

PHP SDK example

$roxy->humanDesign->generateBodygraph(date: '1990-06-15', time: '14:30:00', timezone: 'America/New_York')

C# SDK example

roxy.HumanDesign.Bodygraph.PostAsync(new() { Date = new Date(1990, 6, 15), Time = "14:30:00", Timezone = new() { String = "America/New_York" } })

Forecast

Cross-domain timing in one stateless call. Body wraps birthData (date, time, timezone; latitude/longitude optional, default 0), plus optional startDate, endDate (clamped to a 90-day horizon), and minSignificance. Event type and domain are stable English codes; only description localizes with ?lang=.

  • POST /forecast/transits — Western transit-to-natal aspects, sign ingresses, and retrograde stations over the window.
  • POST /forecast/timeline — Cross-domain merge: Western transits plus Vedic Vimshottari dasha boundaries plus biorhythm critical days, significance-scored and time-ordered. Optional domains subset.
  • POST /forecast/solar-return — Annual solar-return chart cast on the Sun's return to its natal longitude (birthday / year-ahead). Needs coordinates: body is date, time, year, latitude, longitude, timezone, so call /location/search first.
  • POST /forecast/significant-dates — High-significance highlights only (minSignificance defaults to 70).
  • POST /forecast/digest — Ranked top-N summary of the most significant events for a date.

TypeScript SDK example

roxy.forecast.forecastTransits({ body: { birthData: { date: '1990-06-15', time: '14:30:00', timezone: 'America/New_York' } } })

Python SDK example

roxy.forecast.forecast_transits(birth_data={"date": "1990-06-15", "time": "14:30:00", "timezone": "America/New_York"})

PHP SDK example

$roxy->forecast->forecastTransits(birthData: ['date' => '1990-06-15', 'time' => '14:30:00', 'timezone' => 'America/New_York'])

C# SDK example

roxy.Forecast.Transits.PostAsync(new() { BirthData = new() { Date = new Date(1990, 6, 15), Time = "14:30:00", Timezone = new() { String = "America/New_York" } } })

Biorhythm

  • POST /biorhythm/daily — Seeded daily biorhythm reading.
  • POST /biorhythm/forecast — Multi-day range (30 to 90 days) with best, worst, and critical days.
  • POST /biorhythm/compatibility — Cycle alignment between two people.
  • POST /biorhythm/critical-days — Zero-crossing days in a 90 to 180 day window.

TypeScript SDK example

roxy.biorhythm.getReading({ body: { birthDate: '1990-06-15', targetDate: '2026-06-15' } })

Python SDK example

roxy.biorhythm.get_reading(birth_date="1990-06-15", target_date="2026-06-15")

PHP SDK example

$roxy->biorhythm->getReading(birthDate: '1990-06-15', targetDate: '2026-06-15')

C# SDK example

roxy.Biorhythm.Reading.PostAsync(new() { BirthDate = new Date(1990, 6, 15), TargetDate = new Date(2026, 6, 15) })

I-Ching

  • POST /iching/daily — Seeded daily hexagram.
  • POST /iching/daily/cast — Seeded three-coin daily variant.
  • GET /iching/cast — Random three-coin cast (optional seed for determinism).
  • GET /iching/hexagrams/{number} — Hexagram 1 to 64 detail.

TypeScript SDK example

roxy.iching.castReading({})

Python SDK example

roxy.iching.cast_reading()

PHP SDK example

$roxy->iching->castReading()

C# SDK example

roxy.Iching.Cast.GetAsync()

Crystals

  • GET /crystals/zodiac/{sign} — Crystals paired with a zodiac sign.
  • GET /crystals/chakra/{chakra} — Chakra stones. Path is case-insensitive, space-separated: Heart, Root, Sacral, Solar Plexus (URL-encoded Solar%20Plexus), Throat, Third Eye (Third%20Eye), Crown.
  • GET /crystals/birthstone/{month} — Birthstones by month (1 to 12).
  • GET /crystals/search?q= — Free-text crystal search.

TypeScript SDK example

roxy.crystals.getCrystalsByZodiac({ path: { sign: 'aries' } })

Python SDK example

roxy.crystals.get_crystals_by_zodiac(sign="aries")

PHP SDK example

$roxy->crystals->getCrystalsByZodiac(sign: 'aries')

C# SDK example

roxy.Crystals.Zodiac["aries"].GetAsync()

Dreams

  • GET /dreams/symbols/{id} — Dream symbol detail (e.g. flying, teeth-falling-out).
  • GET /dreams/symbols — Browse catalog.
  • POST /dreams/daily — Daily dream symbol prompt.

TypeScript SDK example

roxy.dreams.getDreamSymbol({ path: { id: 'flying' } })

Python SDK example

roxy.dreams.get_dream_symbol(id="flying")

PHP SDK example

$roxy->dreams->getDreamSymbol(id: 'flying')

C# SDK example

roxy.Dreams.Symbols["flying"].GetAsync()

Angel Numbers

  • GET /angel-numbers/numbers/{number} — Canonical number meaning (string param, e.g. 1111, 777).
  • GET /angel-numbers/lookup?number= — Universal lookup for any positive integer with digit-root fallback.
  • POST /angel-numbers/daily — Daily-message endpoint.

TypeScript SDK example

roxy.angelNumbers.analyzeNumberSequence({ query: { number: '1111' } })

Python SDK example

roxy.angel_numbers.analyze_number_sequence(number='1111')

PHP SDK example

$roxy->angelNumbers->analyzeNumberSequence(number: '1111')

C# SDK example

roxy.AngelNumbers.Lookup.GetAsync(c => c.QueryParameters.Number = "1111")

Location

  • GET /location/search?q={city} — City search. Paginated envelope: { total, limit, offset, cities: [...] }. Each city has city, province, country, iso2, latitude, longitude, timezone (IANA string, e.g. "America/New_York"), utcOffset (decimal hours, DST-adjusted for today), population. Chart endpoints accept timezone as either the IANA string or utcOffset decimal — both work, IANA is preferred because it resolves to the DST-correct offset for the request's date. Call first for any coordinate-dependent endpoint.

TypeScript SDK example

roxy.location.searchCities({ query: { q: 'New York' } })

Python SDK example

roxy.location.search_cities(q="New York")

PHP SDK example

$roxy->location->searchCities(q: 'New York')

C# SDK example

roxy.Location.Search.GetAsync(c => c.QueryParameters.Q = "New York")