Paper Letters

Create paper letter generation

Charge BuddyPoints and enqueue an idempotent paper letter generation

post/v1/paper-letters/generations

Request

  • Base URL: https://dev.api.bb.tricirc.de (the document declares no server; this is the origin it was published from)
  • URL: https://dev.api.bb.tricirc.de/v1/paper-letters/generations
  • Auth: session-cookie (a scheme the document does not define)

Request body

$schemastring uri

A URL to the JSON Schema for this object.

clientRequestIdstring required
locale'en' | 'de' | 'ru' | 'ua' | 'pl' | 'ar' required
mode'generate' | 'improve' required
modelstring required
sourceCaseIdstring
sourceDocumentIdstring

Example request

{
  "$schema": "https://example.com/schemas/CreateGenerationInputBody.json"
}

Response

Accepted

$schemastring uri

A URL to the JSON Schema for this object.

clientRequestIdstring required
completedAtstring date-time
createdAtstring date-time required
errorMessagestring
generationIdstring required
localestring required
modestring required
modelstring required
refundedboolean required
sourceCaseIdstring nullable required
sourceDocumentIdstring nullable required
startedAtstring date-time
statusstring required
updatedAtstring date-time required

Example response

{
  "$schema": "https://example.com/schemas/GenerationBody.json"
}

Changes

No recorded changes to this operation across all 1 revision of this API.