> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/dsx-air/sdk/v1-2-0-air-sdk/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/dsx-air/_mcp/server.

# air_sdk

NVIDIA Air SDK.

This is the API reference for the `air_sdk` package. Use the navigation
to browse individual modules:

* `endpoints` — per-resource docs (simulations, nodes, images, etc.)
* `const` — SDK constants and configuration values
* `exceptions` — error types raised by the SDK
* `types` — TypedDict and enum definitions used in API payloads

## Subpackages

* **[`endpoints`](/sdk/v1-2-0-air-sdk-endpoints)** - API endpoint modules....

## Submodules

* **[`types`](/sdk/v1-2-0-air-sdk-types)**
* **[`exceptions`](/sdk/v1-2-0-air-sdk-exceptions)** - SDK-specific exceptions
* **[`const`](/sdk/v1-2-0-air-sdk-const)** - Constants shared throughout the SDK.

## Classes

| Name                       | Description |
| -------------------------- | ----------- |
| [`AirApi`](#air_sdkairapi) | None        |

## Module Contents

```python
class air_sdk.AirApi(
    api_url: str = const.AIR_API_URL,
    authenticate: bool = True,
    api_key: str | None = None,
    username: str | None = None,
    password: str | None = None,
    bearer_token: str | None = None,
    auto_patch: bool = True
)
```

**Initialization:**

Initialize AirApi and optionally authenticate with a local NGC config.

For cleaner initialization, consider using one of the factory methods:

* AirApi.with_api_key()
* AirApi.with_device_login()
* AirApi.with_ngc_config()

```python
with_api_key(
    api_key: str,
    api_url: str = const.AIR_API_URL,
    auto_patch: bool = True
) -> AirApi
```

Initialize API with an explicit NGC API Key.

The `api_key` is also known as a Starfleet API Key, or 'SAK'.

```python
with_device_login(
    email: str,
    org_num: str,
    api_url: str = const.AIR_API_URL,
    auto_patch: bool = True
) -> AirApi
```

Initialize API with device login authentication.

```python
with_ngc_config(
    api_url: str = const.AIR_API_URL,
    auto_patch: bool = True
) -> AirApi
```

Initialize API using NGC config for authentication.

```python
auth_with_ngc_config() -> None
```

Authenticate with a local NGC config.

This method is called by the `AirApi` constructor if `authenticate` is `True`.

```python
checkpoints: CheckpointEndpointAPI
```

```python
histories: HistoryEndpointAPI
```

```python
images: ImageEndpointAPI
```

```python
image_shares: ImageShareEndpointAPI
```

```python
simulations: SimulationEndpointAPI
```

```python
systems: SystemEndpointAPI
```

```python
nodes: NodeEndpointAPI
```

```python
interfaces: InterfaceEndpointAPI
```

```python
breakouts: None
```

**Decorators**: `@abstractmethod`

Breakouts endpoint - not supported in current API version.

**Raises:**

NotImplementedError

```python
links: LinkEndpointAPI
```

```python
services: ServiceEndpointAPI
```

```python
simulation_interfaces: InterfaceEndpointAPI
```

```python
node_instructions: NodeInstructionEndpointAPI
```

```python
simulation_nodes: NodeEndpointAPI
```

```python
ztp_scripts: ZTPScriptEndpointAPI
```

```python
workers: WorkerEndpointAPI
```

```python
worker_client_certificates: WorkerClientCertificateEndpointAPI
```

```python
fleets: FleetEndpointAPI
```

```python
marketplace_demos: MarketplaceDemoEndpointAPI
```

```python
marketplace_demo_tags: MarketplaceDemoTagEndpointAPI
```

```python
ssh_keys: SSHKeyEndpointAPI
```

```python
trainings: TrainingEndpointAPI
```

```python
manifests: ManifestEndpointAPI
```

```python
cloud_inits: CloudInitEndpointAPI
```

Cloud-init endpoint for V2 backwards compatibility.

```python
user_configs: UserConfigEndpointAPI
```

```python
organizations: OrganizationEndpointAPI
```

Organization / Resource Budget endpoint.

```python
resource_budgets: OrganizationEndpointAPI
```

Resource Budget endpoint (alias for organizations).

```python
topologies: None
```

**Decorators**: `@abstractmethod`

Topologies endpoint - not supported in current API version.

**Raises:**

NotImplementedError

```python
api_tokens: None
```

**Decorators**: `@abstractmethod`

API Tokens endpoint - not supported in current API version.

**Raises:**

NotImplementedError

```python
permissions: None
```

**Decorators**: `@abstractmethod`

Permissions endpoint - not supported in current API version.

**Raises:**

NotImplementedError

```python
permission: None
```

**Decorators**: `@abstractmethod`

Permission endpoint - not supported in current API version.

**Raises:**

NotImplementedError

```python
accounts: None
```

**Decorators**: `@abstractmethod`

Accounts endpoint - not supported in current API version.

**Raises:**

NotImplementedError

```python
simulation: SimulationEndpointAPI
```

Deprecated alias for simulations (v1 backward compatibility).

```python
service: ServiceEndpointAPI
```

Deprecated alias for services (v1 backward compatibility).

```python
set_connect_timeout(t_delta: datetime.timedelta) -> None
```

```python
set_read_timeout(t_delta: datetime.timedelta) -> None
```

```python
set_page_size(n: int) -> None
```

Set the page size of paginated responses.

## Docs

- [air_sdk.const](https://docs.nvidia.com/dsx-air/sdk/v1-2-0-air-sdk-const.md)
- [air_sdk.endpoints](https://docs.nvidia.com/dsx-air/sdk/v1-2-0-air-sdk-endpoints.md)
- [air_sdk.endpoints.checkpoints](https://docs.nvidia.com/dsx-air/sdk/v1-2-0-air-sdk-endpoints-checkpoints.md)
- [air_sdk.endpoints.fleets](https://docs.nvidia.com/dsx-air/sdk/v1-2-0-air-sdk-endpoints-fleets.md)
- [air_sdk.endpoints.history](https://docs.nvidia.com/dsx-air/sdk/v1-2-0-air-sdk-endpoints-history.md)
- [air_sdk.endpoints.images](https://docs.nvidia.com/dsx-air/sdk/v1-2-0-air-sdk-endpoints-images.md)
- [air_sdk.endpoints.interfaces](https://docs.nvidia.com/dsx-air/sdk/v1-2-0-air-sdk-endpoints-interfaces.md)
- [air_sdk.endpoints.links](https://docs.nvidia.com/dsx-air/sdk/v1-2-0-air-sdk-endpoints-links.md)
- [air_sdk.endpoints.manifests](https://docs.nvidia.com/dsx-air/sdk/v1-2-0-air-sdk-endpoints-manifests.md)
- [air_sdk.endpoints.marketplace_demo_tags](https://docs.nvidia.com/dsx-air/sdk/v1-2-0-air-sdk-endpoints-marketplace-demo-tags.md)
- [air_sdk.endpoints.marketplace_demos](https://docs.nvidia.com/dsx-air/sdk/v1-2-0-air-sdk-endpoints-marketplace-demos.md)
- [air_sdk.endpoints.node_instructions](https://docs.nvidia.com/dsx-air/sdk/v1-2-0-air-sdk-endpoints-node-instructions.md)
- [air_sdk.endpoints.nodes](https://docs.nvidia.com/dsx-air/sdk/v1-2-0-air-sdk-endpoints-nodes.md)
- [air_sdk.endpoints.organizations](https://docs.nvidia.com/dsx-air/sdk/v1-2-0-air-sdk-endpoints-organizations.md)
- [air_sdk.endpoints.services](https://docs.nvidia.com/dsx-air/sdk/v1-2-0-air-sdk-endpoints-services.md)
- [air_sdk.endpoints.simulations](https://docs.nvidia.com/dsx-air/sdk/v1-2-0-air-sdk-endpoints-simulations.md)
- [air_sdk.endpoints.ssh_keys](https://docs.nvidia.com/dsx-air/sdk/v1-2-0-air-sdk-endpoints-ssh-keys.md)
- [air_sdk.endpoints.systems](https://docs.nvidia.com/dsx-air/sdk/v1-2-0-air-sdk-endpoints-systems.md)
- [air_sdk.endpoints.trainings](https://docs.nvidia.com/dsx-air/sdk/v1-2-0-air-sdk-endpoints-trainings.md)
- [air_sdk.endpoints.user_configs](https://docs.nvidia.com/dsx-air/sdk/v1-2-0-air-sdk-endpoints-user-configs.md)
- [air_sdk.endpoints.workers](https://docs.nvidia.com/dsx-air/sdk/v1-2-0-air-sdk-endpoints-workers.md)
- [air_sdk.endpoints.ztp_scripts](https://docs.nvidia.com/dsx-air/sdk/v1-2-0-air-sdk-endpoints-ztp-scripts.md)
- [air_sdk.exceptions](https://docs.nvidia.com/dsx-air/sdk/v1-2-0-air-sdk-exceptions.md)
- [air_sdk.types](https://docs.nvidia.com/dsx-air/sdk/v1-2-0-air-sdk-types.md)