Skip to main content
POST
Create upload session
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
material_name
string
required
Maximum string length: 100
Example:

"Architectural Shingle"

color_name
string
required
Maximum string length: 100
Example:

"Charcoal"

session_id
string | null

Optional Sales Visualizer session that groups the render. Defaults to upload_session:{id}.

Maximum string length: 200
color_hex
string
Pattern: ^#[0-9A-Fa-f]{6}$
Example:

"#333333"

shape_name
string | null
Maximum string length: 100
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
locale
enum<string>
default:en

Language of the homeowner upload page.

Available options:
en,
es
expires_in_minutes
integer
default:60
Required range: 5 <= x <= 1440

Response

Upload session created.

upload_session
object
required