{"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-farui/create-text-file":{"post":{"operationId":"cloud_aliyun_farui_create_text_file","summary":"Uploads a document to the contract review module. After the document is added, the system automatically…","description":"POST /{WorkspaceId}/data/textFile","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["WorkspaceId"],"properties":{"endpoint":{"type":"string","enum":["https://farui.cn-beijing.aliyuncs.com"],"default":"https://farui.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://farui.cn-beijing.aliyuncs.com"},"WorkspaceId":{"type":"string","description":"The ID of the workspace in Alibaba Cloud Model Studio"},"ClientToken":{"type":"string","description":"The client token that is used to ensure the idempotence of the request. You can generate a parameter value on your client to ensure that…"},"CreateTime":{"type":"string","description":"The creation time. The value is a UNIX timestamp in seconds"},"TextFileName":{"type":"string","description":"The name of the uploaded file, including the file name extension"},"TextFileUrl":{"type":"string","description":"The download URL of the uploaded file. To upload a file directly, use the CreateFileAdvanceRequest operation in the SDK"},"ContractId":{"type":"string","description":"The contract ID, which is used in contract comparison scenarios. The ContractId is returned when you upload a file for the first time. If…"}}}}}},"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-farui/run-contract-extract":{"post":{"operationId":"cloud_aliyun_farui_run_contract_extract","summary":"This API extracts specified fields from contract content. You provide a contract URL and a list of fields to…","description":"POST /{workspaceId}/pop/contract/extraction","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","fileOssUrl"],"properties":{"endpoint":{"type":"string","enum":["https://farui.cn-beijing.aliyuncs.com"],"default":"https://farui.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://farui.cn-beijing.aliyuncs.com"},"workspaceId":{"type":"string","description":"Workspace ID in Alibaba Cloud Model Studio"},"appId":{"type":"string","description":"Application ID"},"regionId":{"type":"string","description":"Region ID"},"fileOssUrl":{"type":"string","description":"Publicly accessible OSS URL of the file"},"fieldsToExtract":{"type":"string","description":"Fields to extract (JSON-encoded)"}}}}}},"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-farui/run-contract-result-generation":{"post":{"operationId":"cloud_aliyun_farui_run_contract_result_generation","summary":"Generates contract review results for the contract review module by calling a large language model to return…","description":"POST /{workspaceId}/farui/contract/result/genarate","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId"],"properties":{"endpoint":{"type":"string","enum":["https://farui.cn-beijing.aliyuncs.com"],"default":"https://farui.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://farui.cn-beijing.aliyuncs.com"},"appId":{"type":"string","description":"The application ID"},"stream":{"type":"string","description":"Specifies whether to use streaming output"},"workspaceId":{"type":"string","description":"The workspace ID of Alibaba Cloud Model Studio"},"assistant":{"type":"string","description":"The agent (JSON-encoded)"}}}}}},"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-farui/run-contract-rule-generation":{"post":{"operationId":"cloud_aliyun_farui_run_contract_rule_generation","summary":"This operation uses a Large Language Model (LLM) to generate intelligent contract review rules. It returns…","description":"POST /{workspaceId}/farui/contract/rule/genarate","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId"],"properties":{"endpoint":{"type":"string","enum":["https://farui.cn-beijing.aliyuncs.com"],"default":"https://farui.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://farui.cn-beijing.aliyuncs.com"},"appId":{"type":"string","description":"Application ID"},"stream":{"type":"string","description":"Set to true to enable streaming output"},"workspaceId":{"type":"string","description":"Workspace ID on Alibaba Cloud Model Studio"},"assistant":{"type":"string","description":"Agent (JSON-encoded)"}}}}}},"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-farui/run-legal-advice-consultation":{"post":{"operationId":"cloud_aliyun_farui_run_legal_advice_consultation","summary":"Provides legal consultation services","description":"POST /{workspaceId}/farui/legalAdvice/consult","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId"],"properties":{"endpoint":{"type":"string","enum":["https://farui.cn-beijing.aliyuncs.com"],"default":"https://farui.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://farui.cn-beijing.aliyuncs.com"},"appId":{"type":"string","description":"The application ID"},"stream":{"type":"string","description":"Specifies whether the request is a streaming request"},"workspaceId":{"type":"string","description":"The ID of the workspace in Alibaba Cloud Model Studio"},"assistant":{"type":"string","description":"The agent (JSON-encoded)"},"thread":{"type":"string","description":"The thread (JSON-encoded)"},"extra":{"type":"string","description":"Settings related to deep thinking. If this parameter is not specified, the response format of the previous version is used (JSON-encoded)"}}}}}},"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-farui/run-search-case-full-text":{"post":{"operationId":"cloud_aliyun_farui_run_search_case_full_text","summary":"Retrieves relevant cases for a user-described question. After a user inputs a question, this operation calls…","description":"POST /{workspaceId}/farui/search/case/fulltext","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","query","pageParam"],"properties":{"endpoint":{"type":"string","enum":["https://farui.cn-beijing.aliyuncs.com"],"default":"https://farui.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://farui.cn-beijing.aliyuncs.com"},"workspaceId":{"type":"string","description":"The ID of the workspace in Model Studio"},"appId":{"type":"string","description":"The ID of the application"},"thread":{"type":"string","description":"The thread (JSON-encoded)"},"query":{"type":"string","description":"The question to query"},"queryKeywords":{"type":"string","description":"The array of search keywords (JSON-encoded)"},"pageParam":{"type":"string","description":"The pagination parameters (JSON-encoded)"},"sortKeyAndDirection":{"type":"string","description":"The sort mapping (JSON-encoded)"},"filterCondition":{"type":"string","description":"The filter conditions (JSON-encoded)"},"referLevel":{"type":"string","description":"The case type. Valid values: Other, Reference, and Guiding. Default value: Other"}}}}}},"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-farui/run-search-law-query":{"post":{"operationId":"cloud_aliyun_farui_run_search_law_query","summary":"This API is used to retrieve relevant regulations corresponding to a user-described question. After the user…","description":"POST /{workspaceId}/farui/search/law/query","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","query"],"properties":{"endpoint":{"type":"string","enum":["https://farui.cn-beijing.aliyuncs.com"],"default":"https://farui.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://farui.cn-beijing.aliyuncs.com"},"workspaceId":{"type":"string","description":"Alibaba Cloud Bailian Platform workspace ID"},"appId":{"type":"string","description":"Application ID"},"thread":{"type":"string","description":"Thread (JSON-encoded)"},"query":{"type":"string","description":"Query question"},"queryKeywords":{"type":"string","description":"Keyword array (JSON-encoded)"},"pageParam":{"type":"string","description":"Pagination parameters (JSON-encoded)"},"filterCondition":{"type":"string","description":"Filter conditions (JSON-encoded)"}}}}}},"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-farui/version":{"post":{"operationId":"cloud_aliyun_farui_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://farui.cn-beijing.aliyuncs.com"],"default":"https://farui.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://farui.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"}}}}}}}