Rivier/ Reference/ content

A proposal from the project's writing model for a passage

post/cms/assist

A proposal from the project's writing model for a passage: a draft, a rewrite, a shorter or longer version, a tone, a summary, a search description, alt text or a translation. Nothing is saved; the result is marked as machine-written.

Before you call

Credential
Authorization: Bearer $KEY
Scope
content:write
Sdk
content.entry.assist
Cli
content entry assist

Request bodyapplication/json, required

  • taskstringrequired
    One of: draft, rewrite, shorter, longer, tone, summary, seo, alt, translate.
  • textstring
    Default: . At most 12000 characters.
  • instructionstring
    At most 500 characters.
  • tonestring
    One of: plain, warm, formal, playful, confident.
  • languagestring
    At most 20 characters.

Responses

  • 200application/json
    Success

    object

  • 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