Brand Studio docs
Engineering manualSchema reference

Brand Studio selected-plan start response

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

Source: schemas/selected-plan-start-response.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-response.schema.json",
  "title": "Brand Studio selected-plan start response",
  "description": "The initial accepted reservation returned by POST /api/comprehensive before asynchronous queue execution.",
  "type": "object",
  "required": [
    "status",
    "pull_id",
    "run_id",
    "route",
    "lane",
    "poll",
    "pull_tier",
    "pull_tier_source",
    "tiers"
  ],
  "properties": {
    "status": {
      "const": "running"
    },
    "pull_id": {
      "type": "string",
      "minLength": 1
    },
    "run_id": {
      "type": "string",
      "minLength": 1
    },
    "route": {
      "const": "hosted"
    },
    "lane": {
      "const": "queue"
    },
    "poll": {
      "type": "string",
      "pattern": "^/api/comprehensive\\?pull_id="
    },
    "pull_tier": {
      "type": "integer",
      "minimum": 1
    },
    "pull_tier_source": {
      "type": "string",
      "minLength": 1
    },
    "tiers": {
      "type": "object",
      "required": [
        "instant",
        "comprehensive"
      ],
      "properties": {
        "instant": {
          "const": "no account needed"
        },
        "comprehensive": {
          "const": "this pull — all-REST, no browser"
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}