Brochure Slides

Generate property marketing brochure slides as Polotno-compatible JSON. Create cover pages, feature highlights, galleries, location maps, agent profiles, and custom content slides.

Overview

The brochure slides endpoint generates a single slide of a specified type using property data, images, and optional agent/agency branding. The output is a Polotno JSON object that can be rendered in your application using the Polotno SDK.

Available slide types:

Type	Description
`cover`	Hero image with address, price, and key features
`features`	Property features and specifications
`gallery`	Multi-image photo gallery layout
`location`	Location and neighborhood information
`agent`	Agent profile with contact details
`content`	Custom content with description text

Quick Example

Generate a cover slide for a property listing:

curl -X POST \
  -H "X-API-Key: dome_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "property": {
      "address": "42 Harbour Road, Sydney NSW 2000",
      "property_type": "House",
      "price_display": "$2,500,000",
      "description": "Stunning harbourside residence with panoramic views",
      "features": [
        { "key": "Bedrooms", "value": "4" },
        { "key": "Bathrooms", "value": "3" },
        { "key": "Parking", "value": "2" }
      ],
      "images": [
        "https://example.com/front.jpg",
        "https://example.com/kitchen.jpg"
      ]
    },
    "slide": {
      "type": "cover",
      "title": "42 Harbour Road",
      "selected_images": ["https://example.com/front.jpg"]
    },
    "branding": {
      "agent_name": "Jane Smith",
      "agency_name": "Harbour Realty",
      "primary_color": "#1a365d"
    }
  }' \
  https://api.dometech.com.au/v1/brochure-slides/generate

Response (202):

{
  "data":  {
    "job_id":  "550e8400-e29b-41d4-a716-446655440000",
    "status":  "queued"
  },
  "meta":  {
    "request_id":  "req_abc123",
    "timestamp":  "2026-02-09T10:00:00.000Z",
    "mode":  "live"
  }
}

Step-by-Step

1. Prepare Property Data

Gather the property information you want to include on the slide. At minimum, you need the property address and a slide type. For the best results, include as much property data as possible: images, features, price, description, and agent branding.

The request body is organized into three sections:

property — Address, type, price, description, features, and images
slide — Slide type, optional custom title/description, and selected images for this specific slide
branding — Agent name, phone, email, headshot, agency name, logo, and brand colors

2. Submit the Generation Request

Send a POST request to /v1/brochure-slides/generate with your property data, slide configuration, and branding. Here is a minimal example with only required fields:

curl -X POST \
  -H "X-API-Key: dome_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "property": {
      "address": "42 Harbour Road, Sydney NSW 2000"
    },
    "slide": {
      "type": "features"
    }
  }' \
  https://api.dometech.com.au/v1/brochure-slides/generate

The API returns a 202 Accepted response with a job_id. The slide is generated asynchronously.

3. Poll for Completion

Poll the job status endpoint until the status changes to completed.

curl -H "X-API-Key: dome_live_your_key_here" \
  https://api.dometech.com.au/v1/jobs/550e8400-e29b-41d4-a716-446655440000

4. Retrieve the Polotno JSON

When the job completes, the output field contains the Polotno-compatible JSON that describes the slide layout. You can render this in your application using the Polotno SDK.

{
  "data":  {
    "id":  "550e8400-e29b-41d4-a716-446655440000",
    "job_type":  "brochure_slide",
    "status":  "completed",
    "mode":  "live",
    "input":  {
      "property":  { "address":  "42 Harbour Road, Sydney NSW 2000" },
      "slide":  { "type":  "cover" }
    },
    "output":  {
      "polotno_json":  {
        "width":  1080,
        "height":  1080,
        "pages":  [{ "children":  [] }]
      }
    },
    "created_at":  "2026-02-09T10:00:00.000Z",
    "updated_at":  "2026-02-09T10:00:45.000Z",
    "completed_at":  "2026-02-09T10:00:45.000Z"
  },
  "meta":  {
    "request_id":  "req_abc123",
    "timestamp":  "2026-02-09T10:00:45.000Z",
    "mode":  "live"
  }
}

Tip: Generate multiple slide types (cover, features, gallery, agent) and combine them into a complete brochure document in your application.

Options

The brochure slides endpoint accepts a rich set of parameters organized into three groups. Below are the key parameters — see the API Reference for the complete list.

Property

Parameter	Type	Required	Description
`property.address`	string	Yes	Full property address
`property.property_type`	string	No	Property type (e.g. "House", "Apartment")
`property.price_display`	string	No	Price display text (e.g. "$1,200,000", "Auction")
`property.description`	string	No	Property description text
`property.features`	array	No	Key-value features, e.g. `[{ "key": "Bedrooms", "value": "4" }]`
`property.images`	string[] (URIs)	No	Property image URLs

Slide

Parameter	Type	Required	Description
`slide.type`	string	Yes	Slide type: "cover", "features", "gallery", "location", "agent", "content"
`slide.title`	string	No	Custom slide title
`slide.description`	string	No	Custom slide description text
`slide.selected_images`	string[] (URIs)	No	Specific images to use on this slide

Branding

Parameter	Type	Description
`branding.agent_name`	string	Agent display name
`branding.agent_phone`	string	Agent phone number
`branding.agent_email`	string	Agent email address
`branding.agent_headshot_url`	string (URI)	Agent headshot image URL
`branding.agency_name`	string	Agency name
`branding.agency_logo_url`	string (URI)	Agency logo image URL
`branding.primary_color`	string	Primary brand color (hex or CSS color)
`branding.secondary_color`	string	Secondary brand color (hex or CSS color)

All branding parameters are optional. You can also include webhook_url and callback_metadata at the top level. See the API Reference for the complete parameter list.

Output

When the job completes, the output object contains:

Field	Type	Description
`polotno_json`	object	Polotno-compatible JSON describing the slide layout. Render using the Polotno SDK.

Next Steps

API Reference — Brochure Slides — Full parameter details and schemas
Voiceover — Generate audio narration to pair with your brochure
Jobs & Webhooks — Polling best practices and real-time notifications