{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-iqs/ai-search":{"get":{"operationId":"cloud_aliyun_iqs_ai_search","summary":"Describes how to invoke the multi-stage streaming API V3 for general search by using the Alibaba Cloud…","description":"GET /linked-retrieval/linked-retrieval-entry/v3/linkedRetrieval/commands/aiSearch","tags":["cloud"],"parameters":[{"name":"query","in":"query","required":true,"description":"The search query","schema":{"type":"string","description":"The search query"},"example":"苹果手机"},{"name":"sessionId","in":"query","required":false,"description":"The query range for the web page publish time","schema":{"type":"string","description":"The query range for the web page publish time"},"example":"17dc8bcd-f34a-46d1-a7a3-0fa3d1ce3824"},{"name":"timeRange","in":"query","required":false,"description":"The session ID for multi-turn interaction","schema":{"type":"string","description":"The session ID for multi-turn interaction"},"example":"OneWeek"},{"name":"industry","in":"query","required":false,"description":"The industry. If specified, only site content restricted to the specified industry is recalled. Separate multiple industries with commas","schema":{"type":"string","description":"The industry. If specified, only site content restricted to the specified industry is recalled. Separate multiple industries with commas"},"example":"finance"},{"name":"page","in":"query","required":false,"description":"The page number. Starts from 1","schema":{"type":"integer","description":"The page number. Starts from 1"},"example":"1"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-iqs/common-query-by-scene":{"post":{"operationId":"cloud_aliyun_iqs_common_query_by_scene","summary":"Performs a natural language general-purpose query","description":"POST /amap-function-call-agent/iqs-agent-service/v2/nl/common","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"limit":{"type":"integer","description":"The maximum number of place results to return. Default value: 10"},"query":{"type":"string","description":"The natural language question used to retrieve nearby places"},"querySceneEnumCode":{"type":"string","description":"The search scenario code. Valid values: hotels (hotel), attractions (attraction), restaurants (restaurant), and entertainment (leisure and…"},"searchModel":{"type":"string","description":"The search result mode. Valid values: single (returns simplified fields) and normal (returns all fields). Default value: normal"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-iqs/generic-advanced-search":{"get":{"operationId":"cloud_aliyun_iqs_generic_advanced_search","summary":"This topic describes how to invoke the GenericAdvancedSearch operation by using Alibaba Cloud OpenAPI SDKs…","description":"GET /linked-retrieval/linked-retrieval-entry/v2/linkedRetrieval/commands/genericAdvancedSearch","tags":["cloud"],"parameters":[{"name":"query","in":"query","required":true,"description":"The search query","schema":{"type":"string","description":"The search query"},"example":"苹果手机"},{"name":"timeRange","in":"query","required":false,"description":"The relative query range for the webpage publication time. Valid values: OneDay, OneWeek, OneMonth, OneYear, and NoLimit. A value of…","schema":{"type":"string","description":"The relative query range for the webpage publication time. Valid values: OneDay, OneWeek, OneMonth, OneYear, and NoLimit. A value of…"},"example":"OneWeek"},{"name":"sessionId","in":"query","required":false,"description":"The session ID for multi-turn interactions","schema":{"type":"string","description":"The session ID for multi-turn interactions"},"example":"job-4065bee3-e7aa-49fc-aad2-a8e3a7fd6acd"},{"name":"industry","in":"query","required":false,"description":"The industry. If you specify this parameter, only content from websites within the specified industry is recalled. Separate multiple…","schema":{"type":"string","description":"The industry. If you specify this parameter, only content from websites within the specified industry is recalled. Separate multiple…"},"example":"medical"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-iqs/generic-search":{"get":{"operationId":"cloud_aliyun_iqs_generic_search","summary":"Performs a general search","description":"GET /linked-retrieval/linked-retrieval-entry/v2/linkedRetrieval/commands/genericSearch","tags":["cloud"],"parameters":[{"name":"query","in":"query","required":true,"description":"The search keywords","schema":{"type":"string","description":"The search keywords"},"example":"苹果手机"},{"name":"timeRange","in":"query","required":false,"description":"The time range","schema":{"type":"string","description":"The time range"},"example":"OneWeek"},{"name":"sessionId","in":"query","required":false,"description":"The session ID for multi-turn interaction","schema":{"type":"string","description":"The session ID for multi-turn interaction"},"example":"282j3h3434j23hdw9sd72j3"},{"name":"industry","in":"query","required":false,"description":"The industry. If specified, only site content restricted to the specified industry is recalled. Separate multiple industries with commas","schema":{"type":"string","description":"The industry. If specified, only site content restricted to the specified industry is recalled. Separate multiple industries with commas"},"example":"finance,law"},{"name":"page","in":"query","required":false,"description":"The page number. The value starts from 1","schema":{"type":"integer","description":"The page number. The value starts from 1"},"example":"1"},{"name":"returnMainText","in":"query","required":false,"description":"Specifies whether to return the main text of the web page. Default value: true","schema":{"type":"string","description":"Specifies whether to return the main text of the web page. Default value: true"}},{"name":"returnMarkdownText","in":"query","required":false,"description":"Specifies whether to return the web page content in Markdown format. Default value: true","schema":{"type":"string","description":"Specifies whether to return the web page content in Markdown format. Default value: true"}},{"name":"returnSummary","in":"query","required":false,"description":"Specifies whether to return the enhanced summary. Default value: true","schema":{"type":"string","description":"Specifies whether to return the enhanced summary. Default value: true"}},{"name":"enableRerank","in":"query","required":false,"description":"Specifies whether to rerank the retrieval results. Default value: true","schema":{"type":"string","description":"Specifies whether to rerank the retrieval results. Default value: true"}},{"name":"returnRichMainBody","in":"query","required":false,"description":"Specifies whether to return the full rich text body. Default value: false","schema":{"type":"string","description":"Specifies whether to return the full rich text body. Default value: false"}},{"name":"advancedParams","in":"query","required":false,"description":"The advanced search parameters. You can filter by the start and end dates of the web page publication time. The date format is YYYY-MM-DD.…","schema":{"type":"string","description":"The advanced search parameters. You can filter by the start and end dates of the web page publication time. The date format is YYYY-MM-DD.…"},"example":"{\"startPublishedDate\":\"2025-07-01\",\"endPublishedDate\":\"2025-07-31\"}"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-iqs/get-iqs-usage":{"get":{"operationId":"cloud_aliyun_iqs_get_iqs_usage","summary":"Queries the daily usage of the information query service API","description":"GET /linked-retrieval/linked-retrieval-admin/v1/iqs/usage","tags":["cloud"],"parameters":[{"name":"startDate","in":"query","required":false,"description":"The start date for the usage query, inclusive. The format is YYYYMMDD. The date must be within the last 60 days","schema":{"type":"string","description":"The start date for the usage query, inclusive. The format is YYYYMMDD. The date must be within the last 60 days"},"example":"20241011"},{"name":"endDate","in":"query","required":false,"description":"The end date for the usage query, inclusive. The format is YYYYMMDD. The date must be within the last 60 days","schema":{"type":"string","description":"The end date for the usage query, inclusive. The format is YYYYMMDD. The date must be within the last 60 days"},"example":"20241017"},{"name":"callerId","in":"query","required":false,"description":"The ID of the RAM user or the API key caller identifier to query","schema":{"type":"string","description":"The ID of the RAM user or the API key caller identifier to query"},"example":"138608930460****"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-iqs/global-search":{"get":{"operationId":"cloud_aliyun_iqs_global_search","summary":"Searches for global information by using the Global Edition search","description":"GET /linked-retrieval/linked-retrieval-entry/v1/iqs/search/global","tags":["cloud"],"parameters":[{"name":"query","in":"query","required":true,"description":"The search query","schema":{"type":"string","description":"The search query"},"example":"特朗普最新关税消息"},{"name":"timeRange","in":"query","required":false,"description":"The relative time range of the webpage publication time. Specify a value based on the relative time options","schema":{"type":"string","description":"The relative time range of the webpage publication time. Specify a value based on the relative time options"},"example":"OneWeek"},{"name":"page","in":"query","required":false,"description":"The page number. The value starts from 1","schema":{"type":"integer","description":"The page number. The value starts from 1"},"example":"1"},{"name":"pageSize","in":"query","required":false,"description":"The number of entries per page","schema":{"type":"integer","description":"The number of entries per page"},"example":"10"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-iqs/medical-answer":{"post":{"operationId":"cloud_aliyun_iqs_medical_answer","summary":"Queries medical question answering results","description":"POST /linked-retrieval/linked-retrieval-entry/v1/iqs/domain/medical/answer","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","description":"The medical question to be answered"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-iqs/medical-knowledge":{"post":{"operationId":"cloud_aliyun_iqs_medical_knowledge","summary":"Queries the knowledge graph of health information","description":"POST /linked-retrieval/linked-retrieval-entry/v1/iqs/domain/medical/know","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"query":{"type":"string","description":"The medical, drug, disease, or food entity whose properties are to be queried"},"type":{"type":"string","description":"The entity query type. Valid values: finding: disease food: food medicine: medicine If this parameter is not specified, the type is…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-iqs/multimodal-search":{"post":{"operationId":"cloud_aliyun_iqs_multimodal_search","summary":"Performs a multimodal search","description":"POST /linked-retrieval/linked-retrieval-entry/v1/iqs/multimodal/unified","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"advancedParams":{"type":"object","description":"The additional query items, such as blocked sites"},"engineType":{"type":"string","description":"The search engine type"},"query":{"type":"string","description":"The query content"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-iqs/omni-answer":{"post":{"operationId":"cloud_aliyun_iqs_omni_answer","summary":"This topic describes the SearchStream API operation for AI chat with streaming output. Based on retrieval…","description":"POST /linked-retrieval/linked-retrieval-entry/v1/iqs/answer/omni/search","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["query"],"properties":{"query":{"type":"string","description":"The request parameter"},"sessionId":{"type":"string","description":"The session ID"},"useCot":{"type":"string","description":"Specifies whether to use CoT"},"useModel":{"type":"string","description":"The useModel"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-iqs/read-page-basic":{"post":{"operationId":"cloud_aliyun_iqs_read_page_basic","summary":"Quickly fetches HTML and parses static web page content","description":"POST /linked-retrieval/linked-retrieval-entry/v1/iqs/readpage/basic","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"formats":{"type":"array","description":"The format of the parsing result. rawHtml: the HTML of the target website. html: the page content processed based on readabilityMode.…"},"location":{"type":"string","description":"You do not need to specify this parameter"},"maxAge":{"type":"integer","description":"The maximum cache validity period. Unit: seconds. Default value: 1296000. If the cache duration is less than the value of maxAge, cached…"},"pageTimeout":{"type":"integer","description":"The URL read timeout period. The value of pageTimeout must be less than the value of timeout. Default value: 10000"},"readability":{"type":"object","description":"The readability configuration for the parsing result"},"timeout":{"type":"integer","description":"The end-to-end processing timeout period. Unit: ms. Valid values: [0, 180000]. Default value: 60000"},"url":{"type":"string","description":"The target URL to parse. The value must start with http:// or https://"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-iqs/read-page-scrape":{"post":{"operationId":"cloud_aliyun_iqs_read_page_scrape","summary":"Reads HTML and parses web page content through a browser sandbox environment. The operation begins parsing…","description":"POST /linked-retrieval/linked-retrieval-entry/v1/iqs/readpage/scrape","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"formats":{"type":"array","description":"The format of the parsing result. rawHtml: the HTML of the target site. html: the page content processed based on readabilityMode.…"},"location":{"type":"string","description":"This parameter does not need to be specified"},"maxAge":{"type":"integer","description":"The maximum cache validity period. Unit: seconds. Default value: 1296000. If the cache duration is less than the value of maxAge, cached…"},"pageTimeout":{"type":"integer","description":"The timeout period for waiting for the target site resources to fully load. The value of pageTimeout must be less than the value of…"},"readability":{"type":"object","description":"The readability configuration for the parsing result"},"timeout":{"type":"integer","description":"The end-to-end processing timeout period. Unit: ms. Valid values: [0, 180000]. Default value: 60000"},"url":{"type":"string","description":"The target URL to parse. The URL must start with http:// or https://"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-iqs/scan-file":{"post":{"operationId":"cloud_aliyun_iqs_scan_file","summary":"Scans document images (such as exam papers, books, official documents, certificates, and line drawings) and…","description":"POST /linked-retrieval/linked-retrieval-entry/v1/iqs/domain/scan/file","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"imageBase64":{"type":"string","description":"The Base64 encoding of the image"},"imageUrl":{"type":"string","description":"The URL of the image"},"scanFileInputConfig":{"type":"object","description":"The scan parameters"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-iqs/unified-search":{"post":{"operationId":"cloud_aliyun_iqs_unified_search","summary":"Provides access to the Tongxiao unified search API, enabling quick and easy integration of web-wide general…","description":"POST /linked-retrieval/linked-retrieval-entry/v1/iqs/search/unified","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"advancedParams":{"type":"object","description":"The advanced search parameters"},"category":{"type":"string","description":"The query category. If specified, only search results from sites of the corresponding category are returned. Separate multiple categories…"},"contents":{"type":"object","description":"The options for controlling the returned content"},"engineType":{"type":"string","description":"The engine type. Default value: Generic. Valid values: Generic and GenericAdvanced. GenericAdvanced is billed separately and returns more…"},"location":{"type":"string","description":"[Deprecated] The location information parameter. Use locationInfo to specify a city or IP address"},"locationInfo":{"type":"object","description":"The location information, used for scenario-based searches such as weather"},"query":{"type":"string","description":"The query content. Length limit: 1 to 100"},"timeRange":{"type":"string","description":"The content publication time range"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-iqs/version":{"post":{"operationId":"cloud_aliyun_iqs_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}