Asynchronous invocation API

Single-turn conversation

from openai import AsyncOpenAI
import asyncio
import os

# If the environment variable is not configured, replace the following line with your Model Studio API key: api_key="sk-xxx".
# However, to avoid security risks, we recommend not hard-coding the API key in production code.
api_key=os.getenv("DASHSCOPE_API_KEY")
app_id='APP_ID' # Replace with your actual application ID
base_url = f'https://dashscope.aliyuncs.com/api/v2/apps/agent/{app_id}/compatible-mode/v1/'

# Initialize the asynchronous client
client = AsyncOpenAI(
  api_key=api_key,
  base_url=base_url
)

async def main():
  # Asynchronous call
  response = await client.responses.create(
    input="Who are you?",
    background=True
  )

  # Print the complete response JSON object
  print(response.model_dump_json(indent=2))

# Run the asynchronous main function
if __name__ == "__main__":
  asyncio.run(main())

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.responses.*;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;

public class CreateTask {
    public static void main(String[] args) throws Exception {
        // If the environment variable is not configured, replace the following line with your Model Studio API key: apiKey="sk-xxx".
        // However, to avoid security risks, we recommend not hard-coding the API key in production code.
        String apiKey = System.getenv("DASHSCOPE_API_KEY");
        String appId = "APP_ID"; // Replace with your actual application ID
        String baseUrl = "https://dashscope.aliyuncs.com/api/v2/apps/agent/" + appId + "/compatible-mode/v1/";

        OpenAIClient client = OpenAIOkHttpClient.builder()
                .apiKey(apiKey)
                .baseUrl(baseUrl)
                .build();

        // Asynchronous call
        Response response = client.responses().create(
                ResponseCreateParams.builder()
                        .input("Who are you?")
                        .background(true)
                        .build()
        );

        // Print the complete response JSON object
        ObjectMapper mapper = new ObjectMapper();
        mapper.enable(SerializationFeature.INDENT_OUTPUT);
        System.out.println(mapper.writeValueAsString(response));
    }
}

# If the environment variable is not set, replace {DASHSCOPE_API_KEY} with your actual Model Studio API key.
# However, to avoid security risks, we recommend not hard-coding the API key in production code.
# Please replace APP_ID with your actual application ID.
# Remove comments before execution.
curl --location "https://dashscope.aliyuncs.com/api/v2/apps/agent/{APP_ID}/compatible-mode/v1/responses" \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer ${DASHSCOPE_API_KEY}" \
--data '{
    "input": "Who are you?",
    "background": true
}'

Parameter passing

Plugin parameter passing: In your application, select a plugin and then click Publish.

Custom parameter passing This example shows how to query for city cuisine. In the application, create custom parameters in the Start node. Reference the custom parameters in the Prompts of the LLM Node. After testing, Publish the application.

Plugin parameter passing This example uses a tool to query dorm rules. To pass plugin parameters, add a Plug-in Node and select the desired plugin. In the application, create custom parameters in the Start node and pass them to the input parameters of the plugin node. Reference the custom parameters and plugin output parameters in the Prompts of the LLM Node. After testing, Publish the application.

API call

