RoomRecast API

RoomRecast provides a small, purpose-built HTTP API for orchestrating AI powered interior design workflows. The backend is built with Hono and exposes REST-style endpoints for uploading source imagery, submitting generation jobs, and retrieving the resulting assets.

Overview

All endpoints listed in this documentation are served from the same origin as your deployed backend. Use the relative paths shown in each section (for example, POST /virtual-staging). Unless noted otherwise, endpoints expect and return JSON payloads encoded with application/json.

Authentication

Authenticated endpoints require a valid JSON Web Token (JWT) issued by RoomRecast. Include the token in the Authorization header using the Bearer <token> scheme. Calls that omit the header or use an invalid token receive a 401 Unauthorized response. The /upload endpoint is the only unauthenticated route documented here.

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Requests and responses

  • Idempotency. The documented endpoints do not implement automatic deduplication. Avoid resubmitting the same request body unless you intend to create a new job.
  • Timestamps. Responses that include timestamps (such as projects or jobs) use ISO 8601 strings in UTC.
  • Errors. Error responses include an error field describing the issue and use standard HTTP status codes to indicate whether validation failed (400), authentication was missing (401), a conflict occurred (409), or an unexpected server failure happened (500).

Was this page helpful?