AQaquavoice
customizations

Apply transcript customization operations

Applies all operations atomically against the latest state. Each operation says what to want, not what to change, so no read is needed first. Send expected_revision to refuse a write over a newer change (409 transcript_customizations_conflict). Send dry_run: true to get the would-be state and results without saving.

patch/customizations

Request

  • Base URL
    https://api.aquavoice.com/v1
  • Auth
    HTTP bearer

Request body

expected_revisioninteger

Optional. When present, the write fails with 409 unless this is the current revision.

dry_runboolean

Validate and compute the response without saving.

Example request

{
  "operations": [
    {
      "replacements": [
        {
          "from": "AV",
          "to": "Aqua Voice"
        }
      ]
    }
  ]
}

Response

Updated customization state, with one result per operation.

object'customizations' required
revisioninteger required
updated_atstring date-time nullable required
dictionarystring[] required
custom_instructionsstring required
warningstring

Only in an update result. Present when the dictionary is longer than speech recognition reads.

Example response

{
  "revision": 12,
  "dictionary": [
    "Aquaphone"
  ],
  "replacements": [
    {
      "from": "AV",
      "to": "Aqua Voice"
    }
  ],
  "custom_instructions": "Keep issue keys such as AQUA-142 in uppercase.",
  "results": [
    {
      "added": [
        {
          "from": "AV",
          "to": "Aqua Voice"
        }
      ],
      "removed": [
        {
          "from": "AV",
          "to": "Aqua Voice"
        }
      ]
    }
  ]
}

Changes

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