Generate Tarot Reading (PDF or HTML)

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

POST

/reports/tarot

curl -X POST https://api.astroway.info/v1/reports/tarot \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "spread": "three-card", "seed": 1234, "name": "Sample Reading", "allowReversed": true, "language": "uk" }'

const res = await fetch('https://api.astroway.info/v1/reports/tarot', {
  method: 'POST',
  headers: {
    'X-Api-Key': process.env.ASTROWAY_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "spread": "three-card",
    "seed": 1234,
    "name": "Sample Reading",
    "allowReversed": true,
    "language": "uk"
  }),
});
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/tarot',
    headers={'X-Api-Key': os.environ['ASTROWAY_API_KEY'], 'Content-Type': 'application/json'},
    json={
      'spread': "three-card",
      'seed': 1234,
      'name': "Sample Reading",
      'allowReversed': True,
      'language': "uk"
    },
)
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/tarot', [
    'headers' => ['X-Api-Key' => getenv('ASTROWAY_API_KEY')],
    'json' => [
        'spread' => 'three-card',
        'seed' => 1234,
        'name' => 'Sample Reading',
        'allowReversed' => true,
        'language' => 'uk',
    ],
]);
$result = json_decode($r->getBody(), true);
if (!$result['ok']) throw new \RuntimeException($result['error']['message']);
print_r($result['data']);

Render a tarot reading PDF. Default spread three-card (Past/Present/Future from Rider-Waite-Smith deck). Available spreads: single-card, three-card, celtic-cross, horseshoe, relationship, year-ahead, decision, chakra, career, love-triangle. Pass seed for reproducibility (deterministic mulberry32 RNG); omit to use a daily seed. Set allowReversed: false to draw upright cards only.

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

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

spread

string

<= 64 characters

seed

integer

nullable

name

string

<= 100 characters

allowReversed

boolean

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

Example

{
  "spread": "three-card",
  "seed": 1234,
  "name": "Sample Reading",
  "allowReversed": true,
  "language": "uk"
}

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/abc-tarot.pdf",
    "storage_key": "reports/abc-tarot.pdf",
    "byte_length": 95000,
    "page_count": 1,
    "duration_ms": 2400,
    "expires_at": "2026-05-09T07:00:00Z"
  }
}

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 Tarot Reading (PDF or HTML)

Authorizations

Parameters

Query Parameters

Example

Example

Header Parameters

Example

Request Body required

Example

Responses

200

Example

Example

Example

400

Example

401

Example

Request Body^required