Skip to main content
POST
Generate visualization
Required scopes: sales_visualizer.use

Authorizations

Authorization
string
header
required

Use Authorization: Bearer rk_live_....

Headers

Idempotency-Key
string
required

A unique value for each new request, such as a UUID. Send the same value to retry a request safely. The same key and payload replay the first response with Idempotency-Replayed: true.

Required string length: 1 - 160

Path Parameters

visualization_id
string
required
Required string length: 1 - 200

Body

application/json
photo_url
string
required
Example:

"https://example.com/house.jpg"

material_name
string
required
Maximum string length: 100
Example:

"Architectural Shingle"

color_name
string
required
Maximum string length: 100
Example:

"Charcoal"

color_hex
string
Maximum string length: 7
Example:

"#333333"

shape_name
string
Maximum string length: 100
reference_roof_image_url
string

Optional reference image as a secure HTTPS URL or data:image URL.

Maximum string length: 2000000

Response

Visualization generated or replayed.

generation
object
required
visualization
object
required