Skip to main content
POST
Compatibility 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
person_a
object
required
person_b
object
required
systems
enum<string>[]
Available options:
western,
bazi,
thai
locale
enum<string>
default:th
Available options:
th,
en
branding
object

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

async
boolean
default:false

When true, returns 202 with a job_id immediately instead of holding the connection; poll GET /api/v3/jobs/{id} for the result. Credits are charged at enqueue and refunded automatically if the job fails.

Response

PDF generated and uploaded; signed URL valid for 24 hours.

pdf_url
string<uri>
required
expires_at
string<date-time>
required