Rivier/ Reference/ hosting

A complete, coherent design choice from a brief alone (every field optional)

post/hosting/design-library/design

A complete, coherent design choice from a brief alone (every field optional): palette, type pairing, spacing and shape, sections, flow, closest template, and for apps shell, screens and component style; plus alternatives with a reason each. A brand kit (colours, fonts, voice) acts as constraints: the palette is built from the brand colours with every contrast correction reported, brand fonts without a web licence are replaced by the nearest open pairing. Deterministic and versioned (selectionVersion).

Before you call

Credential
Authorization: Bearer $KEY
Scope
hosting:write
Mcp
rivier_design_library_design
Graphql
Mutation.hostingLibraryDesign
Sdk
hosting.library.design
Cli
hosting library design

Request bodyapplication/json, required

  • textstring
    At most 1500 characters.
  • surfacestring
    One of: website, app, both.
  • siteTypestring
    At most 40 characters.
  • appTypestring
    One of: customer-portal, guest-app, member-area, staff-dashboard, booking-app, shop-app, internal-tool, community-app.
  • businessTypestring
    At most 40 characters.
  • purposelist of string
  • moodlist of string
  • densitystring
    One of: airy, balanced, compact.
  • languageslist of string
  • rtlboolean
  • a11ystring
    One of: AA, AAA.
  • brandobject
    • draftboolean
    • namestring
      At most 60 characters.
    • colorslist of stringrequired
    • fontslist of object
      • familystringrequired
        At most 60 characters.
      • rolestring
        One of: heading, body, both.
      • stylestring
        One of: sans, serif, mono, display.
      • webLicenceboolean or unknownrequired
    • imagerystring
      At most 200 characters.
    • voicelist of string
    • logoTextstring
      At most 40 characters.
  • useStoredBrandboolean
  • darkboolean

Responses

  • 200application/json
    Success
    • 400application/json
      The request was malformed
      • errorstringrequired
      • messagestring
    • 401application/json
      No valid credential
      • errorstringrequired
      • messagestring
    • 403application/json
      The credential lacks the scope, origin or address
      • errorstringrequired
      • messagestring
    • 429application/json
      Over the key's rate limit; see Retry-After
      • errorstringrequired
      • messagestring

    This page as Markdown