Endpoint, authentication, and available APIs for the OpenAI-compatible API.
Prerequisites
- Activate Alibaba Cloud Model Studio and create an API Key.
- Get the workspace ID (
ws_xxxxxxxxxxxx).
Endpoint
workspace_id: the workspace ID.- The current region is
cn-beijing. - Replace
{workspace_id}with the actual workspace ID. - Append the request path to the Base URL, for example
POST {Base URL}/agents.
Authentication
Send the API Key in the HTTP header:
OpenAI-Beta: agents=v1. The API does not use this header to choose defaults. For authentication, workspace routing, and permissions, see Authentication.
Available APIs
| Resource | Endpoint | Purpose |
|---|---|---|
| Agent | POST /agents | Create a reusable agent |
GET /agents/{agent_id} | Get an agent | |
GET /agents | List agents | |
POST /agents/{agent_id} | Update an agent | |
DELETE /agents/{agent_id} | Delete an agent | |
| Session | POST /agents/sessions | Create a session and send the first input |
GET /agents/sessions | List sessions | |
GET /agents/sessions/{session_id} | Get a session | |
POST /agents/sessions/{session_id} | Update session settings | |
DELETE /agents/sessions/{session_id} | Delete a session | |
| Event | POST /agents/sessions/{session_id}/events | Send a message, cancel, or return a tool result |
GET /agents/sessions/{session_id}/events | Subscribe to the SSE stream | |
| History | GET /agents/sessions/{session_id}/turns | Query turns |
GET /agents/sessions/{session_id}/items | Query items | |
GET /agents/sessions/{session_id}/subagents | Query subagents | |
| Environment | POST /agents/environments | Create a managed environment |
GET /agents/environments/{environment_id} | Get an environment | |
GET /agents/environments | List environments | |
GET /agents/environments/templates | List environment templates | |
GET /agents/environments/templates/{template_id} | Retrieve an environment template | |
POST /agents/environments/templates | Create an environment template | |
POST /agents/environments/templates/{template_id} | Update an environment template | |
DELETE /agents/environments/templates/{template_id} | Delete an environment template | |
| File | POST /agents/file | Upload a source file |
GET /agents/file | List source files | |
GET /agents/file/{file_id} | Retrieve a source file | |
DELETE /agents/file/{file_id} | Delete a source file | |
POST /agents/environments/{environment_id}/files | Write a source file to an environment | |
| Artifact | GET /agents/sessions/{session_id}/artifacts | Query artifacts |
GET /agents/sessions/{session_id}/artifacts/{artifact_id}/content | Download an artifact | |
| Vault | POST /vaults | Create a vault |
POST /vaults/{vault_id}/credentials | Create a credential |