{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-dtsai/authorize-file-upload":{"post":{"operationId":"cloud_aliyun_dtsai_authorize_file_upload","summary":"Grants OSS PostObject direct upload authorization for callers to upload files directly to the specified…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId"],"properties":{"endpoint":{"type":"string","enum":["https://dtsai.cn-beijing.aliyuncs.com"],"default":"https://dtsai.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dtsai.cn-beijing.aliyuncs.com"},"RegionId":{"type":"string","description":"The region ID, such as cn-beijing"},"AgentName":{"type":"string","description":"The source of the agent or client that initiates the call, such as codex, cursor, or openapi. The maximum length is 32 characters. This…"},"FileFormat":{"type":"string","description":"The format of the file to be uploaded"},"BatchSize":{"type":"string","description":"The number of OSS PostObject direct upload authorizations returned in this request"}}}}}},"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-dtsai/create-doc-parser-job":{"post":{"operationId":"cloud_aliyun_dtsai_create_doc_parser_job","summary":"Creates a document parsing task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","FileName","FileFormat","OutputFormat"],"properties":{"endpoint":{"type":"string","enum":["https://dtsai.cn-beijing.aliyuncs.com"],"default":"https://dtsai.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dtsai.cn-beijing.aliyuncs.com"},"RegionId":{"type":"string","description":"The region ID"},"FileUrl":{"type":"string","description":"The HTTP or HTTPS URL of the file to be parsed. The SDKs for various programming languages additionally provide a…"},"FileName":{"type":"string","description":"The file name, which must include the file name extension"},"FileFormat":{"type":"string","description":"The format of the input file. Valid values: pdf: PDF file. docx: Word file in .docx format. doc: Word file in .doc format. pptx: PPT file…"},"OutputFormat":{"type":"string","description":"The output format of the parsing result. Valid values: markdown: Markdown format"},"OssFileUrl":{"type":"string","description":"The OSS file URL"},"ImageMode":{"type":"string","description":"The image carrier mode. Valid values: ignore, base64, placeholder, and oss (default, returns image links in the body)"},"ImageUnderstanding":{"type":"string","description":"Specifies whether to generate image understanding text. Valid values: full (default) and none"},"TableFormat":{"type":"string","description":"The table format. Valid values: html and markdown (default)"},"ResultType":{"type":"string","description":"The result return method. Valid values: content (default, Markdown body) and url (temporary OSS download URL)"},"AgentName":{"type":"string","description":"The agent name"},"ResponseMode":{"type":"string","description":"The response mode. Valid values: async (default, returns only JobId for the caller to poll) and sync (returns the parsing result…"},"MediaChunkStrategy":{"type":"string","description":"The chunking strategy. This parameter takes effect only for videos. Valid values: scene (default, chunks by scene) and interval (chunks at…"},"MediaChunkIntervalSeconds":{"type":"integer","description":"The media chunk interval in seconds. This parameter takes effect only for videos. Specifies the duration in seconds for each segment under…"},"MediaMinFrameBudget":{"type":"integer","description":"The minimum media frame budget. This parameter takes effect only for videos. Specifies the lower limit of the frame budget. Valid values:…"},"MediaFramesPerMinute":{"type":"number","description":"The number of frames extracted per minute. This parameter takes effect only for videos. Valid values: 0 to 30. A value of 0 disables the…"},"MediaMaxFrameBudget":{"type":"integer","description":"The maximum media frame budget. This parameter takes effect only for videos. Specifies the upper limit of the frame budget. Valid values:…"},"AudioWindowSeconds":{"type":"integer","description":"The chunk window length in seconds. This parameter takes effect only for audio-only files. Valid values: 10 to 600. Passing this parameter…"},"AsrLanguage":{"type":"string","description":"The Automatic Speech Recognition (ASR) language hint. Valid values: auto (default), zh, and en. When set to auto, the language field in…"},"FrameOutput":{"type":"string","description":"Specifies whether to output key frame images to OSS. This parameter takes effect only for videos. Default value: true. The media…"},"AudioClipOutput":{"type":"string","description":"Specifies whether to output segmented audio clips to OSS. Default value: true"},"ChunkSummary":{"type":"string","description":"Specifies whether to generate a one-sentence summary for each segment. Default value: true"},"GlobalSummary":{"type":"string","description":"Specifies whether to generate an overall summary. Default value: true"},"ParseScene":{"type":"string","description":"The parsing scene. This parameter takes effect only for document and image parsing. Valid values: general (default) and formula_ocr…"}}}}}},"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-dtsai/describe-doc-parser-job-result":{"post":{"operationId":"cloud_aliyun_dtsai_describe_doc_parser_job_result","summary":"Retrieves the result of a document parsing task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","JobId"],"properties":{"endpoint":{"type":"string","enum":["https://dtsai.cn-beijing.aliyuncs.com"],"default":"https://dtsai.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dtsai.cn-beijing.aliyuncs.com"},"RegionId":{"type":"string","description":"The region ID"},"JobId":{"type":"string","description":"The document parsing task ID. You can obtain this ID by calling CreateDocParserJob"},"AgentName":{"type":"string","description":"The agent name"},"ResultType":{"type":"string","description":"The result type"}}}}}},"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-dtsai/describe-doc-parser-job-status":{"post":{"operationId":"cloud_aliyun_dtsai_describe_doc_parser_job_status","summary":"Queries the status of a document parsing task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","JobId"],"properties":{"endpoint":{"type":"string","enum":["https://dtsai.cn-beijing.aliyuncs.com"],"default":"https://dtsai.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dtsai.cn-beijing.aliyuncs.com"},"RegionId":{"type":"string","description":"The region ID"},"JobId":{"type":"string","description":"The ID of the document parsing task. You can obtain the ID by calling CreateDocParserJob"},"AgentName":{"type":"string","description":"The agent name"}}}}}},"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-dtsai/web-fetch":{"post":{"operationId":"cloud_aliyun_dtsai_web_fetch","summary":"Retrieves web page content","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","Url"],"properties":{"endpoint":{"type":"string","enum":["https://dtsai.cn-beijing.aliyuncs.com"],"default":"https://dtsai.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dtsai.cn-beijing.aliyuncs.com"},"RegionId":{"type":"string","description":"The region ID"},"Url":{"type":"string","description":"The URL of the target web page to fetch"},"OutputFormat":{"type":"string","description":"The output format. Valid values: markdown: Markdown format. html: HTML format. text: plain text format"},"AgentName":{"type":"string","description":"The agent name"}}}}}},"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-dtsai/web-search":{"post":{"operationId":"cloud_aliyun_dtsai_web_search","summary":"Performs a web search","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","Query"],"properties":{"endpoint":{"type":"string","enum":["https://dtsai.cn-beijing.aliyuncs.com"],"default":"https://dtsai.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dtsai.cn-beijing.aliyuncs.com"},"RegionId":{"type":"string","description":"The region ID"},"Query":{"type":"string","description":"The search query string"},"MaxResults":{"type":"integer","description":"The maximum number of results to return. Default value: 10. Valid values: 1 to 50"},"UrlScopeMode":{"type":"string","description":"The domain scope mode. Valid values: allowOnly and deny. This parameter must be specified together with UrlScopeDomains, or both must be…"},"UrlScopeDomains":{"type":"string","description":"A comma-separated list of domain names. The total length cannot exceed 20,480 characters, and the list can contain up to 100 entries.…"},"AgentName":{"type":"string","description":"The agent name"}}}}}},"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-dtsai/version":{"post":{"operationId":"cloud_aliyun_dtsai_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dtsai.cn-beijing.aliyuncs.com"],"default":"https://dtsai.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://dtsai.cn-beijing.aliyuncs.com"}}}}}},"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"}}}}}}}