{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/agentseo-dev/json-schema/agentseo-dev-opportunity-brief-params-schema.json",
  "title": "OpportunityBriefParams",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/agentseo-dev-opportunities-api-openapi.yml#/components/schemas/OpportunityBriefParams",
  "type": "object",
  "required": [
    "keyword",
    "target"
  ],
  "properties": {
    "keyword": {
      "type": "string"
    },
    "target": {
      "type": "string",
      "description": "Target domain or URL."
    },
    "page_url": {
      "type": "string",
      "format": "uri"
    },
    "location": {
      "type": "string",
      "default": "United States"
    },
    "location_code": {
      "type": "integer",
      "minimum": 1,
      "description": "Optional search location code for deterministic geo-targeting."
    },
    "language": {
      "type": "string",
      "default": "en"
    },
    "opportunity_type": {
      "type": "string",
      "enum": [
        "quick_win",
        "content_refresh",
        "ai_overview_opportunity",
        "featured_snippet_opportunity",
        "commercial_intent_opportunity",
        "lost_keyword_recovery",
        "competitor_gap"
      ]
    },
    "current_rank": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "include_competitor_outlines": {
      "type": "boolean",
      "default": true,
      "description": "Scrapes top competitor outlines and increases request cost by 2 credits."
    }
  }
}