API Reference
API Documentation
Complete reference for the Wollnut Labs REST API. Manage GPU instances, billing, and more programmatically.
Base URL
text
https://your-domain.com/api/v1All API requests require an API key passed via the Authorization header unless marked as public.
bash
curl -H "Authorization: Bearer wn_ak_your_key_here" \
https://your-domain.com/api/v1/instancesAPI keys are shown only once at creation. Store them securely. Endpoints marked with a icon require authentication.
Response Format
All responses follow a consistent JSON format:
Success
json
{
"success": true,
"data": { ... }
}Error
json
{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Instance not found"
}
}Authentication
Sign up, sign in, and manage sessions
Instances
Create, manage, and control GPU instances
GPU Plans
List available GPU configurations and pricing
Templates
Pre-configured environments for ML workloads
AI Models
Browse and deploy AI models
Billing
Credits, balance, usage, and transactions
SSH Keys
Manage SSH keys for instance access
API Keys
Create and manage API keys for programmatic access
Notifications
User notifications for instance events and billing alerts
Error Codes
| Code | HTTP Status | Description |
|---|---|---|
| VALIDATION_ERROR | 422 | Request body failed validation (Zod). Check error.details for field-level messages. |
| AUTHENTICATION_ERROR | 401 | Missing or invalid authentication credentials. |
| AUTHORIZATION_ERROR | 403 | Authenticated but not authorized for this resource. |
| NOT_FOUND | 404 | The requested resource does not exist. |
| INSUFFICIENT_CREDITS | 402 | Not enough credits to perform the operation. |
| RATE_LIMITED | 429 | Too many requests. Retry after the rate limit window. |
| E2E_API_ERROR | 502 | Upstream E2E Networks API error. |
| INTERNAL_ERROR | 500 | Unexpected server error. |
