Public APIs for partners and agents

Dream Office publishes a machine-readable API catalog at /.well-known/api-catalog per RFC 9727. Each entry links to an OpenAPI spec, this documentation, and a live health check.

Discovery

Automated clients should fetch the catalog first. Do not scrape HTML for endpoint lists.

Partner embed

White-label remodel widget for Ultra partners. Visitors upload a photo of a real office, chat a brief, get a remodel with that partner’s catalogue, and submit a lead.

Anchor /api/v1/embed · OpenAPI

Auth: Publishable key on session create. Later calls send x-embed-session (or Authorization: Bearer) with the session token. Origin must be on the partner allowlist.

GET /api/v1/embed/bootstrap?partnerSlug=
POST /api/v1/embed/sessions
POST /api/v1/embed/photo
POST /api/v1/embed/chat
POST /api/v1/embed/catalog/match
POST /api/v1/embed/generate
POST /api/v1/embed/leads

Public designs

Read the public inspiration gallery. Filter by style, room type, tag, segment, or use case. No authentication.

Anchor /api/public-designs · OpenAPI

Auth: None. Rate-limited.

GET /api/public-designs
GET /api/public-designs/{id}

Space calculator

Given room length, width, and headcount, return workstation counts, area per person, and common-area split. Powers the free space calculator tool.

Anchor /api/tools/space-calculator · OpenAPI

Auth: None.

POST /api/tools/space-calculator