Typed Python client for the American Cloud public API.
This SDK is auto-generated from the OpenAPI specification using Fern. It targets American Cloud API v1 — see VERSIONING.md for how SDK releases track the API.
pip install americancloudEvery request requires both parts of an American Cloud API key, sent as headers:
| Header | SDK option |
|---|---|
X-API-Client-ID |
api_key |
X-API-Client-Secret |
api_client_secret |
Create and manage keys at console.americancloud.com/api-keys. The client secret is shown once at creation — store it securely. If lost, revoke the key and create a new one.
Each key is scoped at creation:
read-only—GETendpoints onlyread-write— full access to all resource management endpoints
import os
from americancloud import AmericancloudApi
client = AmericancloudApi(
api_key=os.environ["AMERICANCLOUD_API_CLIENT_ID"],
api_client_secret=os.environ["AMERICANCLOUD_API_CLIENT_SECRET"],
)
vms = client.vms.list_vms()
print(vms)import asyncio
import os
from americancloud import AsyncAmericancloudApi
async def main():
client = AsyncAmericancloudApi(
api_key=os.environ["AMERICANCLOUD_API_CLIENT_ID"],
api_client_secret=os.environ["AMERICANCLOUD_API_CLIENT_SECRET"],
)
vms = await client.vms.list_vms()
print(vms)
asyncio.run(main())The client is namespaced by resource — client.vms, client.block_storage, client.kubernetes, client.dns_zones, etc.
The SDK targets the American Cloud production API at https://api.americancloud.com by default. To override (e.g. for a self-hosted or internal environment), pass base_url:
client = AmericancloudApi(
api_key="...",
api_client_secret="...",
base_url="https://your-custom-endpoint.example.com",
)- Full reference + code samples: americancloud.com/docs/api
- Interactive Swagger UI: api.americancloud.com/api-v1
Narrative walkthroughs on the American Cloud docs site:
- Python SDK quickstart — install, authenticate, estimate cost, then create a VM (sync and async), with error handling and pagination
- SDKs & Terraform overview — when to reach for an SDK, Terraform, or the MCP server
- Deploy with AI — let an AI assistant build and ship to American Cloud
The SDK version matches the API platform version it was generated from — SDK x.y.z is generated from OpenAPI document x.y.z, so the SDK↔API mapping is one-to-one by construction:
- Patch / minor releases are backward-compatible — safe to upgrade.
- Major releases track a new API URL version (
/api/v2) and may require code changes; check theCHANGELOGfirst. - The
1.xline targets APIv1, which remains available for at least six months after av2release. - Additive API changes (new endpoints, optional fields, enum values) ship within a version — tolerate unknown fields and new enum values gracefully.
See VERSIONING.md for the full policy.
Open an issue against this repository, or contact American Cloud support.
This SDK is generated — do not edit the source by hand. See CONTRIBUTING.md for the generation workflow.
