# Generate Natal Report (PDF or HTML)

`POST https://api.astroway.info/v1/reports/natal`

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. Languages: `uk` (default) or `en`. PDF URLs valid 24h via auto-cleanup cron; HTML mode streams directly without storage.

Group: Reports. Auth: `X-Api-Key` header. Operation ID: `reports_natal`.

## Parameters

| Name | In | Required | Type | Description |
|---|---|---|---|---|
| `X-Provider` | header | no | "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-Key` | header | no | string | 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-Model` | header | no | string | 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. |
| `fields` | query | no | string | 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. |
| `precision` | query | no | integer | 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. |

## Request body

| Field | Type | Required | Description |
|---|---|---|---|
| `chart` | object | yes | Birth data for a single natal chart. Required: date (YYYY-MM-DD), time (HH:mm:ss), latitude and longitude in decimal degrees. The short forms lat, lon, lng and tz are rejected with 400 INVALID_FIELD; pass the full names. timezoneOffset is hours from UTC and defaults to 0, meaning UTC; send timezone instead (an IANA name such as Europe/Kyiv, or auto) and the offset for that date is worked out, summer time included. city is a display label only: nothing here geocodes it, so it never stands in for coordinates. houseSystem is a single Swiss Ephemeris letter, P by default; a name such as "Placidus" is refused, and the case matters because I and i are two different Sunshine systems. |
| `chart.date` | string | yes |  |
| `chart.time` | string | yes |  |
| `chart.timezoneOffset` | number | no | Hours from UTC at the given moment, not minutes. Fractional zones are hours too: 5.5 for India, 5.75 for Nepal, -3.5 for Newfoundland. Defaults to 0, meaning UTC. Ignored when timezone is sent. |
| `chart.timezone` | string | no | IANA zone name such as Europe/Kyiv, or auto to look the zone up from latitude and longitude. The server takes the offset that zone kept at this local date and time, summer time included, and uses it in place of timezoneOffset. A clock time that happened twice takes the first occurrence; one skipped when clocks went forward takes the offset from before the change. Abbreviations such as EST are refused. Before 1970 the tz database is not reliable for every place, so send timezoneOffset when the local clock is known. |
| `chart.latitude` | number | yes | Birth latitude. Required here: the whole document is computed from it. |
| `chart.longitude` | number | yes | Birth longitude. Required here: the whole document is computed from it. |
| `chart.houseSystem` | "P" \| "K" \| "R" \| "C" \| "E" \| "W" \| "B" \| "M" \| … | no |  |
| `chart.name` | string | no |  |
| `chart.city` | string | no |  |
| `chart.zodiacType` | "tropical" \| "sidereal" | no |  |
| `chart.ayanamsaId` | number | no |  |
| `chart.ayanamsa` | "fagan-bradley" \| "lahiri" \| "de-luce" \| "raman" \| "krishnamurti" \| "kp" \| "yukteshwar" \| "jn-bhasin" \| … | no | Sidereal school by name. Lahiri when omitted. Equivalent to ayanamsaId; send either. |
| `chart.cosmogram` | boolean | no |  |
| `language` | "uk" \| "en" \| "de" \| "ru" \| "pl" \| "es" \| "pt" \| "hi" \| … | no |  |
| `whitelabel` | boolean \| object | no |  |
| `enrich` | boolean | no |  |
| `tone` | "warm" \| "professional" \| "concise" | no |  |
| `length` | "short" \| "medium" \| "long" | no |  |

```json
{
  "chart": {
    "date": "1990-05-15",
    "time": "15:30:00",
    "timezone": "Europe/Kyiv",
    "latitude": 50.45,
    "longitude": 30.52
  },
  "language": "uk",
  "whitelabel": false
}
```

## Responses

| Status | Meaning |
|---|---|
| 200 | Successful calculation |
| 400 | Validation error |
| 401 | Missing or invalid API key |

### Success fields, under `data`

| Field | Type | Required | Description |
|---|---|---|---|
| `url` | string | no |  |
| `storage_key` | string | no |  |
| `byte_length` | number | no |  |
| `page_count` | number | no |  |
| `duration_ms` | number | no |  |
| `expires_at` | string | no |  |

## Example

```bash
curl -X POST https://api.astroway.info/v1/reports/natal \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "chart": { "date": "1990-05-15", "time": "15:30:00", "timezone": "Europe/Kyiv", "latitude": 50.45, "longitude": 30.52 }, "language": "uk", "whitelabel": false }'
```

---

Rendered from https://api.astroway.info/v1/openapi.json. HTML page: https://api.astroway.info/docs/api/operations/reports_natal/