# Alibaba Cloud OSS Agent API

> Alibaba Cloud OSS Agent API on Apizie: 5 endpoints (Streams chat messages, Confirms a tool call, Retrieves the detailed content of a session. You can only query sessions generated by the current account, Terminates a chat session, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-ossagent/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-ossagent`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/ossagent
- Page: https://zieapi.vercel.app/api/cloud/aliyun-ossagent
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-ossagent/openapi.json

Alibaba Cloud OpenAPI for OSS Agent (ossagent, version 2026-06-22). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Streams chat messages
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ossagent/chat` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| messages | array | no | The messages |
| sessionId | string | no | The ID of the Q&A session |
| env | string | no | The name of the dedicated environment for the agent |

### Confirms a tool call
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ossagent/confirm` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| confirmed | string | no | Specifies whether the tool execution is approved |
| phase | string | no | The current execution phase |
| reason | string | no | The reason for invoking or not invoking the tool |
| sessionId | string | no | The ID of the chat session |
| toolCalls | array | no | The tool invocations |
| env | string | no | The dedicated environment name for the agent |

### Retrieves the detailed content of a session. You can only query sessions generated by the current account
`GET https://zieapi.vercel.app/v1/cloud:aliyun-ossagent/get-session-content` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| sessionId | string | no | The session ID |
| env | string | no | The dedicated environment name of the agent |

### Terminates a chat session
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ossagent/interrupt` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| sessionId | string | yes | The session ID |
| env | string | no | The name of the dedicated environment for the agent |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-ossagent/version` (byok)

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-ossagent/chat" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud OSS Agent API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-ossagent/chat with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud OSS Agent API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud OSS Agent itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud OSS Agent API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-ossagent.

### What is the status of the Alibaba Cloud OSS Agent API?
Needs your own provider key (bring your own key)