{"openapi":"3.1.0","info":{"title":"Foxcite API","description":"Foxcite (Foxcite) is an AI-powered SEO audit and brand visibility platform.","version":"1.0.0","x-guidance":"Foxcite is an AI-native SEO and brand visibility platform.\nIt helps you monitor how brands are cited and perceived across AI search engines (ChatGPT, Claude, Gemini, Grok, Perplexity).\n\nDiscovery:\n- OpenAPI is the source of truth for what can be invoked. Fetch /openapi.json.\n- For POST/PUT/PATCH routes, use requestBody.application/json with the schema in the OpenAPI document.\n\nAuth and payments:\n- SIWX (identity-only) routes use the SIGN-IN-WITH-X header and declare security: [{ \"siwx\": [] }].\n- Payable routes use the x402 protocol. Call the route without payment to receive a 402 challenge and then retry with x-payment-token."},"paths":{"/.well-known/x402":{"get":{"summary":"Well Known X402","description":"Redirect to the OpenAPI spec for x402 discovery.","operationId":"well_known_x402__well_known_x402_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[]}},"/sentry-test/error":{"get":{"summary":"Trigger Sentry Error","description":"Test endpoint that intentionally throws an error to verify Sentry.","operationId":"trigger_sentry_error_sentry_test_error_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[]}},"/sentry-test/message":{"get":{"summary":"Trigger Sentry Message","description":"Test endpoint that sends a test message to Sentry.","operationId":"trigger_sentry_message_sentry_test_message_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[]}},"/mcp/sse":{"get":{"summary":"Handle Sse","operationId":"handle_sse_mcp_sse_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"siwx":[]}]}},"/mcp/messages":{"post":{"summary":"Handle Messages","operationId":"handle_messages_mcp_messages_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"security":[{"siwx":[]}]}},"/":{"get":{"summary":"Read Root","operationId":"read_root__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[]}},"/health":{"get":{"summary":"Health Check","operationId":"health_check_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[]}},"/brands":{"get":{"summary":"Get Brands","operationId":"get_brands_brands_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Brand"},"type":"array","title":"Response Get Brands Brands Get"}}}}},"security":[{"siwx":[]}]},"post":{"summary":"Create Brand","operationId":"create_brand_brands_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Brand"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Brand"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"siwx":[]}]}},"/onboard":{"post":{"summary":"Onboard User","operationId":"onboard_user_onboard_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"security":[{"siwx":[]}]}},"/user/profile":{"get":{"summary":"Get User Profile","description":"Retrieves the current user's profile details including active subscription tier,\nremaining scan credits, and linked Stripe customer IDs.","operationId":"get_user_profile_user_profile_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"siwx":[]}]}},"/credits/recharge":{"post":{"summary":"Recharge Credits","operationId":"recharge_credits_credits_recharge_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RechargeRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"402":{"description":"Payment Required"}},"x-payment-info":{"price":{"mode":"dynamic","currency":"USD","min":"1.00","max":"100.00"},"protocols":[{"x402":{}}]},"security":[]}},"/brands/{brand_id}":{"get":{"summary":"Get Brand","operationId":"get_brand_brands__brand_id__get","parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","title":"Brand Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Brand"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"siwx":[]}]},"patch":{"summary":"Update Brand","operationId":"update_brand_brands__brand_id__patch","parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","title":"Brand Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBrandRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Brand"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"siwx":[]}]},"delete":{"summary":"Delete Brand","operationId":"delete_brand_brands__brand_id__delete","parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","title":"Brand Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"security":[{"siwx":[]}]}},"/brands/{brand_id}/settings":{"put":{"summary":"Update Brand Settings","operationId":"update_brand_settings_brands__brand_id__settings_put","parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","title":"Brand Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandSettingsUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Brand"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"siwx":[]}]}},"/brands/{brand_id}/toggle-query-tracking":{"post":{"summary":"Toggle Query Tracking","operationId":"toggle_query_tracking_brands__brand_id__toggle_query_tracking_post","parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","title":"Brand Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToggleQueryTrackingRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"siwx":[]}]}},"/brands/{brand_id}/keywords/data":{"post":{"summary":"Get Keyword Metrics","operationId":"get_keyword_metrics_brands__brand_id__keywords_data_post","parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","title":"Brand Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeywordDataRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"402":{"description":"Payment Required"}},"x-payment-info":{"price":{"mode":"dynamic","currency":"USD","min":"0.10","max":"5.00"},"protocols":[{"x402":{}}]},"security":[]}},"/brands/{brand_id}/queries/opportunities":{"post":{"summary":"Get Query Opportunities","operationId":"get_query_opportunities_brands__brand_id__queries_opportunities_post","parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","title":"Brand Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpportunityRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"402":{"description":"Payment Required"}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"1.00"},"protocols":[{"x402":{}}]},"security":[]}},"/brands/{brand_id}/keywords":{"get":{"summary":"List Keywords","operationId":"list_keywords_brands__brand_id__keywords_get","parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","title":"Brand Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"siwx":[]}]}},"/brands/{brand_id}/queries/classify":{"post":{"summary":"Trigger Query Classification","operationId":"trigger_query_classification_brands__brand_id__queries_classify_post","parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","title":"Brand Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"402":{"description":"Payment Required"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.10"},"protocols":[{"x402":{}}]},"security":[]}},"/brands/{brand_id}/competitors":{"get":{"summary":"Get Competitors","operationId":"get_competitors_brands__brand_id__competitors_get","parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","title":"Brand Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"siwx":[]}]},"post":{"summary":"Add Competitor","operationId":"add_competitor_brands__brand_id__competitors_post","parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","title":"Brand Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompetitorCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"siwx":[]}]}},"/brands/{brand_id}/competitors/{competitor_id}/ignore":{"patch":{"summary":"Ignore Competitor","operationId":"ignore_competitor_brands__brand_id__competitors__competitor_id__ignore_patch","parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","title":"Brand Id"}},{"name":"competitor_id","in":"path","required":true,"schema":{"type":"string","title":"Competitor Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"security":[{"siwx":[]}]}},"/brands/{brand_id}/competitors/{competitor_id}/mentions":{"get":{"summary":"Get Competitor Mentions","operationId":"get_competitor_mentions_brands__brand_id__competitors__competitor_id__mentions_get","parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","title":"Brand Id"}},{"name":"competitor_id","in":"path","required":true,"schema":{"type":"string","title":"Competitor Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"siwx":[]}]}},"/brands/{brand_id}/competitors/{competitor_id}/source-dossiers":{"get":{"summary":"Get Source Dossiers","operationId":"get_source_dossiers_brands__brand_id__competitors__competitor_id__source_dossiers_get","parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","title":"Brand Id"}},{"name":"competitor_id","in":"path","required":true,"schema":{"type":"string","title":"Competitor Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"siwx":[]}]}},"/stats":{"get":{"summary":"Get Stats","operationId":"get_stats_stats_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[]}},"/brands/{brand_id}/suggestions":{"get":{"summary":"Get Suggestions","operationId":"get_suggestions_brands__brand_id__suggestions_get","parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","title":"Brand Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"siwx":[]}]}},"/brands/{brand_id}/dashboard":{"get":{"summary":"Get Brand Dashboard","operationId":"get_brand_dashboard_brands__brand_id__dashboard_get","parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","title":"Brand Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"siwx":[]}]}},"/quick-audit":{"post":{"summary":"Quick Audit","operationId":"quick_audit_quick_audit_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuickAuditRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"402":{"description":"Payment Required"}},"x-payment-info":{"price":{"mode":"dynamic","currency":"USD","min":"0.15","max":"5.00"},"protocols":[{"x402":{}}]},"security":[]}},"/brands/{brand_id}/reports":{"get":{"summary":"Get Brand Reports","operationId":"get_brand_reports_brands__brand_id__reports_get","parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","title":"Brand Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"siwx":[]}]}},"/brands/{brand_id}/scans/adjacent":{"get":{"summary":"Get Adjacent Scans","operationId":"get_adjacent_scans_brands__brand_id__scans_adjacent_get","parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","title":"Brand Id"}},{"name":"current_scan_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","title":"Current Scan Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"siwx":[]}]}},"/reports/{scan_id}":{"get":{"summary":"Get Report Detail","operationId":"get_report_detail_reports__scan_id__get","parameters":[{"name":"scan_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Scan Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"siwx":[]}]},"delete":{"summary":"Delete Scan Session","operationId":"delete_scan_session_reports__scan_id__delete","parameters":[{"name":"scan_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Scan Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"security":[{"siwx":[]}]}},"/reports/public/{scan_id}":{"get":{"summary":"Get Report Detail Public","operationId":"get_report_detail_public_reports_public__scan_id__get","parameters":[{"name":"scan_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Scan Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[]}},"/settings/pricing":{"get":{"summary":"Get Pricing Settings","operationId":"get_pricing_settings_settings_pricing_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[]}},"/settings/pricing-plans":{"get":{"summary":"Get Pricing Plans","description":"Public endpoint providing current pricing plans, feature sets, \nStripe price mapping, and active Payment Links.","operationId":"get_pricing_plans_settings_pricing_plans_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[]}},"/webhooks/stripe":{"post":{"summary":"Stripe Webhook","description":"Unified Stripe webhook handler that processes checkout completions (grant initial credits)\nand monthly recurring invoice settlements (grant/reset plan credits completely).","operationId":"stripe_webhook_webhooks_stripe_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"security":[]}},"/estimate-cost":{"post":{"summary":"Estimate Cost","operationId":"estimate_cost_estimate_cost_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CostEstimateRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[]}},"/brands/{brand_id}/gsc/properties":{"get":{"summary":"Get Gsc Properties","operationId":"get_gsc_properties_brands__brand_id__gsc_properties_get","parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","title":"Brand Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"siwx":[]}]}},"/brands/{brand_id}/agents/trigger":{"post":{"summary":"Trigger Agent","operationId":"trigger_agent_brands__brand_id__agents_trigger_post","parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","title":"Brand Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerAgentRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"402":{"description":"Payment Required"}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.50"},"protocols":[{"x402":{}}]},"security":[]}},"/brands/{brand_id}/agents":{"get":{"summary":"Get Brand Agents Status","operationId":"get_brand_agents_status_brands__brand_id__agents_get","parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","title":"Brand Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"siwx":[]}]}},"/brands/{brand_id}/playbooks":{"get":{"summary":"List Brand Playbooks","operationId":"list_brand_playbooks_brands__brand_id__playbooks_get","parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","title":"Brand Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"siwx":[]}]}},"/brands/{brand_id}/playbooks/{playbook_id}":{"get":{"summary":"Get Brand Playbook Detail","operationId":"get_brand_playbook_detail_brands__brand_id__playbooks__playbook_id__get","parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","title":"Brand Id"}},{"name":"playbook_id","in":"path","required":true,"schema":{"type":"string","title":"Playbook Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"siwx":[]}]}},"/brands/{brand_id}/playbooks/from-scan":{"post":{"summary":"Create Playbook From Scan","operationId":"create_playbook_from_scan_brands__brand_id__playbooks_from_scan_post","parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","title":"Brand Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlaybookFromScanRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"402":{"description":"Payment Required"}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"1.00"},"protocols":[{"x402":{}}]},"security":[]}},"/brands/{brand_id}/playbooks/scan/{scan_id}":{"get":{"summary":"Get Playbooks For Scan","operationId":"get_playbooks_for_scan_brands__brand_id__playbooks_scan__scan_id__get","parameters":[{"name":"brand_id","in":"path","required":true,"schema":{"type":"string","title":"Brand Id"}},{"name":"scan_id","in":"path","required":true,"schema":{"type":"string","title":"Scan Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"siwx":[]}]}},"/agent/chat":{"post":{"summary":"Agent Chat","operationId":"agent_chat_agent_chat_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentChatRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"402":{"description":"Payment Required"}},"x-payment-info":{"price":{"mode":"dynamic","currency":"USD","min":"0.01","max":"5.00"},"protocols":[{"x402":{}}]},"security":[]}},"/agent/judge":{"post":{"summary":"Agent Judge Endpoint","operationId":"agent_judge_endpoint_agent_judge_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentJudgeRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"402":{"description":"Payment Required"}},"x-payment-info":{"price":{"mode":"fixed","currency":"USD","amount":"0.20"},"protocols":[{"x402":{}}]},"security":[]}},"/billing/checkout":{"post":{"summary":"Billing Checkout","operationId":"billing_checkout_billing_checkout_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"siwx":[]}]}},"/billing/portal":{"post":{"summary":"Billing Portal","operationId":"billing_portal_billing_portal_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"security":[{"siwx":[]}]}},"/billing/webhook":{"post":{"summary":"Billing Webhook","operationId":"billing_webhook_billing_webhook_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"security":[]}},"/cli/api-keys":{"post":{"summary":"Create Api Key","operationId":"create_api_key_cli_api_keys_post","parameters":[{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"security":[{"siwx":[]}]},"get":{"summary":"List Api Keys","operationId":"list_api_keys_cli_api_keys_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"siwx":[]}]}},"/cli/api-keys/{key_id}":{"delete":{"summary":"Delete Api Key","operationId":"delete_api_key_cli_api_keys__key_id__delete","parameters":[{"name":"key_id","in":"path","required":true,"schema":{"type":"string","title":"Key Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"security":[{"siwx":[]}]}},"/cli/analyze":{"post":{"summary":"Cli Analyze","operationId":"cli_analyze_cli_analyze_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CliAnalyzeRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"402":{"description":"Payment Required"}},"x-payment-info":{"price":{"mode":"dynamic","currency":"USD","min":"0.15","max":"25.00"},"protocols":[{"x402":{}}]},"security":[]}},"/cli/sync":{"get":{"summary":"Cli Sync","operationId":"cli_sync_cli_sync_get","parameters":[{"name":"domain","in":"query","required":true,"schema":{"type":"string","title":"Domain"}},{"name":"pages","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pages"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"siwx":[]}]}}},"components":{"schemas":{"AgentChatRequest":{"properties":{"message":{"type":"string","title":"Message"},"system_prompt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"System Prompt"},"model":{"type":"string","title":"Model","default":"deepseek/deepseek-v4-flash"},"conversation_history":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Conversation History"}},"type":"object","required":["message"],"title":"AgentChatRequest"},"AgentJudgeRequest":{"properties":{"agent_outputs":{"items":{},"type":"array","title":"Agent Outputs"},"criteria":{"type":"string","title":"Criteria","default":"Synthesize the best strategy."},"context":{"additionalProperties":true,"type":"object","title":"Context","default":{}}},"type":"object","required":["agent_outputs"],"title":"AgentJudgeRequest"},"Brand":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"slug":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Slug"},"domain":{"type":"string","title":"Domain"},"niche":{"type":"string","title":"Niche"},"weekly_scan_enabled":{"type":"boolean","title":"Weekly Scan Enabled","default":false},"daily_scan_enabled":{"type":"boolean","title":"Daily Scan Enabled","default":false},"daily_tracked_queries":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Daily Tracked Queries","default":"[]"},"target_llms":{"type":"string","title":"Target Llms","default":"Claude,ChatGPT"},"gsc_property":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Gsc Property"},"gsc_verified":{"type":"boolean","title":"Gsc Verified","default":false},"agent_automation_enabled":{"type":"boolean","title":"Agent Automation Enabled","default":false},"user_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"User Id"}},"type":"object","required":["name","domain","niche"],"title":"Brand"},"BrandSettingsUpdate":{"properties":{"weekly_scan_enabled":{"type":"boolean","title":"Weekly Scan Enabled"},"daily_scan_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Daily Scan Enabled","default":false},"target_llms":{"type":"string","title":"Target Llms"},"gsc_property":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Gsc Property"},"gsc_verified":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Gsc Verified","default":false}},"type":"object","required":["weekly_scan_enabled","target_llms"],"title":"BrandSettingsUpdate"},"CheckoutRequest":{"properties":{"plan_name":{"type":"string","title":"Plan Name"}},"type":"object","required":["plan_name"],"title":"CheckoutRequest"},"CliAnalyzeRequest":{"properties":{"domain":{"type":"string","title":"Domain"},"niche":{"type":"string","title":"Niche"},"brand":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Brand"},"queries":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Queries","default":{}},"engines":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Engines","default":["Claude","ChatGPT"]},"pages":{"anyOf":[{"items":{"$ref":"#/components/schemas/CliPageRequest"},"type":"array"},{"type":"null"}],"title":"Pages","default":[]}},"type":"object","required":["domain","niche"],"title":"CliAnalyzeRequest"},"CliPageRequest":{"properties":{"id":{"type":"string","title":"Id"},"url":{"type":"string","title":"Url"},"primary_keyword":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Primary Keyword"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","default":"planned"}},"type":"object","required":["id","url"],"title":"CliPageRequest"},"CompetitorCreate":{"properties":{"name":{"type":"string","title":"Name"},"domain":{"type":"string","title":"Domain"}},"type":"object","required":["name","domain"],"title":"CompetitorCreate"},"CostEstimateRequest":{"properties":{"query":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query","default":""},"engines":{"items":{"type":"string"},"type":"array","title":"Engines","default":["chatgpt","claude","gemini","perplexity","grok"]}},"type":"object","title":"CostEstimateRequest"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"KeywordDataRequest":{"properties":{"keywords":{"items":{"type":"string"},"type":"array","title":"Keywords"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","default":"us"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","default":"usd"},"dataSource":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Datasource","default":"gkp"}},"type":"object","required":["keywords"],"title":"KeywordDataRequest"},"OpportunityRequest":{"properties":{"query":{"type":"string","title":"Query"}},"type":"object","required":["query"],"title":"OpportunityRequest"},"PlaybookFromScanRequest":{"properties":{"scan_id":{"type":"string","title":"Scan Id"},"engine":{"type":"string","title":"Engine"},"cited_source_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cited Source Id"}},"type":"object","required":["scan_id","engine"],"title":"PlaybookFromScanRequest"},"QuickAuditRequest":{"properties":{"name":{"type":"string","title":"Name"},"domain":{"type":"string","title":"Domain"},"niche":{"type":"string","title":"Niche"},"engines":{"type":"string","title":"Engines","default":"Claude,ChatGPT"},"query":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query"}},"type":"object","required":["name","domain","niche"],"title":"QuickAuditRequest"},"RechargeRequest":{"properties":{"user_id":{"type":"string","title":"User Id"},"payment_token":{"type":"string","title":"Payment Token"},"amount_usdc":{"type":"number","title":"Amount Usdc","default":1.0}},"type":"object","required":["user_id","payment_token"],"title":"RechargeRequest"},"ToggleQueryTrackingRequest":{"properties":{"query":{"type":"string","title":"Query"},"enabled":{"type":"boolean","title":"Enabled"}},"type":"object","required":["query","enabled"],"title":"ToggleQueryTrackingRequest"},"TriggerAgentRequest":{"properties":{"agent_id":{"type":"string","title":"Agent Id"},"scan_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scan Id"}},"type":"object","required":["agent_id"],"title":"TriggerAgentRequest"},"UpdateBrandRequest":{"properties":{"agent_automation_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Agent Automation Enabled"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"domain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Domain"},"niche":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Niche"}},"type":"object","title":"UpdateBrandRequest"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"siwx":{"type":"apiKey","in":"header","name":"SIGN-IN-WITH-X","description":"SIWX (Sign-In with X) wallet proof header for identity-gated routes."}}},"x-ownership-proofs":[{"address":"0x24eB5751eCB5f37D6D0837151e0a7bcBB214B3A4","signature":"0xc06e8500a0179242d363065c72dddb2c2552d223b099e6858bee79c979fe684b60c9be18f5d6ffcef93d17efdd6135776d3bdbfd4ea95676683f35f5f68052461c"}]}