Brochure Slides
Generate branded brochure slides for listings
POST
/v1/brochure-slides/generate202Generate a branded real estate brochure slide. Supports cover, features, gallery, location, agent, and content templates.
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
property.address | string | Yes | Full property address |
property.price_display | string | No | Display price string (e.g. $1,200,000 or Contact Agent) |
property.description | string | No | Property description text for the brochure |
property.images | string (URI)[] | No | Array of property image URLs to use in the slide |
slide.type | string | Yes | Slide template type: cover, features, gallery, location, agent, or content |
slide.title | string | No | Custom slide title (overrides template default) |
slide.description | string | No | Custom slide description text |
slide.layout_description | string | No | Natural language layout instructions for AI generation |
slide.selected_images | string (URI)[] | No | Specific images to use on this slide (subset of property images) |
branding.agent_name | string | No | Real estate agent's full name |
branding.agent_phone | string | No | Agent's phone number |
branding.agent_email | string | No | Agent's email address |
branding.agent_headshot_url | string (URI) | No | URL of agent's headshot photo |
branding.agency_name | string | No | Real estate agency name |
branding.agency_logo_url | string (URI) | No | URL of agency logo image |
branding.primary_color | string | No | Primary brand color (hex, e.g. #1A2B3C) |
branding.secondary_color | string | No | Secondary brand color (hex) |
webhook_url | string (URI) | No | URL to receive progress and completion webhooks |
callback_metadata | object | No | Opaque data returned in webhook payloads |
Request Example
{
"property": {
"address": "example",
"price_display": "string",
"description": "string",
"images": [
"https://example.com/image.jpg"
]
},
"slide": {
"type": "cover",
"title": "string",
"description": "string",
"layout_description": "string",
"selected_images": [
"https://example.com/image.jpg"
]
},
"webhook_url": "https://example.com/image.jpg"
}Response
{
"data": {
"job_id": "550e8400-e29b-41d4-a716-446655440000",
"status": "queued"
},
"meta": {
"request_id": "req_abc123",
"timestamp": "2026-03-12T10:00:00.000Z",
"mode": "live"
}
}On this page