Skip to main content
POST
Create 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

Body

application/json
session_id
string
required
Maximum string length: 500
Example:

"session_123"

original_image_url
string
required
Example:

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

landing_id
string | null
Maximum string length: 150
landing_name
string | null
Maximum string length: 200
landing_slug
string | null
Maximum string length: 80
selected_material_id
string | null
Maximum string length: 150
selected_color_id
string | null
Maximum string length: 150
selected_shape_id
string | null
Maximum string length: 150

Response

Visualization row created.

visualization
object
required