{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/kreatorflow-ai/json-schema/kreatorflow-ai-character-request-schema.json",
  "title": "CharacterRequest",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/kreatorflow-ai-openapi.json#/components/schemas/CharacterRequest",
  "type": "object",
  "properties": {
    "mode": {
      "type": "string",
      "description": "register/save/asset to save a reusable character; omit for prompt-mode generation"
    },
    "name": {
      "type": "string",
      "description": "string optional developer-facing label"
    },
    "upload_id": {
      "type": "string",
      "description": "string required for register mode; owned image upload_id from POST /v1/uploads"
    },
    "prompt": {
      "type": "string",
      "description": "string required for prompt-mode generation; describe character appearance, wardrobe, pose, style, and composition"
    },
    "description": {
      "type": "string",
      "description": "string optional alias/fallback for prompt"
    },
    "model": {
      "type": "string",
      "description": "string optional image alias, defaults to kreator-image-pro"
    },
    "aspect_ratio": {
      "type": "string",
      "description": "string optional"
    },
    "ratio": {
      "type": "string",
      "description": "alias for aspect_ratio"
    },
    "resolution": {
      "type": "string",
      "description": "string optional"
    },
    "reference_upload_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "array required for prompt-mode generation when character_ids is omitted; owned image upload_id values from POST /v1/uploads; use readable images at least 300px wide"
    },
    "reference_image_upload_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "array optional alias; owned image upload_id values"
    },
    "character_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "array optional; reusable character ids/slugs from POST /v1/characters mode=register"
    },
    "safety_identifier": {
      "type": "string",
      "description": "string optional, max 64 chars"
    },
    "webhook_url": {
      "type": "string",
      "format": "uri",
      "description": "https url optional; receives terminal job callbacks"
    },
    "callback_url": {
      "type": "string",
      "description": "alias for webhook_url"
    },
    "idempotency_key": {
      "type": "string",
      "description": "string optional body fallback; prefer Idempotency-Key header"
    }
  },
  "additionalProperties": true
}