• Custom parameters: Pass parameters using biz_params. The parameter names and types must match those configured in the application.

  Python

  from openai import AsyncOpenAI
  import asyncio
  import os
  
  # If the environment variable is not configured, replace the following line with your Model Studio API key: api_key="sk-xxx".
  # However, to avoid security risks, we recommend not hard-coding the API key in production code.
  api_key=os.getenv("DASHSCOPE_API_KEY")
  app_id='APP_ID' # Replace with your actual application ID
  base_url = f'https://dashscope.aliyuncs.com/api/v2/apps/agent/{app_id}/compatible-mode/v1/'
  
  # Initialize the asynchronous client
  client = AsyncOpenAI(
    api_key=api_key,
    base_url=base_url
  )
  async def main():
    # Asynchronous call
    response = await client.responses.create(
      input="Hello",
      extra_body={
          "biz_params": {"city": "Beijing"}
      },
      background=True
    )
  
    # Print the complete response JSON object
    print(response.model_dump_json(indent=2))
  
  # Run the asynchronous main function
  if __name__ == "__main__":
    asyncio.run(main())
  

  Java

  import com.openai.client.OpenAIClient;
  import com.openai.client.okhttp.OpenAIOkHttpClient;
  import com.openai.models.responses.*;
  import com.fasterxml.jackson.databind.ObjectMapper;
  import com.fasterxml.jackson.databind.SerializationFeature;
  import java.util.HashMap;
  import java.util.Map;
  
  public class CreateTaskWithCustomParams {
      public static void main(String[] args) throws Exception {
          // If the environment variable is not configured, replace the following line with your Model Studio API key: apiKey="sk-xxx".
          // However, to avoid security risks, we recommend not hard-coding the API key in production code.
          String apiKey = System.getenv("DASHSCOPE_API_KEY");
          String appId = "APP_ID"; // Replace with your actual application ID
          String baseUrl = "https://dashscope.aliyuncs.com/api/v2/apps/agent/" + appId + "/compatible-mode/v1/";
  
          OpenAIClient client = OpenAIOkHttpClient.builder()
                  .apiKey(apiKey)
                  .baseUrl(baseUrl)
                  .build();
  
          // Asynchronous call, passing custom parameters via putAdditionalBodyProperty
          Map<String, Object> bizParams = new HashMap<>();
          bizParams.put("city", "Beijing");
  
          Response response = client.responses().create(
                  ResponseCreateParams.builder()
                          .input("Hello")
                          .background(true)
                          .putAdditionalBodyProperty("biz_params",
                                  com.openai.core.JsonValue.from(bizParams))
                          .build()
          );
  
          // Print the complete response JSON object
          ObjectMapper mapper = new ObjectMapper();
          mapper.enable(SerializationFeature.INDENT_OUTPUT);
          System.out.println(mapper.writeValueAsString(response));
      }
  }
  

  curl

  #!/bin/bash
  # ==================== Configuration ====================
  # If the DASHSCOPE_API_KEY environment variable is not set, replace ${DASHSCOPE_API_KEY}
  # with your actual Model Studio API key.
  # To avoid security risks, we recommend not hard-coding the API key in production code.
  # Replace {APP_ID} with your actual application ID.
  
  # ==================== API Call ====================
  curl --location "https://dashscope.aliyuncs.com/api/v2/apps/agent/{APP_ID}/compatible-mode/v1/responses" \
  --header 'Content-Type: application/json' \
  --header "Authorization: Bearer ${DASHSCOPE_API_KEY}" \
  --data '{
      "input": "Who are you?",
      "background": true,
      "biz_params": {
          "city": "Hangzhou"
      }
  }'
  

