Praecise Platform
Menu

Rivier/ Reference/ files

Generate a picture from a description

post/creative/images

Generate a picture from a description. The brand kit is applied, the plan allowance is checked first, and the result is saved in the asset library as an AI-generated draft waiting for review. Answers 409 not_configured when no picture model is connected, and 422 safety_refusal when the provider declines the description.

Before you call

Credential
Authorization: Bearer $KEY
Scope
files:write
Mcp
rivier_creative_image_generate
Graphql
Mutation.filesCreativeImage
Sdk
files.creative.image
Cli
files creative image

Request bodyapplication/json, required

  • promptstringrequired
    What the picture should show. At most 2000 characters.
  • aspectstring
    The shape: square, landscape, portrait, wide or tall. One of: square, landscape, portrait, wide, tall.
  • seedinteger
    At least 0. At most 4294967295.
  • purposestring
    Where it will be used, for example a campaign or a page; kept as a tag on the asset. At most 80 characters.
  • modelIdstring
    At most 80 characters.
  • useBrandKitboolean
    Apply the project's brand colours and style to the description. On unless false.

Responses

  • 201application/json
    Success
    • idstring (uuid)required
    • kindstringrequired
      One of: image, video.
    • statestringrequired
      One of: running, ready, refused, failed.
    • promptstringrequired
    • sentPromptstringrequired
    • purposestring or nullrequired
    • aspectstring or nullrequired
    • seednumber or nullrequired
    • assetIdstring (uuid) or nullrequired
    • messagestring or nullrequired
    • createdBystringrequired
    • createdAtstringrequired
    • updatedAtstringrequired
  • 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