Skip to main content
POST
Premium Solar Return PDF report

Authorizations

Authorization
string
header
required

Use the raw API key as the Bearer token, or send X-API-Key instead.

Body

application/json
birth_subject
object
required
target_year
integer
required
Required range: 1900 <= x <= 2200
house_system
enum<string>
default:P
Available options:
P,
W,
K,
E
locale
enum<string>
default:en
Available options:
th,
en
name
string
Maximum string length: 120
branding
object

Visual white-label branding rendered into the PDF (logo, color) in addition to the LLM voice controls.

brand_profile_id
string

Response

Queued report job.

job_id
string
required
Example:

"job_a1b2c3d4e5f60718293a4b5c"

status
enum<string>
required
Available options:
queued
poll
string
required
Example:

"/api/v3/jobs/job_a1b2c3d4e5f60718293a4b5c"