API overview
API standards and multilingual preset SDKs
The OpenAPI of this product (Ada/2026-07-01) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDKdownload the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Agent management
|
API |
Title |
Description |
| CreateAgent | Create an agent | Creates an agent. |
| GetAgent | Query agent | Queries agents visible to the current identity by name. |
| ListAgents | List agents | Queries the agents visible to the current identity by using paging. |
| UpdateAgent | Update an agent | Updates the configuration of an agent. |
| DeleteAgent | Delete an agent | Deletes a specified agent. |
Session execution and management
|
API |
Title |
Description |
| CreateAgentSession | Create a session | Creates a text session for a specified agent and obtains the session ID required for subsequent calls. |
| PromptAgentSession | Send a session message | Sends text to an existing session and continuously receives agent output over Server-Sent Events (SSE). |
| LoadAgentSession | Load session | Loads session history, receives subsequent output, or resumes Server-Sent Events (SSE) from a saved read position. |
| ReplyAgentSession | Reply to session interaction | Submits the approval choice or question answer for the current pending interaction. |
| ListAgentSessions | List sessions | Queries the session summary by paging for the caller to select or resume existing sessions. |
| GetAgentSession | Query session details | Queries session details such as the title, associated agent, and core timestamps based on the session ID. |
| CancelAgentSession | Cancel session execution | Stops a session execution or cancels a specified turn. |
| DeleteAgentSession | Delete a session | Deletes an idle session that is no longer needed. |
Model management
|
API |
Title |
Description |
| ListModels | Query available models | Queries the text models visible to the current caller for selection when setting a session model. |
| GetAgentSessionModel | Query session model | Queries the model and thinking level configurations currently used by the session. |
| SetAgentSessionModel | Set session model | Sets the model used by a session and optionally configures the thinking level. |
Skill management
|
API |
Title |
Description |
| CreateSkill | Create a skill | Creates a skill. |
| GetSkill | Query a skill | Queries the skills visible to the current caller by name. |
| ListSkills | List skills | Performs a paging query for skills visible to the current invoker. |
| UpdateSkill | Update a skill | Updates a skill. |
| DeleteSkill | Delete a skill | Soft-deletes a skill that the current caller has permission to modify. |
File transit management
|
API |
Title |
Description |
| CreateTransitUploadPolicy | Generate file upload policy | Generates credentials for direct file upload. Callers can use the returned upload policy to upload files directly to object storage. |
| GetTransitMeta | Query file metadata | Queries the metadata of a transit file, such as the upload status, file size, and expiration time, and retrieves a temporary download URL on demand. |
Others
|
API |
Title |
Description |
| GetWorkflowGlobalEnv | Query global workflow configurations | Queries the global workflow configurations. |
| SaveWorkflowGlobalEnv | Save global workflow configuration | Saves the global workflow configuration. |