RoofKit
Developer docsPartner API
API keys

Generate visualization

Reserves one billable visualization attempt, runs the existing AI generation pipeline, stores the generated image, and completes the canonical row.

Bearer API key · Scope: sales_visualizer.use

Endpoint

POST/api/v1/visualizations/{visualization_id}/generate
Request bodyrequired
Path parameters1 parameter
  • visualization_idrequired
    string

Headers1 parameter
  • Idempotency-Keyrequired
    string

Responses

200Visualization generated or replayed.

Headers

  • X-RateLimit-LimitMaximum requests allowed in the current window.
  • X-RateLimit-RemainingRequests remaining in the current window.
  • X-RateLimit-ResetISO timestamp when the current rate-limit window resets.
  • Idempotency-ReplayedPresent and true when a stored successful write response was replayed.
400Request payload, query, or required header is invalid.
application/json
ErrorResponse
401Missing, malformed, revoked, deleted, or unknown API key.

Headers

  • WWW-AuthenticateDocumented response header
application/json
ErrorResponse
403API key lacks the required scope or the workspace is not active.
application/json
ErrorResponse
404Resource not found in the key-bound workspace.
application/json
ErrorResponse
409Request conflicts with idempotency or external event identity.
application/json
ErrorResponse
429Rate limit exceeded for this key and endpoint or invalid-auth bucket.

Headers

  • X-RateLimit-LimitMaximum requests allowed in the current window.
  • X-RateLimit-RemainingRequests remaining in the current window.
  • X-RateLimit-ResetISO timestamp when the current rate-limit window resets.
  • Retry-AfterSeconds until the caller should retry.
application/json
ErrorResponse
500Internal authentication or server error.
application/json
ErrorResponse
Try it out
Path parameters
Headers