Reports

Generate Natal Report (PDF or HTML)

Changed on

Render a Western tropical natal chart as a single-page A4 PDF (default) or live HTML (add ?format=html). Includes Big Three (Sun/Moon/ASC), full planets table with houses + retrograde, all 12 house cusps, and major aspects. Set whitelabel: true to apply the caller's branding overrides. depth: "extended" (10000 credits instead of 5000) adds the chart wheel and a chapter for each of Sun to Pluto, Chiron and the Ascendant in its sign, from edited texts in the 20 languages of /natal-texts; no AI at request time. Languages: uk (default) or en. PDF URLs valid 24h via auto-cleanup cron; HTML mode streams directly without storage.

post/reports/natal

Request

  • Base URL: https://api.astroway.info/v1
  • URL: https://api.astroway.info/v1/reports/natal
  • Auth: API key in header X-Api-Key

Query parameters

retain_daysinteger

How many days the PDF stays at its url. 1 by default; up to 90 for a link you hand to a client. Delete it sooner with DELETE /v1/reports/files/{filename}.

format'pdf' | 'html'

html returns the rendered report as text/html instead of storing a PDF; nothing is kept.

fieldsstring

Comma-separated dotted paths, relative to data, to keep in the response. A path is applied to every element of an array, so planets.name means the name of each planet. Paths that match nothing come back in _fields_unmatched; a list where nothing matches at all is a 400, because an empty object would be a confident wrong answer.

precisioninteger

Round every non-integer number in the response to this many decimal places. Integers are left alone, because an id is not a measurement. Ecliptic longitudes ship with fourteen decimals by default; 2 is about a tenth of an arcminute.

Headers

X-Provider'openai' | 'anthropic' | 'google' | 'groq' | 'mistral' | 'openrouter' | 'deepseek' | 'together'

Bring your own model key: the LLM provider that should run this completion. Send together with X-Provider-Key or the request is refused: a key with no provider bills us for tokens you meant to pay for, and a provider with no key would look like it worked. The endpoint is fixed per provider on our side and is never taken from the request. There is no fallback to our own chain: if your key fails you get the provider's status and message. Applies only when enrich: true asks for the AI narrative.

X-Provider-Keystring

Your own credential for X-Provider. Never logged, stored or cached: it travels in a header because the request body is hashed into two cache keys, and a BYOK turn bypasses both caches in each direction. A provider error that quotes the key back is redacted before it reaches our logs or your response. Such a turn costs 5 credits instead of the endpoint price, and only when a completion actually ran on your key.

X-Provider-Modelstring

Optional model id, overriding the default for that provider. Defaults: openai → gpt-4o-mini, anthropic → claude-sonnet-4-5, google → gemini-2.5-flash, groq → openai/gpt-oss-120b, mistral → mistral-large-latest, openrouter → meta-llama/llama-3.3-70b-instruct, deepseek → deepseek-chat, together → meta-llama/Llama-3.3-70B-Instruct-Turbo.

Request body

language'uk' | 'en' | 'de' | 'ru' | 'pl' | 'es' | 'pt' | 'hi' | 'fr' | 'ko' | 'it' | 'ja' | 'id' | 'tr' | 'nl' | 'ro' | 'cs' | 'vi' | 'ar' | 'el' | 'hu'
enrichboolean
tone'warm' | 'professional' | 'concise'
length'short' | 'medium' | 'long'
depth'standard' | 'extended'

extended (10000 credits) adds the chart wheel and a chapter for each of Sun to Pluto, Chiron and the Ascendant in its sign, from edited texts with no AI at request time. Available in the 20 languages of /v1/natal-texts.

Example request

{
  "chart": {
    "timezone": "Europe/Kyiv"
  }
}

Response

Successful calculation

okboolean

Example response

{
  "ok": true
}

Changes