Client APIs

The following reference provides detailed documentation for the synchronous and asynchronous clients of the NeMo Platform Python SDK.

Synchronous Client

Use nemo_platform.NeMoPlatform from regular Python code when you want blocking API calls. The client reads the active CLI context by default, including the base URL, workspace, and authentication settings configured by nemo auth login.

1
from nemo_platform import NeMoPlatform
2
3
client = NeMoPlatform()
4
5
for workspace in client.workspaces.list().data:
6
    print(workspace.name)

Constructor

1
NeMoPlatform(
2
    *,
3
    workspace: str | None = None,
4
    base_url: str | httpx.URL | None = None,
5
    inference_base_url: str | httpx.URL | None = None,
6
    config_path: pathlib.Path | None = None,
7
    context_name: str | None = None,
8
    access_token: str | None = None,
9
    timeout: float | httpx.Timeout | None = not_given,
10
    max_retries: int = DEFAULT_MAX_RETRIES,
11
    default_headers: Mapping[str, str] | None = None,
12
    default_query: Mapping[str, object] | None = None,
13
    http_client: httpx.Client | None = None,
14
)

Connection Modes

Use with_options(...) to clone a client with request defaults changed:

1
short_timeout_client = client.with_options(timeout=10.0)

Asynchronous Client

Use nemo_platform.AsyncNeMoPlatform from asyncio applications. It exposes the same resource tree as NeMoPlatform, but API methods are awaited.

1
import asyncio
2
3
from nemo_platform import AsyncNeMoPlatform
4
5
6
async def main() -> None:
7
    client = AsyncNeMoPlatform()
8
    page = await client.workspaces.list()
9
    for workspace in page.data:
10
        print(workspace.name)
11
12
13
asyncio.run(main())

Async client constructor

1
AsyncNeMoPlatform(
2
    *,
3
    workspace: str | None = None,
4
    base_url: str | httpx.URL | None = None,
5
    inference_base_url: str | httpx.URL | None = None,
6
    config_path: pathlib.Path | None = None,
7
    context_name: str | None = None,
8
    access_token: str | None = None,
9
    timeout: float | httpx.Timeout | None = not_given,
10
    max_retries: int = DEFAULT_MAX_RETRIES,
11
    default_headers: Mapping[str, str] | None = None,
12
    default_query: Mapping[str, object] | None = None,
13
    http_client: httpx.AsyncClient | None = None,
14
)

AsyncNeMoPlatform accepts the same connection and authentication parameters as NeMoPlatform. Pass a custom httpx.AsyncClient through http_client only when you need to control the underlying transport directly.

1
import os
2
3
from nemo_platform import AsyncNeMoPlatform
4
5
client = AsyncNeMoPlatform(
6
    base_url=os.environ["NMP_BASE_URL"],
7
    access_token=os.environ["NMP_ACCESS_TOKEN"],
8
    workspace="default",
9
)

Errors

Client construction raises RuntimeError if configuration or authentication bootstrap fails. Workspace-scoped methods raise ValueError when no workspace is provided on the client or method call.

API calls raise typed exceptions from nemo_platform, including:

Catch APIStatusError for all non-success HTTP responses, or NeMoPlatformError for SDK-level errors.

Client Attributes

The NeMo Platform clients provide access to API resources through the following attributes. For endpoint details, see the REST API Reference.

Organization

• workspaces: Manage workspaces
• projects: Manage projects within a workspace

Model Management

• models: Model entity CRUD
• evaluation: Benchmarks, benchmark jobs, metrics, and metric jobs
• inference: Deployments, deployment configs, providers, and OpenAI-compatible gateway

Data & Synthesis

• data_designer: Synthetic data generation jobs
• safe_synthesizer: PII replacement and safe data synthesis jobs
• files: File upload and download

Safety & Compliance

• guardrail: Guardrail configurations and checks
• audit: Model safety audit jobs and configs

Platform

• jobs: Cross-service job management
• entities: Generic entity CRUD
• secrets: Secret management
• iam: Identity and access management
• workspaces.members: Workspace member and RBAC management

Response Handling

• with_raw_response: Access raw HTTP response data
• with_streaming_response: Handle streaming responses