Saltar al contenido principal
POST
Crear sesión de subida
Scopes requeridos: sales_visualizer.use

Autorizaciones

Authorization
string
header
requerido

Usa Authorization: Bearer rk_live_....

Encabezados

Idempotency-Key
string
requerido

Un valor único para cada solicitud nueva, como un UUID. Envíe el mismo valor para reintentar una solicitud de forma segura. La misma clave y el mismo payload repiten la primera respuesta con Idempotency-Replayed: true.

Required string length: 1 - 160

Cuerpo

application/json
material_name
string
requerido
Maximum string length: 100
Ejemplo:

"Architectural Shingle"

color_name
string
requerido
Maximum string length: 100
Ejemplo:

"Charcoal"

session_id
string | null

Sesión opcional de Sales Visualizer que agrupa el render. Por defecto es upload_session:{id}.

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

"#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>
predeterminado:en

Idioma de la página de subida del propietario.

Opciones disponibles:
en,
es
expires_in_minutes
integer
predeterminado:60
Rango requerido: 5 <= x <= 1440

Respuesta

Sesión de subida creada.

upload_session
object
requerido