Alibaba Cloud SDK and API Guide

更新时间:
复制 MD 格式

This topic summarizes the entry points for calling FC Agent Sandbox through native OpenAPI, Alibaba Cloud SDK, and Alibaba Cloud CLI. FC Agent Sandbox OpenAPI provides resource management capabilities such as Team, API Key, and Quota. These capabilities belong to the Alibaba Cloud OpenAPI / POP SDK control plane and are not E2B SDK-compatible APIs.

If you use the E2B SDK or E2B CLI to connect to FC Agent Sandbox, see E2B SDK-compatible API List and E2B SDK Connection Parameters.

Before you begin

Before calling FC Agent Sandbox OpenAPI, complete the following preparations:

  • Enable Function Compute and the related FC Agent Sandbox capabilities.

  • Prepare an Alibaba Cloud account or RAM user, and grant the required permissions to call FC Agent Sandbox OpenAPI.

  • Confirm the region. The region used for OpenAPI, SDK, and CLI calls must match the region where your FC Agent Sandbox resources reside.

  • Configure Alibaba Cloud access credentials. In production environments, use a RAM user, RAM role, or another temporary credential solution. Do not hard-code AccessKey credentials in your code.

Service endpoints

For the latest service endpoints, see FC Agent Sandbox service endpoints.

View OpenAPI documentation

The FC Agent Sandbox OpenAPI documentation provides the API list, request parameters, response structures, error information, and online debugging capabilities. Before development, use the OpenAPI documentation to confirm the parameter requirements and response structure of the target API.

View documentation: FC Agent Sandbox OpenAPI documentation

Call FC Agent Sandbox by using Alibaba Cloud SDK

When calling FC Agent Sandbox from a business system, we recommend that you use Alibaba Cloud SDK. The SDK page provides installation methods, client initialization examples, and API call examples, and supports switching between Java, Python, Go, TypeScript, and other languages.

View documentation: FC Agent Sandbox SDK installation and call examples

Call FC Agent Sandbox by using Alibaba Cloud CLI

Alibaba Cloud CLI is suitable for local verification, scripted calls, and troubleshooting. Before using it, install Alibaba Cloud CLI and complete basic configuration such as credentials and region.

For installation and configuration methods, see Alibaba Cloud CLI User Guide.

View CLI call examples: Call FC Agent Sandbox by using Alibaba Cloud CLI

Usage recommendations

  • To confirm whether an API exists or how to fill in parameters, check the OpenAPI documentation first.

  • To call FC Agent Sandbox reliably from application code, use the Alibaba Cloud SDK first.

  • To quickly verify APIs or write lightweight operational scripts, use the Alibaba Cloud CLI.