{"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-maasqiservice/aigc-chat-completion-stream":{"post":{"operationId":"cloud_aliyun_maasqiservice_aigc_chat_completion_stream","summary":"Calls a published Creative Agent with support for Lite and Dedicated editions, and returns execution…","description":"POST /aigc/v1/chat/completions","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-QI-Agent-Api-Key","X-QI-Instance-Id","messages","stream"],"properties":{"endpoint":{"type":"string","enum":["https://maasqiservice.cn-beijing.aliyuncs.com"],"default":"https://maasqiservice.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://maasqiservice.cn-beijing.aliyuncs.com"},"X-QI-Agent-Api-Key":{"type":"string","description":"The instance access key. The key must belong to the Creative Agent instance being called. This key is different from the AccessKey Secret…"},"X-QI-Instance-Id":{"type":"string","description":"The published Creative Agent instance ID. Must correspond to the X-QI-Agent-Api-Key"},"X-QI-Session-Id":{"type":"string","description":"The session identifier. Can be omitted for the first turn. Obtain it from the qi_session_id field in the SSE response and pass it back in…"},"messages":{"type":"array","description":"The conversation message array. Creative Agent uses the last user message as the current objective and executes it in combination with the…"},"metadata":{"type":"object","description":"The extended input for this image creation request. Use the parameters object to set generation parameters. Do not use this field to pass…"},"model":{"type":"string","description":"A compatibility placeholder field. Can be omitted or set to an empty string. You cannot use this field to switch the model used by the…"},"stream":{"type":"string","description":"Specifies whether to use SSE streaming responses. This parameter must be set to true for this operation"},"streamOptions":{"type":"object","description":"The HTTP JSON key is stream_options. Set include_usage to retrieve the token usage for this call"}}}}}},"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-maasqiservice/gui-chat-completion-stream":{"post":{"operationId":"cloud_aliyun_maasqiservice_gui_chat_completion_stream","summary":"Calls a published Mobile-Use Agent instance, which supports the Standard Edition and Dedicated Edition.…","description":"POST /gui/v1/chat/completions","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-QI-Agent-Api-Key","X-QI-Instance-Id","messages","stream"],"properties":{"endpoint":{"type":"string","enum":["https://maasqiservice.cn-beijing.aliyuncs.com"],"default":"https://maasqiservice.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://maasqiservice.cn-beijing.aliyuncs.com"},"X-QI-Agent-Api-Key":{"type":"string","description":"The access key of the agent instance, which is used to authenticate QICloud Customer API operations"},"X-QI-Instance-Id":{"type":"string","description":"The ID of the published Mobile-Use Agent instance. This ID must correspond to the X-QI-Agent-Api-Key"},"X-QI-Session-Id":{"type":"string","description":"The optional session identifier. You can omit this parameter in the first step, and it is generated by the server. You must pass back the…"},"allowedTokenIds":{"type":"array","description":"The whitelist of token IDs that are allowed to be generated"},"badWords":{"type":"array","description":"The list of words or strings that are banned from being generated"},"chatTemplateKwargs":{"type":"object","description":"The vLLM or OpenAI-compatible template parameter object. The request values override the default values with the same names in the model…"},"frequencyPenalty":{"type":"number","description":"The frequency penalty parameter, which is passed through to the primary model of the Mobile-Use Agent"},"ignoreEos":{"type":"string","description":"Specifies whether to ignore the end-of-sequence (EOS) token and continue generation"},"includeReasoning":{"type":"string","description":"Specifies whether to request the upstream to generate the reasoning field. The client-facing results of the Mobile-Use Agent do not…"},"logprobs":{"type":"string","description":"The model compatibility parameter. The JSON field is logprobs. Whether this parameter is accepted and takes effect depends on the model…"},"maxCompletionTokens":{"type":"integer","description":"The OpenAI-compatible maximum number of completion tokens. If provided, the value must be greater than 0"},"maxTokens":{"type":"integer","description":"The OpenAI-compatible maximum number of generated tokens. If provided, the value must be greater than 0"},"messages":{"type":"array","description":"The messages for the current Mobile-Use Agent step. The first step can only contain one user message. Subsequent steps can only contain…"},"metadata":{"type":"object","description":"The metadata for the Mobile-Use Agent step. Supports screen_width, screen_height, available_apps, and the compatibility field…"},"minP":{"type":"number","description":"The vLLM Min-P sampling parameter"},"minTokens":{"type":"integer","description":"The minimum number of tokens to generate"},"mmProcessorKwargs":{"type":"object","description":"The multimodal preprocessor parameters, passed through to the Mobile-Use Agent primary model as-is by key"},"model":{"type":"string","description":"Reserved for OpenAI client compatibility. This parameter is ignored during routing. The model is determined by the published configuration…"},"n":{"type":"integer","description":"Set this parameter to 1. Whether this parameter is accepted depends on the model. The current Mobile-Use Agent response does not return…"},"parallelToolCalls":{"type":"string","description":"The model-compatible switch to invoke parallel tool calling. This parameter does not expand the set of Mobile-Use Agent actions active for…"},"presencePenalty":{"type":"number","description":"The presence penalty parameter, passed through to the Mobile-Use Agent primary model"},"promptLogprobs":{"type":"integer","description":"A model-compatible parameter. The JSON field is prompt_logprobs. Whether this parameter is accepted depends on the model. The current…"},"reasoningEffort":{"type":"string","description":"The OpenAI-compatible reasoning effort, such as low, medium, or high"},"repetitionPenalty":{"type":"number","description":"The vLLM repetition penalty parameter"},"responseFormat":{"type":"object","description":"The model-compatible structured output options. This parameter does not change the final Mobile-Use Agent tool calling structure when you…"},"seed":{"type":"integer","description":"The random seed"},"skipSpecialTokens":{"type":"string","description":"Specifies whether to skip special tokens"},"stop":{"type":"array","description":"The stop sequences. This parameter is compatible with a single string or an array of strings. The array format is shown here"},"stopTokenIds":{"type":"array","description":"The list of vLLM stop token IDs"},"stream":{"type":"string","description":"Specifies whether to use Server-Sent Events (SSE) for streaming responses. You must set this parameter to true for this operation"},"streamOptions":{"type":"object","description":"The OpenAI-compatible streaming options"},"structuredOutputs":{"type":"object","description":"The vLLM structured output constraints"},"temperature":{"type":"number","description":"The sampling temperature, which overrides the default value of the Mobile-Use Agent primary model"},"topK":{"type":"integer","description":"The vLLM Top-K sampling parameter"},"topLogprobs":{"type":"integer","description":"A model-compatible parameter. The JSON field is top_logprobs. Whether this parameter is accepted depends on the model. The current…"},"topP":{"type":"number","description":"The Top-P nucleus sampling parameter, which overrides the default value of the Mobile-Use Agent primary model"}}}}}},"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-maasqiservice/pa-chat-completion-stream":{"post":{"operationId":"cloud_aliyun_maasqiservice_pa_chat_completion_stream","summary":"Invokes a published Mobile Planner Agent using OpenAI-Compatible Chat Completions messages to initiate a…","description":"POST /pa/v1/chat/completions","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["X-QI-Agent-Api-Key","X-QI-Instance-Id","messages","stream"],"properties":{"endpoint":{"type":"string","enum":["https://maasqiservice.cn-beijing.aliyuncs.com"],"default":"https://maasqiservice.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://maasqiservice.cn-beijing.aliyuncs.com"},"X-QI-Agent-Api-Key":{"type":"string","description":"The Agent instance access key used for QICloud Customer API authentication"},"X-QI-Instance-Id":{"type":"string","description":"The published Mobile Planner Agent instance ID. Must correspond to the X-QI-Agent-Api-Key"},"X-QI-Session-Id":{"type":"string","description":"The optional session identifier. Can be omitted for the first turn, in which case the server generates one. Pass it back in subsequent…"},"allowedTokenIds":{"type":"array","description":"The whitelist of token IDs allowed for generation"},"badWords":{"type":"array","description":"The list of words or strings prohibited from generation"},"chatTemplateKwargs":{"type":"object","description":"The vLLM/OpenAI-Compatible template parameter object. Request values are merged with model defaults, with request keys taking precedence,…"},"frequencyPenalty":{"type":"number","description":"The frequency penalty parameter passed through to the Mobile Planner Agent model"},"ignoreEos":{"type":"string","description":"Specifies whether to ignore EOS and continue generation"},"includeReasoning":{"type":"string","description":"Specifies whether to request reasoning content from the upstream. The actual capability depends on the model"},"logprobs":{"type":"string","description":"A model-compatible parameter with the JSON field name logprobs. Whether it is accepted and takes effect depends on the model used by the…"},"maxCompletionTokens":{"type":"integer","description":"The maximum number of completion tokens. Must be greater than 0 if provided, and is passed as an OpenAI-compatible model parameter"},"maxTokens":{"type":"integer","description":"The OpenAI-compatible maximum number of generated tokens. Must be greater than 0 if provided"},"messages":{"type":"array","description":"The list of conversation messages. The first call can submit one turn or an existing multi-turn conversation. When continuing with an…"},"minP":{"type":"number","description":"The vLLM Min-P sampling parameter"},"minTokens":{"type":"integer","description":"The minimum number of tokens to generate"},"mmProcessorKwargs":{"type":"object","description":"The multimodal preprocessor parameters passed through to vLLM as-is by key"},"model":{"type":"string","description":"Reserved for OpenAI client compatibility. Ignored during routing. The actual model is determined by the published instance configuration.…"},"n":{"type":"integer","description":"Set this parameter to 1. Whether the model accepts this parameter depends on the model. The current Mobile Planner Agent response does not…"},"parallelToolCalls":{"type":"string","description":"Specifies whether the model is allowed to generate multiple tool calling requests in parallel. The model invokes tools concurrently when…"},"presencePenalty":{"type":"number","description":"The presence penalty parameter, passed through to the Mobile Planner Agent model"},"promptLogprobs":{"type":"integer","description":"A model compatibility parameter. The JSON field is prompt_logprobs. Whether the model accepts this parameter depends on the model. The…"},"reasoningEffort":{"type":"string","description":"The OpenAI-compatible reasoning effort level, such as low, medium, or high"},"repetitionPenalty":{"type":"number","description":"The vLLM repetition penalty parameter"},"responseFormat":{"type":"object","description":"The structured response format, such as json_object or json_schema"},"seed":{"type":"integer","description":"The random seed"},"skipSpecialTokens":{"type":"string","description":"Specifies whether to skip special tokens"},"stop":{"type":"array","description":"The stop sequences. Compatible with a single string or an array of strings. This field is displayed in array format"},"stopTokenIds":{"type":"array","description":"The vLLM stop token ID list"},"stream":{"type":"string","description":"Specifies whether to use SSE streaming responses. This parameter must be set to true for this operation"},"streamOptions":{"type":"object","description":"The OpenAI-compatible streaming options"},"structuredOutputs":{"type":"object","description":"The vLLM structured output constraints"},"temperature":{"type":"number","description":"The sampling temperature. Passed as an OpenAI-compatible model parameter to override the model default value"},"toolChoice":{"type":"string","description":"The tool choice strategy. Valid values: auto, none, required, or a named selection supported by the model"},"tools":{"type":"array","description":"The array of function tool definitions available for this request. Mobile Planner Agent registers each named function in the runtime…"},"topK":{"type":"integer","description":"The vLLM Top-K sampling parameter"},"topLogprobs":{"type":"integer","description":"A model compatibility parameter. The JSON field is top_logprobs. Used for models that support this feature. The current Agent response…"},"topP":{"type":"number","description":"Top-P sampling parameter. Passed as an OpenAI-compatible model parameter to override the model default value"}}}}}},"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-maasqiservice/version":{"post":{"operationId":"cloud_aliyun_maasqiservice_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://maasqiservice.cn-beijing.aliyuncs.com"],"default":"https://maasqiservice.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://maasqiservice.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"}}}}}}}