GetRulesResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/beyondwords/main/json-schema/beyondwords-get-rules-response-schema.json",
  "title": "GetRulesResponse",
  "x-generated": "2026-10-28",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_ae-authored/beyondwords-openapi-generated.yml#/components/schemas/GetRulesResponse",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Unique identifier for the rule"
    },
    "project": {
      "type": "object",
      "description": "Show child attributes"
    },
    "content": {
      "type": "object",
      "description": "Show child attributes"
    },
    "type": {
      "type": "string",
      "description": "The rule type. Possible values are substitute, say_as_word, say_as_letter_sequence, ipa_transcription, pinyin_transcription, jyutping_transcription."
    },
    "preview_status": {
      "type": "string",
      "description": "Status of preview generation for this rule"
    },
    "language": {
      "type": "object",
      "description": "Show child attributes"
    },
    "preview_voice": {
      "type": "object",
      "description": "Show child attributes"
    },
    "preview_audio": {
      "type": "object",
      "description": "Show child attributes"
    },
    "key": {
      "type": "string",
      "description": "The exact text to match in content when applying this rule"
    },
    "value": {
      "type": "string",
      "description": "Replacement text or phonetic transcription (depending on rule type)"
    },
    "magic_ipa_used": {
      "type": "boolean",
      "description": "When true, the Magic IPA feature was used to generate the transcription"
    },
    "created": {
      "type": "string",
      "description": "Time at which the object was created (ISO 8601)"
    },
    "updated": {
      "type": "string",
      "description": "Time at which the object was updated (ISO 8601)"
    }
  }
}