Brand Studio docs
Engineering manualSchema reference

Brand Studio selected-plan start request

Declared schema: schemas/selected-plan-start-request.schema.json

Source: schemas/selected-plan-start-request.schema.json. This is the complete declaration, including nested definitions and constraints. Its presence is not evidence that a runtime producer or consumer validates against it.

All schemas · Data structures and lineage

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://mirrorfactory.com/schemas/selected-plan-start-request.schema.json",
  "title": "Brand Studio selected-plan start request",
  "description": "The approved selected-plan request accepted by POST /api/comprehensive before reservation and provider dispatch.",
  "type": "object",
  "required": [
    "pull_plan",
    "seo_market",
    "plan_bindings",
    "plan_hash",
    "approved_max_cost_usd"
  ],
  "anyOf": [
    {
      "required": [
        "url"
      ],
      "properties": {
        "url": true
      }
    },
    {
      "required": [
        "source_url"
      ],
      "properties": {
        "source_url": true
      }
    }
  ],
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    },
    "source_url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    },
    "tier": {
      "type": [
        "string",
        "integer"
      ]
    },
    "depth": {
      "type": "string",
      "maxLength": 40
    },
    "pull_profile_id": {
      "type": "string",
      "maxLength": 40
    },
    "pull_plan": {
      "$ref": "selected-plan-execution.schema.json#/$defs/selection"
    },
    "seo_market": {
      "$ref": "selected-plan-execution.schema.json#/$defs/market"
    },
    "plan_bindings": {
      "type": "object"
    },
    "plan_hash": {
      "type": "string",
      "pattern": "^[a-f0-9]{64}$"
    },
    "approved_max_cost_usd": {
      "type": "number",
      "minimum": 0
    },
    "approved_account_id": {
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-(?:[0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$",
      "description": "Reviewed account_summary.account_id. Bind current consent to the authenticated account; never an entitlement grant."
    },
    "approved_customer_credits": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991,
      "description": "Reviewed account_summary.credits: maximum account credit charge, separate from canonical plan price and provider USD."
    },
    "idempotency_key": {
      "type": "string",
      "maxLength": 200
    },
    "page_budget": {
      "type": "integer",
      "minimum": 1
    },
    "social_limit": {
      "type": "integer",
      "minimum": 1
    },
    "urls": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "queries": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "social_profiles": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "grounded_industry": {
      "type": [
        "array",
        "string",
        "null"
      ]
    },
    "user_confirmations": {
      "type": [
        "object",
        "null"
      ]
    },
    "execution_approval_id": {
      "description": "Caller input is not approval authority; the server binds the configured approval identity."
    }
  },
  "dependentRequired": {
    "approved_account_id": [
      "approved_customer_credits"
    ],
    "approved_customer_credits": [
      "approved_account_id"
    ]
  },
  "additionalProperties": true
}