API reference

InferredVoice

The objects, fields and constraints behind the API.

Field Type & constraints

summaryrequired stringMin. characters: 20. Max. characters: 600.

languagesrequired string[]Min. items: 1. Max. items: 4.

audiencerequired stringMin. characters: 1. Max. characters: 240.

traitsrequired

object[]Min. items: 5. Max. items: 12.

Nested fields ↓

Field	Type & constraints
`dimension`required	stringValues: tone, rhythm, vocabulary, structure, hooks, humor, formatting, cta, avoid.
`observation`required	stringMin. characters: 1. Max. characters: 240.
`instruction`required	stringMin. characters: 1. Max. characters: 240.
`evidence`required	string[]Min. items: 1. Max. items: 5.

pillarsrequired

object[]Min. items: 1. Max. items: 5.

Nested fields ↓

Field	Type & constraints
`topic`required	stringMin. characters: 1. Max. characters: 240.
`angle`required	stringMin. characters: 1. Max. characters: 240.
`evidence`required	string[]Min. items: 1. Max. items: 5.

avoidrequired string[]Max. items: 8.

caveatsrequired string[]Max. items: 5.

View JSON schema

{
  "type": "object",
  "properties": {
    "summary": {
      "type": "string",
      "minLength": 20,
      "maxLength": 600
    },
    "languages": {
      "minItems": 1,
      "maxItems": 4,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 2,
        "maxLength": 40
      }
    },
    "audience": {
      "type": "string",
      "minLength": 1,
      "maxLength": 240
    },
    "traits": {
      "minItems": 5,
      "maxItems": 12,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "dimension": {
            "type": "string",
            "enum": [
              "tone",
              "rhythm",
              "vocabulary",
              "structure",
              "hooks",
              "humor",
              "formatting",
              "cta",
              "avoid"
            ]
          },
          "observation": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          },
          "instruction": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          },
          "evidence": {
            "minItems": 1,
            "maxItems": 5,
            "type": "array",
            "items": {
              "type": "string",
              "pattern": "^\\d{1,30}$"
            }
          }
        },
        "required": [
          "dimension",
          "observation",
          "instruction",
          "evidence"
        ]
      }
    },
    "pillars": {
      "minItems": 1,
      "maxItems": 5,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "topic": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          },
          "angle": {
            "type": "string",
            "minLength": 1,
            "maxLength": 240
          },
          "evidence": {
            "minItems": 1,
            "maxItems": 5,
            "type": "array",
            "items": {
              "type": "string",
              "pattern": "^\\d{1,30}$"
            }
          }
        },
        "required": [
          "topic",
          "angle",
          "evidence"
        ]
      }
    },
    "avoid": {
      "maxItems": 8,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 240
      }
    },
    "caveats": {
      "maxItems": 5,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 240
      }
    }
  },
  "required": [
    "summary",
    "languages",
    "audience",
    "traits",
    "pillars",
    "avoid",
    "caveats"
  ]
}

← All data models