Skip to main content

Overview

Endpoint, authentication, and available APIs for the OpenAI-compatible API.

Prerequisites

  1. Activate Alibaba Cloud Model Studio and create an API Key.
  2. Get the workspace ID (ws_xxxxxxxxxxxx).

Endpoint

https://{workspace_id}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1
  • 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:
Authorization: Bearer $DASHSCOPE_API_KEY
Compatible clients can also send OpenAI-Beta: agents=v1. The API does not use this header to choose defaults. For authentication, workspace routing, and permissions, see Authentication.

Available APIs

ResourceEndpointPurpose
AgentPOST /agentsCreate a reusable agent
GET /agents/{agent_id}Get an agent
GET /agentsList agents
POST /agents/{agent_id}Update an agent
DELETE /agents/{agent_id}Delete an agent
SessionPOST /agents/sessionsCreate a session and send the first input
GET /agents/sessionsList 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
EventPOST /agents/sessions/{session_id}/eventsSend a message, cancel, or return a tool result
GET /agents/sessions/{session_id}/eventsSubscribe to the SSE stream
HistoryGET /agents/sessions/{session_id}/turnsQuery turns
GET /agents/sessions/{session_id}/itemsQuery items
GET /agents/sessions/{session_id}/subagentsQuery subagents
EnvironmentPOST /agents/environmentsCreate a managed environment
GET /agents/environments/{environment_id}Get an environment
GET /agents/environmentsList environments
GET /agents/environments/templatesList environment templates
GET /agents/environments/templates/{template_id}Retrieve an environment template
POST /agents/environments/templatesCreate an environment template
POST /agents/environments/templates/{template_id}Update an environment template
DELETE /agents/environments/templates/{template_id}Delete an environment template
FilePOST /agents/fileUpload a source file
GET /agents/fileList 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}/filesWrite a source file to an environment
ArtifactGET /agents/sessions/{session_id}/artifactsQuery artifacts
GET /agents/sessions/{session_id}/artifacts/{artifact_id}/contentDownload an artifact
VaultPOST /vaultsCreate a vault
POST /vaults/{vault_id}/credentialsCreate a credential
The table lists common endpoints, not the complete API surface; see the navigation for all endpoints.

SDK installation

Install the OpenAI Python SDK:
pip install openai requests
For usage examples, see Quickstart.