Engineering manualSchema reference
Declared schema reference
Exact checked-in JSON Schema definitions and their source paths.
These are the schemas declared in schemas/. They include adjacent product domains and do not establish that every runtime object is covered, that validation is invoked, or that the deployed database matches them. Checked-in SQL is preserved separately in the database declaration reference; inline JavaScript/TypeScript and provider response contracts still need separate mapping. Follow the data contract for those gaps.
| Schema | Source | Required top-level fields |
|---|---|---|
| Approval Decision | schemas/approval-decision.schema.json | decision_id, brand_id, decision_type, reason, reviewer, created_at, next_status |
| Approval | schemas/approval.schema.json | approval_id, asset_id, approval_status, approver, decision_id, notes, created_at |
| Asset Feedback Response | schemas/asset-feedback-response.schema.json | review_id, asset_id, asset_type_id, campaign_id, brand_id, open_design_design_system_id, reviewer, decision, approval_status, comments, per_variation_comments, pinpoint_comments, requested_changes, selected_variation_id, created_at |
| Asset Generation Run | schemas/asset-generation-run.schema.json | run_id, stage_id, campaign_id, brand_id, open_design_design_system_id, brand_gate, design_system_gate, campaign_gate, asset_types, variation_count_per_asset_type, total_variation_count, generation_provenance_summary, stage_5_started |
| Asset Review Page | schemas/asset-review-page.schema.json | review_page_id, asset_id, asset_type_id, brand_id, campaign_id, open_design_design_system_id, review_page_path, feedback_json_path, variation_ids, required_sections, review_status |
| Asset Variation | schemas/asset-variation.schema.json | variation_id, asset_id, asset_type_id, brand_id, campaign_id, open_design_design_system_id, funnel_stage, cta_id, audience_state, incentive, belief_shift, strategy_alignment, source_claim_trace_path, review_status, html_path, quality_report_path, generation_provenance |
| Asset | schemas/asset.schema.json | id, brand_id, campaign_id, type, funnel_stage, audience_id, cta_id, incentive, source_ids, claim_ids, metric_ids, review_status, artifact_path |
| Brand Evidence Pack | schemas/brand-evidence-pack.schema.json | evidence_pack_id, brand_slug, created_at, intake_mode, evidence_status, confidence_summary, identity, sources, context_dev, site_map, scraped_pages, screenshots, visual_identity, typography, layout_and_components, content_voice, positioning, proof_and_reputation, seo_and_site_architecture, social_and_external_voice, claims, items_to_confirm, open_design_handoff |
| Brand Intake Manifest | schemas/brand-intake-manifest.schema.json | manifest_id, brand_id, provider_statuses, evidence_pack_path, open_design_handoff_path, design_system_package_status, rich_package_valid, campaign_creation_allowed, source_ids, claim_ids, sources, claims |
| Brand Intake Normalized | schemas/brand-intake-normalized.schema.json | schema_version, normalized_id, brand_id, brand_name, source_url, generated_at, raw_inputs, identity, provider_groups, visual_identity, website, search_presence, sitemap, screenshots, ctas, sources, claims, blockers, review_state |
| Brand Intake Review Response | schemas/brand-intake-review-response.schema.json | review_id, brand_id, review_type, reviewer, created_at, decision, approval_status, review_source_hash, selected_logo, selected_color_roles, selected_typography, selected_ctas, ambiguity_resolutions, warnings, requested_changes |
| Brand Intake Review | schemas/brand-intake-review.schema.json | review_id, brand_id, brand_name, domain, intake_mode, evidence_status, confidence_summary, context_dev_status, context_dev_summary, brand_presentation, sources, claims, items_to_confirm, approval_status, next_action |
| Brand Studio brand-kit export manifest | schemas/brand-kit-export-manifest.schema.json | schema_version, run_id, domain, source_url, generated_at, capture_generated_at, capture_route, counts, media_mirror, files |
| Brand Studio results surface specification | schemas/brand-studio-results-surface-spec.schema.json | schema_version, updated_at, status, title, purpose, authority, section_order, sections, social_contract, delivery_outputs, quality_gates, featured_example_contract |
| Brand | schemas/brand.schema.json | id, name, status, review_status, source_url, design_system_path, content_system_path, voice_path, audiences, offers, ctas, proof_points, source_ids, claim_ids, review_requirements |
| Campaign Asset Plan | schemas/campaign-asset-plan.schema.json | id, campaign_id, brand_id, open_design_design_system_id, funnel_model, assets, created_at, updated_at |
| Campaign Board | schemas/campaign-board.schema.json | board_id, campaign_id, brand_id, open_design_design_system_id, source_files, sections, validation_status, missing_fields, blocked_reasons, rendered_path, generated_at |
| Campaign Review Response | schemas/campaign-review-response.schema.json | review_id, campaign_id, brand_id, open_design_design_system_id, reviewer, decision, approval_status, sections_acknowledged, source_claim_review_status, notes, requested_changes, created_at |
| Campaign | schemas/campaign.schema.json | id, brand_id, name, status, review_status, funnel_model, audience, incentive, cta, primary_cta_id, cta_ids, persona_ids, target_stages, metric_ids, metrics, source_ids, interview_answer_ids, created_at, updated_at |
| Brand Studio compressed checkpoint resume envelope | schemas/checkpoint-resume-envelope.schema.json | schema_version, encoding, sha256, uncompressed_bytes, compressed_bytes, data |
| Claim | schemas/claim.schema.json | id, claim, source_ids, confidence, verification_status, review_status |
| Brand Studio client evidence supplement | schemas/client-brand-input.schema.json | schema_version, client, evidence_sources |
| Brand Studio client brand system manifest | schemas/client-brand-system-manifest.schema.json | schema_version, system_version, generated_at, source, status, normalized_documents, markdown_projections, operational_records, evidence_records, social_media, package_inventory, presentation, guarantees |
| Brand Studio client social media context | schemas/client-social-media.schema.json | schema_version, status, brand, capture_context, summary, platforms, safe_claim, limitations, source_manifest |
| CTA | schemas/cta.schema.json | id, brand_id, campaign_id, label, action, destination, funnel_stage, incentive, metric_ids, review_status |
| DataForSEO consumed API response envelope | schemas/dataforseo-api-response-envelope.schema.json | status_code, status_message, cost, tasks |
| Brand Studio normalized DataForSEO keyword-difficulty result | schemas/dataforseo-keyword-difficulty-result.schema.json | None declared at root |
| Brand Studio normalized DataForSEO search-volume result | schemas/dataforseo-search-volume-result.schema.json | None declared at root |
| Design System Review Response | schemas/design-system-review-response.schema.json | review_id, brand_id, review_type, reviewer, created_at, decision, approval_status, review_source_hash, open_design_design_system_id, design_md_approval, token_approval, component_approval, provenance_approval, warnings, requested_changes |
| Design System Review | schemas/design-system-review.schema.json | review_id, brand_id, open_design_design_system_id, package_path, package_status, design_md_status, design_md_line_count, required_section_checklist, design_sections, brand_presentation, token_count, preview_links, provenance_summary, approval_status, next_action |
| Brand Studio featured local examples | schemas/featured-examples.schema.json | schema_version, updated_at, examples |
| Funnel Map | schemas/funnel-map.schema.json | id, campaign_id, brand_id, funnel_model, audience, incentive, cta, target_stages, metrics, stages |
| Governance Decision | schemas/governance-decision.schema.json | decision_id, asset_id, decision_type, reason, source_ids, claim_ids, created_by, created_at |
| Interview Answer | schemas/interview-answer.schema.json | id, brand_id, campaign_id, question_id, question, answer, derived_fields, review_status |
| Brand Studio link-first media state | schemas/media-link-state.schema.json | schema_version, media_id, canonical_post_url, canonical_media_url, role, delivery, storage, size_evidence |
| Brand Studio media storage evaluation | schemas/media-storage-evaluation.schema.json | schema_version, generated_at, policy, platforms, combined, lineage |
| Open Design Generation Evidence | schemas/open-design-generation-evidence.schema.json | asset_id, campaign_id, brand_id, open_design_design_system_id, generation_provenance, open_design_role, evidence_summary, honest_label, review_status |
| Open Design Design-System Handoff | schemas/open-design-handoff.schema.json | handoff_id, brand_slug, target, evidence_pack_path, required_outputs, design_md_requirements, provenance_rules |
| Persona | schemas/persona.schema.json | id, brand_id, campaign_id, label, who_needs_to_care, current_problem, current_belief, desired_belief, needs, source_ids, review_status |
| Pinpoint Comment | schemas/pinpoint-comment.schema.json | comment_id, variation_id, x_percent, y_percent, comment, created_at |
| Brand Studio product roadmap | schemas/product-roadmap.schema.json | schema_version, version, updated_at, status, product, status_vocabulary, themes, excluded_for_now, feedback |
| Publish Gate | schemas/publish-gate.schema.json | asset_id, publish_gate_status, blocking_reasons, required_decision_ids, checked_at |
| Brand Studio Reference Manifest | schemas/reference-manifest.schema.json | schema_version, reference_manifest_id, brand_id, reference_mode, references, review_status |
| Review Response Common | schemas/review-response-common.schema.json | review_id, brand_id, review_type, reviewer, created_at, decision, approval_status, review_source_hash, warnings, requested_changes |
| Review Response | schemas/review-response.schema.json | schema_version, response_id, review_surface_id, reviewer_decision, created_at, source_view_model, notes |
| Review View Model | schemas/review-view-model.schema.json | schema_version, template_id, view_model_id, source_normalized_json, title, brand_name, status_label, primary_task, next_action, hero_metrics, narrative_blocks, section_cards, data_groups, visual_evidence, object_map, review_controls, checklist, linked_outputs, raw_json_behavior |
| Review | schemas/review.schema.json | review_id, asset_id, campaign_id, brand_id, review_status, checks, reviewer_notes, created_at |
| Revision Request | schemas/revision-request.schema.json | revision_request_id, campaign_id, brand_id, open_design_design_system_id, source_feedback_paths, asset_revision_requests, revision_loop_status |
| Brand Studio selected-plan execution receipt | schemas/selected-plan-execution-receipt.schema.json | schema_version, plan_hash, domain, market, max_cost_usd, known_cost_usd, held_cost_usd, unknown_requests, actual_cost_usd, account_balance_movement_usd, account_reconciliation, provider_balance_observations, customer_credit_price, requests, coverage, all_selected_legs_passed |
| Brand Studio selected-plan execution | schemas/selected-plan-execution.schema.json | schema_version, execution_contract, rate_version, domain, market, preset, selection, rows, legs, max_cost_usd, price_kind, customer_credit_price, plan_hash |
| Brand Studio selected-plan quote request | schemas/selected-plan-quote-request.schema.json | pull_plan, seo_market, plan_bindings |
| Brand Studio selected-plan quote response | schemas/selected-plan-quote-response.schema.json | None declared at root |
| Brand Studio selected-plan start request | schemas/selected-plan-start-request.schema.json | pull_plan, seo_market, plan_bindings, plan_hash, approved_max_cost_usd |
| Brand Studio selected-plan start response | schemas/selected-plan-start-response.schema.json | status, pull_id, run_id, route, lane, poll, pull_tier, pull_tier_source, tiers |
| Brand Studio selected-plan status response | schemas/selected-plan-status-response.schema.json | status, pull_id, run_id, route, source_url, domain, pull_profile_id, elapsed_ms, overall_score, summary, leg_summary, legs_completed, legs_total, capture_result, created_at, contract_version |
| Signal | schemas/signal.schema.json | id, campaign_id, funnel_stage, metric, source |
| Brand Studio Social Capture V1 bundle | schemas/social-capture-v1.schema.json | schema_version, generated_at, canonical_source, markdown_role, captures, totals |
| Brand Studio normalized social content record | schemas/social-content-record.schema.json | schema_version, platform, content_type, identity, author, publication, text, media, engagement, conversation, ownership, coverage, provenance |
| Source | schemas/source.schema.json | id, type, url_or_path, retrieved_at, freshness, owner |
| Template Registry | schemas/template-registry.schema.json | stage_id, templates |
| Brand Studio visual direction state | schemas/visual-direction-state.schema.json | schema_version, stage_id, route, direction_count, book_mode, interview, approval, example_book_id, blockers, shipping_blocked, updated_at |