Generate Tarot Reading (PDF or HTML)

POST

/reports/tarot

request.sh

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

▸ Спробувати POST /reports/tarot

• Production

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

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

4

Request Body ^required

Media type 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

boolean

object

object

companyName

string

>= 1 characters <= 80 characters

companyUrl

string format: uri

companyEmail

string format: email

companyMobile

string

<= 40 characters

companyBio

string

<= 500 characters

logoUrl

string format: uri

frontImage

string format: uri

textPrimaryColor

string

/^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/

textSecondaryColor

string

/^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/

backgroundColor

string

/^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/

themeColor

Accent colour, used for section heading text and inline emphasis.

string

/^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/

headingColor

Colour of the divider rule under each section heading (not the heading text, which is themeColor).

string

/^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/

footerText

string

<= 200 characters

fontPairing

string

Allowed values: serif-sans sans-serif serif-only sans-only system

reportName

string

>= 1 characters <= 80 characters

Example

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

Responses

200

Successful calculation

Media type application/json

object

ok

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

400

Validation error

Media type 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

Media type application/json

Example

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