Python SDK

IntroCopy Anchor Link

The Axiom Cloud API SDK provides access to the Axiom Cloud API REST APIs.

API documentation for Axiom Cloud platform services.

Authentication: All endpoints require a Bearer token (API key) passed via the Authorization header.

InstallationCopy Anchor Link

Add the SDK to your project from its folder, with whichever package manager your project uses. Give each tool a path containing a slash, such as ../axiom-cloud-api — a bare folder name is looked up on PyPI instead, and resolves to whatever project holds that name there:

pip install <path-to-sdk>

uv add <path-to-sdk>

poetry add <path-to-sdk>

Quick StartCopy Anchor Link

Synchronous clientCopy Anchor Link

Construct AxiomCloudApiClient with keyword arguments, and call close() when you are done. Every argument is optional.

from axiom_cloud_api import AxiomCloudApiClient

client = AxiomCloudApiClient(bearer_auth="YOUR_BEARER_TOKEN")

client.close()

Alternatively, scope it — with AxiomCloudApiClient(...) as client: closes the pool on exit.

Asynchronous clientCopy Anchor Link

AsyncAxiomCloudApiClient mirrors AxiomCloudApiClient with identical method names, and every endpoint method is a coroutine. It takes the same arguments, with some differences — for example, the transport argument is custom_async_http_client.

from asyncio import run

from axiom_cloud_api import AsyncAxiomCloudApiClient


async def main() -> None:
    client = AsyncAxiomCloudApiClient(bearer_auth="YOUR_BEARER_TOKEN")
    await client.aclose()


run(main())

Alternatively, scope it — async with AsyncAxiomCloudApiClient(...) as client: closes the pool on exit.