All Products
Search
Document Center

API Gateway:Manage Agent APIs

Last Updated:Dec 03, 2025

An Agent API is a new API type in AI Gateway designed for agent applications on platforms such as Alibaba Cloud Model Studio and Dify. Use Agent APIs to seamlessly and securely integrate various agent capabilities into your business systems. This integration enables innovative features, such as intelligent conversations and workflow automation, and helps you efficiently build an intelligent application ecosystem.

Create an Agent API

  1. On the Instances page of the AI Gateway console, select the region where your instance is located.

  2. Go to the details page of the target instance. In the navigation pane on the left, choose Agent API.

  3. Click Create Agent API and configure the following basic parameters:

    • API Name: Enter a custom name for the API.

      The names of Model APIs and Agent APIs cannot be the same.
    • Domain Name: Select the domain name for which you want to create the Agent API.

    • Base Path: Enter a custom base path for the API.

    • Protocol: The supported protocols are Alibaba Cloud Model Studio, Dify, and Custom. The default value is Alibaba Cloud Model Studio.

      • Alibaba Cloud Model Studio: For large model applications from Alibaba Cloud Model Studio. These applications include agents, workflows, and agent orchestration. They also provide features such as knowledge base retrieval, web search, workflow design, and agent collaboration, which significantly expand the application scope of large models.

      • Dify: Dify agents use the inference capabilities of large language models (LLMs). This lets you build AI applications that can autonomously set goals, break down tasks, use tools, and complete complex tasks step by step.

      • Custom: For other custom agent services.

    • Resource Group: Select the default resource group or an existing resource group. To create a new resource group, click Create Resource Group.

      Use resource groups to classify and manage resources under your Alibaba Cloud account. You can manage permissions, deploy resources, and monitor resources for entire groups of resources instead of for individual resources.

Edit an Agent API

  1. On the Instances page of the AI Gateway console, select the region where your instance is located.

  2. Go to the details page of the target instance. In the navigation pane on the left, choose Agent API.

  3. In the Actions column of the target Agent API, click Edit. In the Edit Agent API panel, modify the Domain Name and Base Path of the Agent API, and then click OK.

Delete an Agent API

  1. On the Instances page of the AI Gateway console, select the region where your instance is located.

  2. Go to the details page of the target instance. In the navigation pane on the left, choose Agent API.

  3. In the Actions column of the target Agent API, click Delete. In the Confirm Deletion dialog box, enter the name of the API and click Delete.