← Reports engine/Reports
GET/v1/reports/:id

Reports API

Poll status + fetch the signed download URL when ready.

Get free API keyTry in playgroundFull schema in docs

About the engine

Part of the Reports engine

When a single API call's response is a 50KB JSON, the next thing your customer wants is a PDF. The reports surface enqueues async generation, polls to ready, and serves a stable shareable URL plus a downloadable PDF. Today's catalog covers compatibility, multi-year varshphal (1–25 years per call), and both numerology systems individually + combined.

Request

Try it from the command line

# 'id' is the report_id returned by the POST that queued the report.
curl -X GET 'https://api.astronode.dev/v1/reports/rep_01J8Z2K9QF7W3X5Y6N4M2P8T1B' \
  -H 'Authorization: Bearer aie_test_REPLACE_WITH_YOUR_API_KEY' \
  -H 'Accept: application/json'

Every AstroNode endpoint needs a bearer token from your dashboard. Test keys (aie_test_*) work on the free tier - 1,000 requests / month, no card.

Request schema

Fields GET /v1/reports/:id accepts

Path parameters

Path parameters for GET /v1/reports/:id
FieldTypeNotes
idrequiredstring

len 1..

Generated from the same OpenAPI 3.1 document the API validates against, so this table cannot drift from the endpoint without the build failing.

Response

What you get back

Every AstroNode response uses the same envelope: request_id, data (the endpoint-specific payload), interpretation (optional narrative block), and meta (engine version + computed_at timestamp). This endpoint documents 200, 400, 401, 404, 429.

Fields inside data

Response data fields for GET /v1/reports/:id
FieldTypeNotes
idrequiredstring-
typerequiredenum

chart_summary | compatibility | compatibility_batch | mangal_dosha | varshphal_multi_year | kp_chart_report | lal_kitab_report | numerology_report

statusrequiredenum

pending | ready | failed

resultobject-
error_messageobject-

Engine highlights

What the Reports engine ships

  • Asynchronous queue (BullMQ in production, in-process in dev)
  • Polling endpoint exposes pending / ready / failed states
  • Optional public share link with PII redaction toggle
  • PDF artefacts via pdfkit - invoice-grade typography
  • Cap: 25 years per multi-year varshphal request, 500 pairs per compatibility batch

Related endpoints

Other Reports endpoints

POST/v1/reports/compatibility

Async detailed Gun Milan compatibility PDF.

POST/v1/reports/varshphal-multi-year

1–25 years of varshphal (year-chart + muntha + mudda + Tajika yogas + balas + month-chart) in one PDF.

POST/v1/numerology/pythagorean/report

Async Pythagorean numerology PDF.

POST/v1/numerology/chaldean/report

Async Chaldean numerology PDF.

POST/v1/numerology/report

Combined Pythagorean + Chaldean numerology PDF.

POST/v1/compatibility/batch

Batch scoring up to 500 pairs - async, results sorted by score desc.

Ready to call GET /v1/reports/:id?

Free tier covers 1,000 requests / month. Razorpay-billed, GST-compliant invoices when you upgrade.

Get free API keyTry in playground

Informational, not predictive. Not medical, legal, or financial advice.