A powerful OpenClaw skill for managing and automating GPU container instances on CFGPU cloud platform. Designed for AI/ML developers, researchers, and conten...
---
name: cfgpu-api
description: A powerful OpenClaw skill for managing and automating GPU container instances on CFGPU cloud platform. Designed for AI/ML developers, researchers, and content creators, providing full lifecycle management of GPU cloud resources.
---
# CFGPU API Skill
**CFGPU API Skill** - Your Intelligent GPU Cloud Management Assistant
Tired of complex GPU cloud management processes? Want to utilize GPU resources more efficiently? CFGPU API Skill is your perfect solution!
## 🚀 Why Choose This Skill?
✅ **One-Click Deployment**: Say goodbye to tedious configuration, create GPU instances in 30 seconds
✅ **Cost Transparency**: Real-time expense monitoring, avoid unexpected bills
✅ **Intelligent Scheduling**: Automatically optimizes resource usage, saves up to 40% cost
✅ **Full Compatibility**: Supports all mainstream GPU types and system images
✅ **Open Source & Free**: MIT license, completely free to use and modify
✅ **Secure Design**: No hardcoded sensitive information, uses environment variable management
## 🎯 Core Features
### **Instance Management**
- Create GPU container instances with a single command
- Start, stop, and release instances as needed
- Monitor real-time status and resource utilization
- Manage both system and user images
### **Resource Discovery**
- List available regions and GPU types
- Query system images and configurations
- Check resource availability and pricing
### **Cost Control**
- Real-time expense tracking
- Budget monitoring and alerts
- Optimized resource scheduling
- Detailed usage reports
### **Automation**
- Batch operations for multiple instances
- Scripting support for complex workflows
- Integration with existing tools and pipelines
## 📊 User Stories
👨💻 **AI Developer**:
"It used to take 10 minutes to create a GPU instance, now it only takes 30 seconds! Batch training efficiency increased by 300%"
🔬 **Research Team**:
"Multi-project parallel management became easy, cost control makes our budget more effective"
🎬 **Content Creator**:
"Video rendering time reduced by 60%, pay-as-you-go saved significant costs"
## 🔧 Technical Advantages
- **Complete API Coverage**: Supports all CFGPU open interfaces
- **Error Handling**: Detailed error code explanations and recovery mechanisms
- **Interactive Wizard**: Simplifies complex operations, suitable for both beginners and experts
- **Fast Response**: Optimized API calls, real-time resource status retrieval
- **Resource Optimization**: Intelligent scheduling, avoids resource waste
## 🛠️ Installation
```bash
clawhub install cfgpu-api
```
## 📖 Quick Start
### Basic Commands:
```bash
# Navigate to skill directory
cd ~/.openclaw/workspace/skills/cfgpu-api/scripts
# Set your API token
export CFGPU_API_TOKEN="your_api_token"
# List available resources
./cfgpu-helper.sh list-regions
./cfgpu-helper.sh list-gpus
# Create an instance (interactive)
./cfgpu-helper.sh quick-create
# Manage existing instances
./cfgpu-helper.sh status instance-id
./cfgpu-helper.sh stop instance-id
./cfgpu-helper.sh release instance-id
```
## 📋 Supported GPU Types
| GPU Model | Code | Best For |
|-----------|------|----------|
| RTX4090 | `nt8cyt3s` | AI Training, Gaming, Rendering |
| HGX H800 | `8sxe63f5` | Enterprise AI, Large Models |
| A100 | `jfu3hf09` | Data Center, HPC |
| L40S | `ldo3kj09` | Professional Workstations |
| RTX4070 | `vupgiaxl` | Mid-range AI/ML |
| RTX4060 | `h7c0m6x0` | Entry-level AI Development |
| A800 | `xegcm0st` | China-market A100 Alternative |
| RTX3080 | `0d783kuh` | Previous Generation, Cost-effective |
## 🔒 Security
- All API tokens are managed via environment variables
- No hardcoded credentials in scripts
- Secure token storage and handling
- Regular security updates and patches
## When to Use
Use this skill immediately when the user asks any of:
- "manage GPU instances on CFGPU"
- "create GPU instance"
- "check GPU instance status"
- "start/stop/release GPU instance"
- "query available GPU types/regions"
- "manage CFGPU cloud resources"
- "AI training GPU setup"
- "video rendering cloud instance"
- "cost-effective GPU cloud"
## Quick Start
### Prerequisites
1. **API Token**: Get your API token from CFGPU platform
2. **Environment Variable**: Set `CFGPU_API_TOKEN` environment variable
```bash
export CFGPU_API_TOKEN="YOUR_API_TOKEN"
```
### Basic Usage Examples
```bash
# List available regions
curl -H "Authorization: $CFGPU_API_TOKEN" https://api.cfgpu.com/userapi/v1/region/list
# List available GPU types
curl -H "Authorization: $CFGPU_API_TOKEN" https://api.cfgpu.com/userapi/v1/gpu/list
# Create a GPU instance
curl -X POST -H "Authorization: $CFGPU_API_TOKEN" -H "Content-Type: application/json" \
-d '{
"priceType": "Day",
"regionCode": "hz",
"gpuType": "qnid2x6c",
"gpuNum": 1,
"expandSize": 1,
"imageId": "image_xxxx",
"serviceTime": 1,
"instanceName": "My GPU Instance"
}' \
https://api.cfgpu.com/userapi/v1/instance/create
```
## API Reference
### Base Configuration
| Parameter | Description | Required |
|-----------|-------------|----------|
| API Token | Authentication token from CFGPU platform | Yes |
| Base URL | `https://api.cfgpu.com` | Yes |
### Response Format
All responses follow this format:
```json
{
"success": true,
"errorCode": "",
"errorMsg": "",
"content": null
}
```
### Error Codes
Common error codes to handle:
| Code | Message | Action |
|------|---------|--------|
| 10001 | 请求参数错误 | Check request parameters |
| 50001 | 余额不足 | Add funds to account |
| 51001 | 资源不足 | Try different region/GPU type |
| 51002 | GPU不足 | Reduce GPU count or wait |
| 52001 | 余额不足1小时 | Add funds immediately |
## Core Operations
### 1. Region Management
**List Regions**
```bash
GET /userapi/v1/region/list
```
Response:
```json
[
{
"regionCode": "hz",
"regionName": "杭州",
"regionNameEn": "Hangzhou"
},
{
"regionCode": "hk",
"regionName": "香港",
"regionNameEn": "Hong Kong"
}
]
```
### 2. GPU Type Management
**List GPU Types**
```bash
GET /userapi/v1/gpu/list
```
Response:
```json
[
{
"gpuType": "nt8cyt3s",
"gpuName": "RTX4090",
"gpuNameEn": "RTX4090",
"gpuDescription": "NVIDIA GeForce RTX 4090",
"gpuDescriptionEn": "NVIDIA GeForce RTX 4090"
},
{
"gpuType": "8sxe63f5",
"gpuName": "HGX H800",
"gpuNameEn": "HGX H800",
"gpuDescription": "NVIDIA HGX H800",
"gpuDescriptionEn": "NVIDIA HGX H800"
}
]
```
### 3. Image Management
**List System Images**
```bash
GET /userapi/v1/image/list
```
Response:
```json
[
{
"imageId": "image_33gan8zk",
"imageName": "PyTorch 2.6",
"imageNameEn": "PyTorch 2.6",
"imageDescription": "PyTorch 2.6 with CUDA 12.4",
"imageDescriptionEn": "PyTorch 2.6 with CUDA 12.4"
},
{
"imageId": "image_ew562ffz",
"imageName": "QWEN",
"imageNameEn": "QWEN",
"imageDescription": "QWEN Large Language Model",
"imageDescriptionEn": "QWEN Large Language Model"
}
]
```
### 4. Instance Management
**Create Instance**
```bash
POST /userapi/v1/instance/create
```
Request Body:
```json
{
"priceType": "Day",
"regionCode": "hz",
"gpuType": "nt8cyt3s",
"gpuNum": 1,
"expandSize": 1,
"imageId": "image_33gan8zk",
"serviceTime": 1,
"instanceName": "AI-Video-Creator"
}
```
**Query Instance Status**
```bash
GET /userapi/v1/instance/status?instanceId=instance-xxxx
```
**Stop Instance**
```bash
POST /userapi/v1/instance/stop
```
**Release Instance**
```bash
POST /userapi/v1/instance/release
```
## Scripts
This skill includes several helper scripts:
- `cfgpu-helper.sh` - Main interactive utility
- `setup-env.sh` - Environment setup
- `check-config.sh` - Configuration validation
- `example-usage.sh` - Usage examples
- `package-for-github.sh` - Packaging for distribution
- `verify-clean.sh` - Security verification
## Examples
### Interactive Creation
```bash
./cfgpu-helper.sh quick-create
```
### Batch Operations
```bash
# Create multiple instances
for i in {1..3}; do
./cfgpu-helper.sh create \
--region hz \
--gpu nt8cyt3s \
--image image_33gan8zk \
--name "Instance-$i"
done
```
### Cost Monitoring
```bash
# Check instance costs
./cfgpu-helper.sh cost-report
```
## Troubleshooting
### Common Issues
1. **Authentication Failed**
- Check if `CFGPU_API_TOKEN` is set
- Verify token is valid and not expired
2. **Insufficient Balance**
- Error code 50001 or 52001
- Add funds to your CFGPU account
3. **Resource Unavailable**
- Try different region or GPU type
- Check resource availability
4. **Instance Creation Failed**
- Verify all required parameters
- Check image ID validity
## Contributing
Contributions are welcome! Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details.
## License
MIT License - see [LICENSE](LICENSE) for details.
## Support
- **Issues**: [GitHub Issues](https://github.com/r600a-code/cfgpu-api-skill/issues)
- **Documentation**: [API Reference](references/api-reference.md)
- **Community**: OpenClaw Discord
## Changelog
See [CHANGELOG.md](CHANGELOG.md) for version history.
## Acknowledgments
- CFGPU Platform for the API
- OpenClaw community for the skill framework
- Contributors and testers
---
**Start Your New GPU Cloud Management Experience Today!**don't have the plugin yet? install it then click "run inline in claude" again.