Generate Natal Report (PDF or HTML)

Відкрити як Markdown Налаштування агента

POST

/reports/natal

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 }'

const res = await fetch('https://api.astroway.info/v1/reports/natal', {
  method: 'POST',
  headers: {
    'X-Api-Key': process.env.ASTROWAY_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "chart": {
      "date": "1990-05-15",
      "time": "15:30:00",
      "timezone": "Europe/Kyiv",
      "latitude": 50.45,
      "longitude": 30.52
    },
    "language": "uk",
    "whitelabel": false
  }),
});
const { ok, data, error } = await res.json();
if (!ok) throw new Error(error.message);
console.log(data);

import os, requests

r = requests.post(
    'https://api.astroway.info/v1/reports/natal',
    headers={'X-Api-Key': os.environ['ASTROWAY_API_KEY'], 'Content-Type': 'application/json'},
    json={
      'chart': {
        'date': "1990-05-15",
        'time': "15:30:00",
        'timezone': "Europe/Kyiv",
        'latitude': 50.45,
        'longitude': 30.52
      },
      'language': "uk",
      'whitelabel': False
    },
)
result = r.json()
if not result['ok']:
    raise RuntimeError(result['error']['message'])
print(result['data'])

<?php
use GuzzleHttp\Client;

$client = new Client(['base_uri' => 'https://api.astroway.info/v1/']);
$r = $client->post('reports/natal', [
    'headers' => ['X-Api-Key' => getenv('ASTROWAY_API_KEY')],
    'json' => [
        'chart' => [
            'date' => '1990-05-15',
            'time' => '15:30:00',
            'timezone' => 'Europe/Kyiv',
            'latitude' => 50.45,
            'longitude' => 30.52,
        ],
        'language' => 'uk',
        'whitelabel' => false,
    ],
]);
$result = json_decode($r->getBody(), true);
if (!$result['ok']) throw new \RuntimeException($result['error']['message']);
print_r($result['data']);

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.

Authorizations

ApiKeyAuth

Parameters

Query Parameters

retain_days

integer

default: 1 >= 1 <= 90

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

string

default: pdf

Allowed values: pdf html markdown

Same switch as the format body field (send one or the other; two different values are a 400). pdf stores a PDF and answers with its url. html returns one self-contained text/html document (inline CSS and drawings, no scripts, no external fonts; the white-label logo stays a link to your https image). markdown returns text/markdown with the same headings, text and tables, drawings left out with a one-line note. Neither html nor markdown is stored, so retain_days does not apply. Same price in every format.

fields

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.

Example

planets.name,planets.longitude

precision

integer

<= 15

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.

Example

Header Parameters

X-Provider

string

Allowed values: 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.

Example

anthropic

X-Provider-Key

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.

Example

sk-ant-...

X-Provider-Model

string

<= 120 characters

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.

Example

claude-sonnet-4-5

Idempotency-Key

string

>= 1 characters <= 255 characters /^[\x21-\x7E]+$/

Unique per logical operation, kept across retries. For 24 hours from the first request, a repeat with the same key, method, path, body and query string returns the stored response with Idempotent-Replayed: true and costs 0 credits. The same key with a different body or query string is a 409 IDEMPOTENCY_KEY_REUSED; a repeat while the first is still running is a 409 IDEMPOTENCY_IN_PROGRESS. Only 2xx responses are kept. See /idempotency/.

Example

01HXY2A7ZM0ABCDEF

Request Body^required

application/json

object

chart required

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 house-system letter, P by default; a name such as “Placidus” is refused, and the case matters because I and i are two different Sunshine systems.

object

date required

string

/^\d{4}-\d{2}-\d{2}$/

time required

string

/^\d{2}:\d{2}(:\d{2})?$/

timezoneOffset

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.

number

0 nullable >= -14 <= 14

timezone

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.

string

latitude required

number

>= -90 <= 90

longitude required

number

>= -180 <= 180

houseSystem

string

default: P

Allowed values: P K R C E W B M O A T V D F G H I i L N Q S U X Y

name

string

city

string

zodiacType

string

Allowed values: tropical sidereal

ayanamsaId

number

nullable

ayanamsa

Sidereal school by name. Lahiri when omitted. Equivalent to ayanamsaId; send either.

string

Allowed values: fagan-bradley lahiri de-luce raman krishnamurti kp yukteshwar jn-bhasin true-citra djwhal-khul

cosmogram

boolean

latitude

Birth latitude. Required here: the whole document is computed from it.

number

>= -90 <= 90

longitude

Birth longitude. Required here: the whole document is computed from it.

number

>= -180 <= 180

language

string

Allowed values: uk en de ru pl es pt hi fr ko it ja id tr nl ro cs vi ar el hu

whitelabel

Any of:

boolean
object

boolean

format

pdf (default) stores a PDF and answers with its url. html returns one self-contained text/html document, markdown returns text/markdown with the same sections and tables; neither is stored. Same price in every format.

string

Allowed values: pdf html markdown

enrich

boolean

tone

string

Allowed values: warm professional concise

length

string

Allowed values: short medium long

depth

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.

string

Allowed values: standard extended

Example

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

Responses

200

With format pdf (default): JSON with the stored PDF url and its expires_at. With html or markdown: the document itself, nothing stored.

object

boolean

data

object

url

string

nullable

storage_key

string

nullable

byte_length

number

nullable

page_count

number

nullable

duration_ms

number

nullable

expires_at

string

nullable

Example

{
  "ok": true,
  "data": {
    "url": "https://api.astroway.info/reports/7423f03c-0853-4bfa-bb3c-74f0abbcb9e3-natal.pdf",
    "storage_key": "reports/7423f03c-0853-4bfa-bb3c-74f0abbcb9e3-natal.pdf",
    "byte_length": 121072,
    "page_count": 3,
    "duration_ms": 1706,
    "expires_at": "2026-09-18T20:02:25.525Z"
  }
}

string

Example

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><title>Natal Chart Report: Ada</title><style>h1{color:#d4a84c}</style></head><body><h1>Natal Chart Report</h1><p class="subtitle">Prepared for Ada</p><h2>Big Three</h2>...</body></html>

string

Example

# Natal Chart Report

Prepared for Ada

**Birth date:** 1990-05-15 **Birth time:** 14:30:00

## Big Three

Sun · ☉ · Taurus · 24.21°

## Planets

| Planet | Sign | Degree | House | Motion |
| --- | --- | --- | --- | --- |
| Sun | Taurus | 24.21° | 9 | – |

400

Validation error

application/json

Example

{
  "ok": false,
  "error": {
    "code": "INVALID_INPUT",
    "message": "Validation failed: date: Date must be YYYY-MM-DD",
    "details": [
      {
        "path": "date",
        "message": "Date must be YYYY-MM-DD"
      }
    ]
  }
}

401

Missing or invalid API key

application/json

Example

{
  "ok": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "Invalid API key"
  }
}

Generate Natal Report (PDF or HTML)

Authorizations

Parameters

Query Parameters

Example

Example

Header Parameters

Example

Example

Example

Example

Request Body required

Example

Responses

200

Example

Example

Example

400

Example

401

Example

Request Body^required