• Plugin parameters: Pass parameters via biz_params. Use user_defined_params to pass plugin parameters and user_defined_tokens to pass authentication tokens. The parameter names and types must match the plugin's configuration.

  Python

  """
  Example of calling an Alibaba Cloud Model Studio application
  asynchronously.
  """
  from openai import AsyncOpenAI
  import asyncio
  import os
  
  # ==================== Configuration ====================
  
  # API key configuration
  # If the environment variable is not configured, you can replace the following line with: api_key="sk-xxx"
  # To avoid security risks, we recommend not hard-coding the API key in production code.
  api_key = os.getenv("DASHSCOPE_API_KEY")
  
  # Application ID (Get this from Model Studio console -> Applications -> Publish channels -> API)
  app_id = 'YOUR_APP_ID'  # Replace with your actual application ID
  
  # Base URL
  base_url = f'https://dashscope.aliyuncs.com/api/v2/apps/agent/{app_id}/compatible-mode/v1/'
  
  # ==================== Client Initialization ====================
  
  client = AsyncOpenAI(
      api_key=api_key,
      base_url=base_url
  )
  
  # ==================== Business Parameter Configuration (Optional) ====================
  
  # biz_params is used to pass custom parameters to plugins in the application.
  # Replace YOUR_PLUGIN_ID with the actual plugin ID from the plugin details page in the Model Studio console.
  biz_params = {
      # Custom parameters: Parameters passed to a specified plugin.
      "user_defined_params": {
          "YOUR_PLUGIN_ID": {  # Replace with the actual plugin ID
              "article_index": 9   # Custom parameter, set according to the plugin's requirements.
          }
      },
      # Custom tokens: Provide authentication information for the specified plugin. Replace YOUR_TOKEN with a valid authentication token.
      "user_defined_tokens": {
          "YOUR_PLUGIN_ID": {  # Replace with the actual plugin ID
              "user_token": "YOUR_TOKEN" # The authentication token required by the plugin.
          }
      }
  }
  
  # ==================== Main Function ====================
  
  async def main():
      """Call the agent application asynchronously."""
  
      # Make the asynchronous request
      # - input: The user's question or instruction.
      # - extra_body: Additional parameters, including biz_params.
      # - background: true indicates asynchronous execution.
      response = await client.responses.create(
          input="Hello",
          extra_body={
              "biz_params": biz_params
          },
          background=True
      )
  
      # Print the complete response JSON object
      print(response.model_dump_json(indent=2))
  
  # ==================== Program Entry Point ====================
  
  if __name__ == "__main__":
      asyncio.run(main())
  

  Java

  import com.openai.client.OpenAIClient;
  import com.openai.client.okhttp.OpenAIOkHttpClient;
  import com.openai.models.responses.*;
  import com.fasterxml.jackson.databind.ObjectMapper;
  import com.fasterxml.jackson.databind.SerializationFeature;
  import java.util.HashMap;
  import java.util.Map;
  
  public class CreateTaskWithPluginParams {
      public static void main(String[] args) throws Exception {
          // If the environment variable is not configured, replace the following line with your Model Studio API key: apiKey="sk-xxx".
          // However, to avoid security risks, we recommend not hard-coding the API key in production code.
          String apiKey = System.getenv("DASHSCOPE_API_KEY");
          String appId = "YOUR_APP_ID"; // Replace with your actual application ID
          String baseUrl = "https://dashscope.aliyuncs.com/api/v2/apps/agent/" + appId + "/compatible-mode/v1/";
  
          OpenAIClient client = OpenAIOkHttpClient.builder()
                  .apiKey(apiKey)
                  .baseUrl(baseUrl)
                  .build();
  
          // Build biz_params, including user_defined_params and user_defined_tokens.
          // Custom parameters: Parameters passed to a specified plugin.
          Map<String, Object> pluginParams = new HashMap<>();
          pluginParams.put("article_index", 9);  // Custom parameter, set according to the plugin's requirements.
          Map<String, Object> userDefinedParams = new HashMap<>();
          userDefinedParams.put("YOUR_PLUGIN_ID", pluginParams);  // Replace with the actual plugin ID.
  
          // Custom tokens: Provide authentication information for the specified plugin.
          Map<String, Object> pluginTokens = new HashMap<>();
          pluginTokens.put("user_token", "YOUR_TOKEN");  // The authentication token required by the plugin.
          Map<String, Object> userDefinedTokens = new HashMap<>();
          userDefinedTokens.put("YOUR_PLUGIN_ID", pluginTokens);  // Replace with the actual plugin ID.
  
          Map<String, Object> bizParams = new HashMap<>();
          bizParams.put("user_defined_params", userDefinedParams);
          bizParams.put("user_defined_tokens", userDefinedTokens);
  
          // Asynchronous call, passing plugin parameters via putAdditionalBodyProperty
          Response response = client.responses().create(
                  ResponseCreateParams.builder()
                          .input("Hello")
                          .background(true)
                          .putAdditionalBodyProperty("biz_params",
                                  com.openai.core.JsonValue.from(bizParams))
                          .build()
          );
  
          // Print the complete response JSON object
          ObjectMapper mapper = new ObjectMapper();
          mapper.enable(SerializationFeature.INDENT_OUTPUT);
          System.out.println(mapper.writeValueAsString(response));
      }
  }
  

  curl

  #!/bin/bash
  # ==================== Configuration ====================
  # If the DASHSCOPE_API_KEY environment variable is not set, replace ${DASHSCOPE_API_KEY}
  # with your actual Model Studio API key.
  # To avoid security risks, we recommend not hard-coding the API key in production code.
  
  APP_ID="YOUR_APP_ID"  # Replace with your actual application ID
  
  # ==================== API Call ====================
  curl --location "https://dashscope.aliyuncs.com/api/v2/apps/agent/${APP_ID}/compatible-mode/v1/responses" \
  --header 'Content-Type: application/json' \
  --header "Authorization: Bearer ${DASHSCOPE_API_KEY}" \
  --data '{
      "input": "Who are you?",
      "background": true,
      "biz_params": {
          "user_defined_params": {
              "YOUR_PLUGIN_ID": {
                  "article_index": 9
              }
          },
          "user_defined_tokens": {
              "YOUR_PLUGIN_ID": {
                  "user_token": "YOUR_TOKEN"
              }
          }
      }
  }'
  
  # ==================== Parameter Reference ====================
  # The biz_params object passes custom parameters to plugins in the Agent.
  #
  # user_defined_params - Custom parameters
  #   YOUR_PLUGIN_ID: Replace with the actual plugin ID.
  #   article_index: Custom parameter name and value, set according to the plugin's requirements.
  #
  # user_defined_tokens - Custom tokens (for authentication)
  #   YOUR_PLUGIN_ID: Replace with the actual plugin ID.
  #   user_token: The authentication token required by the plugin.