Social Content

Generate social media post images for property listings

POST/v1/social-content/generate202

Generate a branded social media post image for a property listing. Supports square (1:1), portrait (4:5), and story (9:16) formats.

Request Body

Parameter	Type	Required	Description
`post_type`	string	Yes	Social media post format: square (1:1), portrait (4:5), or story (9:16)
`property.address`	string	Yes	Full property address
`property.suburb`	string	No	Suburb name for display
`property.listing_type`	string	No	Listing type (e.g. For Sale, For Rent, Auction)
`property.price_display`	string	No	Display price string
`property.description`	string	No	Property description for the social post
`property.images`	string (URI)[]	Yes	Array of property image URLs (at least 1 required)
`branding.agent_name`	string	No	Real estate agent's full name
`branding.agent_phone`	string	No	Agent's phone number
`branding.agency_name`	string	No	Real estate agency name
`branding.agency_logo_url`	string (URI)	No	URL of agency logo image
`branding.agent_headshot_url`	string (URI)	No	URL of agent's headshot photo
`branding.primary_color`	string	No	Primary brand color (hex, e.g. #1A2B3C)
`branding.secondary_color`	string	No	Secondary brand color (hex)
`branding.additional_agents`	object[]	No	Additional agents to display on the post
`webhook_url`	string (URI)	No	URL to receive progress and completion webhooks
`callback_metadata`	object	No	Opaque data returned in webhook payloads

Request Example

{
  "post_type":  "square",
  "property":  {
    "address":  "example",
    "suburb":  "string",
    "listing_type":  "string",
    "price_display":  "string",
    "description":  "string",
    "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"
  }
}

Social Content Guide Jobs & Webhooks Guide Error Codes