​
Welcome to GMI Cloud API

GMI Cloud provides comprehensive APIs for managing your cloud infrastructure, including container services, AI inference, and cluster management. Our APIs are designed to be RESTful, secure, and easy to integrate into your applications.

​
Before You Start

Authentication Required: All GMI Cloud APIs require authentication. You must be logged in and have valid API credentials to use these endpoints.

​
Step 1: Create Your Account and Login

  1. Sign up for a GMI Cloud account at console.gmicloud.ai
  2. Verify your email and complete the registration process
  3. Login to your account to access the console

​
Step 2: Obtain API Credentials

  1. Navigate to Organization Settings in your console
  2. Go to the API Keys section
  3. Create a new API key for programmatic access
  4. Save your API key securely (it will only be shown once)

​
Step 3: Set Up Authentication

All API endpoints require Bearer token authentication: 
curl -X GET "https://console.gmicloud.ai/api/endpoint" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

​
Quick Start Example: Creating a Container

Here’s a step-by-step example of creating a container using our APIs:

​
1. First, list available container templates

curl -X GET "https://console.gmicloud.ai/api/v1/templates" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

​
2. Create a new container workload

Required Parameters:
  • idc: Default value is “us-denver-1”. Use the IDC API to get other available data center locations
  • product: Contact sales team to confirm the correct product ID for your needs
curl -X POST "https://console.gmicloud.ai/api/v1/containers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my-container",
    "templateId": "b89f653f-f080-40a9-8134-02dd6d213894",
    "count": 1,
    "product": "container.h200.x1",
    "idc": "us-denver-1",
    "envs": [
      {
        "name": "SSH_KEY",
        "value": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAB... your-ssh-public-key"
      }
    ]
  }'
SSH Access: Currently, SSH keys must be provided as environment variables during container creation. There’s no separate SSH key management API yet.

​
3. Monitor the container status

curl -X GET "https://console.gmicloud.ai/api/v1/containers/my-container-id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

​
4. Access your running container

Once your container is running with the SSH key configured, you can connect directly: 
ssh gmi@public-ip -p 22 -i your-private-key
The container will use the SSH public key you provided during creation for authentication.

​
Complete Workflow

1

Login to GMI Cloud Console

Access console.gmicloud.ai and sign in with your credentials.
2

Create API Key

Navigate to Organization Settings → API Keys and generate a new API key.
3

Choose Your Service

Select from IAM, IaaS, or IDC service APIs based on your needs.
4

Make API Calls

Use your API key in the Authorization header to interact with our services.
5

Monitor and Manage

Track your resources through both API calls and the web console.

​
Need Help?