{ "components": { "schemas": { "Body_generate_openapi_v1_geo_brands__brand_id__generate_post": { "properties": { "count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Count" } }, "type": "object", "title": "Body_generate_openapi_v1_geo_brands__brand_id__generate_post" }, "BrandCreateBody": { "properties": { "name": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Name" }, "introduction": { "type": "string", "minLength": 1, "title": "Introduction" }, "product_type": { "type": "string", "title": "Product Type", "default": "other" }, "marketing_goal": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Marketing Goal" }, "homepage_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Homepage Url" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Keywords" }, "selling_points": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Selling Points" }, "core_audience": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Core Audience" } }, "type": "object", "required": ["name", "introduction"], "title": "BrandCreateBody" }, "CompetitorCreateRequest": { "properties": { "brand_id": { "type": "string", "maxLength": 64, "minLength": 1, "title": "Brand Id" }, "name": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Name" }, "aliases": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Aliases" }, "website_url": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ], "title": "Website Url" }, "logo_icon": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ], "title": "Logo Icon" }, "description": { "anyOf": [ { "type": "string", "maxLength": 4000 }, { "type": "null" } ], "title": "Description" } }, "type": "object", "required": ["brand_id", "name"], "title": "CompetitorCreateRequest" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "OrderSubmitRequest": { "properties": { "content_id": { "type": "string", "minLength": 1, "title": "Content Id" }, "media_ids": { "items": { "type": "string" }, "type": "array", "minItems": 1, "title": "Media Ids" }, "requirements": { "anyOf": [ { "type": "integer", "maximum": 4.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Requirements" }, "account_rule": { "anyOf": [ { "type": "integer", "maximum": 3.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Account Rule" }, "article_type": { "anyOf": [ { "type": "integer", "maximum": 3.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Article Type" }, "scheduled_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scheduled At" } }, "type": "object", "required": ["content_id", "media_ids"], "title": "OrderSubmitRequest", "description": "提交发布：一篇内容 × N 家媒体 → N 条待审核工单。\n\n``requirements`` / ``account_rule`` / ``article_type`` / ``scheduled_at`` 是各平台的\n可选下单参数，原样存进 ``grow_media_order.request_extra``，P2 推送时由对应适配器解释\n（语义各平台不同，这里不做归一）。" }, "PromptCreateRequest": { "properties": { "brand_id": { "type": "string", "maxLength": 64, "minLength": 1, "title": "Brand Id" }, "topic_id": { "type": "string", "maxLength": 64, "minLength": 1, "title": "Topic Id" }, "text": { "type": "string", "maxLength": 2000, "minLength": 1, "title": "Text" }, "types": { "items": { "type": "string", "enum": ["visibility", "sentiment"] }, "type": "array", "title": "Types" }, "stage": { "type": "string", "maxLength": 32, "title": "Stage", "default": "awareness" }, "tag_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tag Ids" }, "region": { "anyOf": [ { "type": "string", "maxLength": 16 }, { "type": "null" } ], "title": "Region" }, "language": { "anyOf": [ { "type": "string", "maxLength": 16 }, { "type": "null" } ], "title": "Language" }, "source": { "type": "string", "enum": ["agent", "user"], "title": "Source", "default": "user" }, "status": { "type": "string", "enum": ["active", "suggested", "archived"], "title": "Status", "default": "active" } }, "type": "object", "required": ["brand_id", "topic_id", "text"], "title": "PromptCreateRequest" }, "PromptUpdateRequest": { "properties": { "text": { "anyOf": [ { "type": "string", "maxLength": 2000, "minLength": 1 }, { "type": "null" } ], "title": "Text" }, "topic_id": { "anyOf": [ { "type": "string", "maxLength": 64, "minLength": 1 }, { "type": "null" } ], "title": "Topic Id" }, "types": { "anyOf": [ { "items": { "type": "string", "enum": ["visibility", "sentiment"] }, "type": "array" }, { "type": "null" } ], "title": "Types" }, "stage": { "anyOf": [ { "type": "string", "maxLength": 32 }, { "type": "null" } ], "title": "Stage" }, "tag_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tag Ids" }, "region": { "anyOf": [ { "type": "string", "maxLength": 16 }, { "type": "null" } ], "title": "Region" }, "language": { "anyOf": [ { "type": "string", "maxLength": 16 }, { "type": "null" } ], "title": "Language" }, "status": { "anyOf": [ { "type": "string", "enum": ["active", "suggested", "archived"] }, { "type": "null" } ], "title": "Status" } }, "type": "object", "title": "PromptUpdateRequest" }, "RunCreateBody": { "properties": { "brand_id": { "type": "string", "maxLength": 64, "minLength": 1, "title": "Brand Id" }, "platforms": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Platforms" }, "mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mode" } }, "type": "object", "required": ["brand_id"], "title": "RunCreateBody" }, "TopicCreateRequest": { "properties": { "brand_id": { "type": "string", "maxLength": 64, "minLength": 1, "title": "Brand Id" }, "name": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Name" }, "description": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "title": "Description" }, "region": { "type": "string", "maxLength": 16, "title": "Region", "default": "CN" }, "language": { "type": "string", "maxLength": 16, "title": "Language", "default": "zh" } }, "type": "object", "required": ["brand_id", "name"], "title": "TopicCreateRequest" }, "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": { "ApiKeyHeader": { "type": "apiKey", "in": "header", "name": "X-API-KEY", "description": "控制台「API Key」页创建的 Key（`sk-…`）" }, "BearerToken": { "type": "http", "scheme": "bearer", "description": "同一把 Key，写成 `Authorization: Bearer sk-…`" } } }, "info": { "title": "声量开放 API", "description": "声量开放 API：用程序代替在控制台点按钮。\n\n**同一个账号、同一套配额、同一份数据** —— API 跑出来的检测在控制台四页里看得到，\n和手动点击没有任何区别。\n\n- 鉴权：`X-API-KEY: sk-…` 或 `Authorization: Bearer sk-…`\n- 响应：统一 `{\"code\": 0, \"msg\": \"ok\", \"data\": …}`，`code != 0` 为业务错误\n- 作用域：**仅个人空间**，团队空间的资源通过本 API 看不到\n\n详细接入流程见开发者文档 `docs/openapi/`。\n", "version": "v1" }, "openapi": "3.1.0", "paths": { "/openapi/v1/me": { "get": { "tags": ["OpenAPI · 公开"], "summary": "校验 API Key 并返回其身份与权限", "operationId": "whoami_openapi_v1_me_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-API-KEY", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Whoami Openapi V1 Me Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/openapi/v1/geo/brands": { "get": { "tags": ["OpenAPI · GEO"], "summary": "我的品牌列表", "operationId": "list_brands_openapi_v1_geo_brands_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-API-KEY", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Brands Openapi V1 Geo Brands Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": ["OpenAPI · GEO"], "summary": "创建品牌（含品牌资料）", "operationId": "create_brand_openapi_v1_geo_brands_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-API-KEY", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrandCreateBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Brand Openapi V1 Geo Brands Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/openapi/v1/geo/brands/{brand_id}": { "get": { "tags": ["OpenAPI · GEO"], "summary": "品牌详情", "operationId": "get_brand_openapi_v1_geo_brands__brand_id__get", "parameters": [ { "name": "brand_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Brand Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-API-KEY", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Brand Openapi V1 Geo Brands Brand Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": ["OpenAPI · GEO"], "summary": "更新品牌资料", "operationId": "update_brand_openapi_v1_geo_brands__brand_id__patch", "parameters": [ { "name": "brand_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Brand Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-API-KEY", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Brand Openapi V1 Geo Brands Brand Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/openapi/v1/geo/brands/{brand_id}/topics": { "get": { "tags": ["OpenAPI · GEO"], "summary": "话题列表", "operationId": "list_topics_openapi_v1_geo_brands__brand_id__topics_get", "parameters": [ { "name": "brand_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Brand Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-API-KEY", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Topics Openapi V1 Geo Brands Brand Id Topics Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": ["OpenAPI · GEO"], "summary": "新建话题", "operationId": "create_topic_openapi_v1_geo_brands__brand_id__topics_post", "parameters": [ { "name": "brand_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Brand Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-API-KEY", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TopicCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Topic Openapi V1 Geo Brands Brand Id Topics Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/openapi/v1/geo/brands/{brand_id}/prompts": { "get": { "tags": ["OpenAPI · GEO"], "summary": "意图词列表", "operationId": "list_prompts_openapi_v1_geo_brands__brand_id__prompts_get", "parameters": [ { "name": "brand_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Brand Id" } }, { "name": "topic_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Topic Id" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-API-KEY", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Prompts Openapi V1 Geo Brands Brand Id Prompts Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": ["OpenAPI · GEO"], "summary": "新建意图词", "operationId": "create_prompt_openapi_v1_geo_brands__brand_id__prompts_post", "parameters": [ { "name": "brand_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Brand Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-API-KEY", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromptCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Prompt Openapi V1 Geo Brands Brand Id Prompts Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/openapi/v1/geo/prompts/{prompt_id}": { "patch": { "tags": ["OpenAPI · GEO"], "summary": "更新意图词（含启用 / 停用）", "operationId": "update_prompt_openapi_v1_geo_prompts__prompt_id__patch", "parameters": [ { "name": "prompt_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Prompt Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-API-KEY", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromptUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Prompt Openapi V1 Geo Prompts Prompt Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": ["OpenAPI · GEO"], "summary": "删除意图词", "operationId": "delete_prompt_openapi_v1_geo_prompts__prompt_id__delete", "parameters": [ { "name": "prompt_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Prompt Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-API-KEY", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Prompt Openapi V1 Geo Prompts Prompt Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/openapi/v1/geo/brands/{brand_id}/competitors": { "get": { "tags": ["OpenAPI · GEO"], "summary": "竞品列表", "operationId": "list_competitors_openapi_v1_geo_brands__brand_id__competitors_get", "parameters": [ { "name": "brand_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Brand Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-API-KEY", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Competitors Openapi V1 Geo Brands Brand Id Competitors Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": ["OpenAPI · GEO"], "summary": "新建竞品", "operationId": "create_competitor_openapi_v1_geo_brands__brand_id__competitors_post", "parameters": [ { "name": "brand_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Brand Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-API-KEY", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompetitorCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Competitor Openapi V1 Geo Brands Brand Id Competitors Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/openapi/v1/geo/brands/{brand_id}/generate": { "post": { "tags": ["OpenAPI · GEO"], "summary": "AI 生成话题与意图词（后台异步）", "operationId": "generate_openapi_v1_geo_brands__brand_id__generate_post", "parameters": [ { "name": "brand_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Brand Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-API-KEY", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body_generate_openapi_v1_geo_brands__brand_id__generate_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Generate Openapi V1 Geo Brands Brand Id Generate Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": ["OpenAPI · GEO"], "summary": "查生成状态", "operationId": "generate_status_openapi_v1_geo_brands__brand_id__generate_get", "parameters": [ { "name": "brand_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Brand Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-API-KEY", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Generate Status Openapi V1 Geo Brands Brand Id Generate Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/openapi/v1/geo/runs": { "post": { "tags": ["OpenAPI · GEO"], "summary": "触发一轮检测（异步，立即返回）", "description": "**全部闸门都在 ``start_probe`` 里**，这里一行判断都不加。\n\n它已经做完：重复提交硬拒、日配额 / 最小间隔 / 在途三道闸门、没有启用意图词 /\n没选到平台的硬拒、资源挂起时收进队列不派发、容量不足时排队、预建全部子任务行。\n\n``triggered_by`` 必须留 ``manual``：日配额的判据是写死的\n``triggered_by == \"manual\"``，换成别的值等于**静默绕过配额**。入口区分走 ``source``。", "operationId": "create_run_openapi_v1_geo_runs_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-API-KEY", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunCreateBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Run Openapi V1 Geo Runs Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/openapi/v1/geo/runs/{run_id}": { "get": { "tags": ["OpenAPI · GEO"], "summary": "查一轮检测的状态与进度", "operationId": "get_run_openapi_v1_geo_runs__run_id__get", "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-API-KEY", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Run Openapi V1 Geo Runs Run Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/openapi/v1/geo/brands/{brand_id}/overview": { "get": { "tags": ["OpenAPI · GEO"], "summary": "概览：KPI / 趋势 / 平台 / 竞品 / 预警", "operationId": "overview_openapi_v1_geo_brands__brand_id__overview_get", "parameters": [ { "name": "brand_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Brand Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-API-KEY", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Overview Openapi V1 Geo Brands Brand Id Overview Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/openapi/v1/geo/brands/{brand_id}/visibility": { "get": { "tags": ["OpenAPI · GEO"], "summary": "品牌可见性：逐意图词 × 平台", "operationId": "visibility_openapi_v1_geo_brands__brand_id__visibility_get", "parameters": [ { "name": "brand_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Brand Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-API-KEY", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Visibility Openapi V1 Geo Brands Brand Id Visibility Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/openapi/v1/geo/brands/{brand_id}/sentiment": { "get": { "tags": ["OpenAPI · GEO"], "summary": "口碑分析", "operationId": "sentiment_openapi_v1_geo_brands__brand_id__sentiment_get", "parameters": [ { "name": "brand_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Brand Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-API-KEY", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Sentiment Openapi V1 Geo Brands Brand Id Sentiment Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/openapi/v1/geo/brands/{brand_id}/citations": { "get": { "tags": ["OpenAPI · GEO"], "summary": "引用来源分析", "operationId": "citations_openapi_v1_geo_brands__brand_id__citations_get", "parameters": [ { "name": "brand_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Brand Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-API-KEY", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Citations Openapi V1 Geo Brands Brand Id Citations Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/openapi/v1/media/channels": { "get": { "tags": ["OpenAPI · 媒体"], "summary": "媒体类型计数 + 筛选字典（含档位定义）", "operationId": "channels_openapi_v1_media_channels_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-API-KEY", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Channels Openapi V1 Media Channels Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/openapi/v1/media": { "get": { "tags": ["OpenAPI · 媒体"], "summary": "媒体列表（分页 + 多维筛选 + 排序）", "operationId": "list_media_openapi_v1_media_get", "parameters": [ { "name": "media_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "news/wemedia/short_video/overseas", "title": "Media Type" }, "description": "news/wemedia/short_video/overseas" }, { "name": "content_type", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": ["article", "video"], "type": "string" }, { "type": "null" } ], "title": "Content Type" } }, { "name": "keyword", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Keyword" } }, { "name": "price_min_yuan", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ], "title": "Price Min Yuan" } }, { "name": "price_max_yuan", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ], "title": "Price Max Yuan" } }, { "name": "weight_min", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 10, "minimum": 0 }, { "type": "null" } ], "title": "Weight Min" } }, { "name": "speed_max_hours", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ], "title": "Speed Max Hours" } }, { "name": "success_rate_min", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 100, "minimum": 0 }, { "type": "null" } ], "title": "Success Rate Min" } }, { "name": "include_rate_min", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 100, "minimum": 0 }, { "type": "null" } ], "title": "Include Rate Min" } }, { "name": "fans_min", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Fans Min" } }, { "name": "areas", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "title": "Areas" } }, { "name": "industries", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "title": "Industries" } }, { "name": "platforms", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "description": "综合门户 / 隶属平台", "title": "Platforms" }, "description": "综合门户 / 隶属平台" }, { "name": "languages", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "description": "海外媒体语言", "title": "Languages" }, "description": "海外媒体语言" }, { "name": "area", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Area" } }, { "name": "industry", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Industry" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "recommended", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Recommended" } }, { "name": "favorited_only", "in": "query", "required": false, "schema": { "type": "boolean", "description": "只看我收藏的媒体", "default": false, "title": "Favorited Only" }, "description": "只看我收藏的媒体" }, { "name": "published_only", "in": "query", "required": false, "schema": { "type": "boolean", "description": "只看我成功发布过的媒体", "default": false, "title": "Published Only" }, "description": "只看我成功发布过的媒体" }, { "name": "blocked_only", "in": "query", "required": false, "schema": { "type": "boolean", "description": "只看小黑屋里的媒体", "default": false, "title": "Blocked Only" }, "description": "只看小黑屋里的媒体" }, { "name": "flags", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "title": "Flags" } }, { "name": "geo_platforms", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "title": "Geo Platforms" } }, { "name": "entrance_level", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entrance Level" } }, { "name": "rating_tags", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "description": "fast/quality/value", "title": "Rating Tags" }, "description": "fast/quality/value" }, { "name": "tags", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "description": "运营自定义标签", "title": "Tags" }, "description": "运营自定义标签" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Page Size" } }, { "name": "sort", "in": "query", "required": false, "schema": { "enum": [ "default", "price_asc", "price_desc", "weight_asc", "weight_desc", "m_weight_asc", "m_weight_desc", "speed_asc", "speed_desc", "include_rate_asc", "include_rate_desc", "fans_asc", "fans_desc" ], "type": "string", "default": "default", "title": "Sort" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-API-KEY", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Media Openapi V1 Media Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/openapi/v1/media/publish-quota": { "get": { "tags": ["OpenAPI · 媒体"], "summary": "本月发布点数（配额 / 已用 / 剩余）", "operationId": "publish_quota_openapi_v1_media_publish_quota_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-API-KEY", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Publish Quota Openapi V1 Media Publish Quota Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/openapi/v1/media/points-records": { "get": { "tags": ["OpenAPI · 媒体"], "summary": "发布点数消耗明细", "operationId": "points_records_openapi_v1_media_points_records_get", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Page Size" } }, { "name": "current_month_only", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Current Month Only" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-API-KEY", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Points Records Openapi V1 Media Points Records Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/openapi/v1/media/orders": { "post": { "tags": ["OpenAPI · 媒体"], "summary": "提交发稿（落待审核队列，不调平台 API）", "description": "点数扣减、媒体可用性、内容归属全部由 ``submit_orders`` 负责，这里一行判断都不加。", "operationId": "submit_orders_openapi_v1_media_orders_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-API-KEY", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderSubmitRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Submit Orders Openapi V1 Media Orders Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": ["OpenAPI · 媒体"], "summary": "我的发稿记录", "operationId": "list_orders_openapi_v1_media_orders_get", "parameters": [ { "name": "content_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content Id" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Page Size" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-API-KEY", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Orders Openapi V1 Media Orders Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/openapi/v1/media/orders/{order_id}": { "delete": { "tags": ["OpenAPI · 媒体"], "summary": "撤回工单（仅待审核可撤，释放点数）", "operationId": "cancel_order_openapi_v1_media_orders__order_id__delete", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Order Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-API-KEY", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Cancel Order Openapi V1 Media Orders Order Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/openapi/v1/media/{media_id}": { "get": { "tags": ["OpenAPI · 媒体"], "summary": "媒体详情", "operationId": "get_media_openapi_v1_media__media_id__get", "parameters": [ { "name": "media_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Media Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "X-API-KEY", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Media Openapi V1 Media Media Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "security": [ { "ApiKeyHeader": [] }, { "BearerToken": [] } ], "servers": [ { "url": "https://shengliang.cn" } ] }