CloudCLI API Documentation
CloudCLI Documentation
  1. Environments
  • CloudCLI API Documentation
  • Environments
    • List environments
      GET
    • Get environment
      GET
    • Create environment
      POST
    • Delete environment
      DELETE
    • Get SSH credentials
      GET
    • Start environment
      POST
    • Stop environment
      POST
  • Agents
    • Execute AI agent
      POST
    • AI Agent models
      GET
  • Schemas
    • Schemas
      • AgentModels
      • Environment
      • CreateEnvironmentRequest
      • SSHCredentials
      • AgentExecuteRequest
      • Error
  1. Environments

Create environment

POST
https://cloudcli.ai/api/v1/environments
The request body for POST /environments, which provisions a new CloudCLI development container on your account. Only name and subdomain are required. Everything else (GitHub clone, tokens) is optional and can be configured later via the dashboard.

Request

Authorization
API Key
Add parameter in header
X-API-KEY
Example:
X-API-KEY: ********************
or
Body Params application/jsonRequired

Examples

Responses

🟢201Created
application/json
Environment created successfully
Body

🟠400Bad Request
🟠401Unauthorized
🟠402Payment Required
🟠409Conflict
🔴503Service Unavailable
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location --request POST 'https://cloudcli.ai/api/v1/environments' \
--header 'X-API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "My Project",
    "subdomain": "myproject-abc123"
}'
Response Response Example
201 - Example 1
{
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "My Backend API",
    "subdomain": "mybackend-abc123",
    "access_url": "https://mybackend-abc123.cloudcli.ai",
    "status": "running",
    "github_url": "https://github.com/username/repo",
    "created_at": "2019-08-24T14:15:22.123Z"
}
Modified at 2026-04-24 15:35:18
Previous
Get environment
Next
Delete environment
Built with