Truefoundry Docs

On this page

Client Methods

The main client for TrueFoundry SDK operations. This client provides access to all SDK functionality through organized sub-clients.

Client Methods

apply

Applies a given manifest to create or update resources of specific types, such as provider-account, cluster, workspace, or ml-repo.

Parameters

manifest

TrueFoundryApplyRequestManifest

required

🔗 TrueFoundryApplyRequestManifestmanifest of the resource to be created or updated

dry_run

typing.Optional[bool]

Dry run the apply operation without actually applying

Returns

TrueFoundryApplyResponse

🔗 TrueFoundryApplyResponseThe resource has been successfully created or updated.

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.apply(
    manifest={"key": "value"},
    dry_run=False,
)

delete

Deletes resources of specific types, such as provider-account, cluster, workspace, or application.

Parameters

manifest

TrueFoundryDeleteRequestManifest

required

🔗 TrueFoundryDeleteRequestManifestmanifest of the resource to be deleted

Returns

None

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.delete(
    manifest={"key": "value"},
)

TrueFoundry SDK

Clusters

Workspaces

MLRepos

Applications

Jobs

Models

Artifacts

Prompts

Secret Groups

Secrets

Model Deployments

Users

Teams

Personal Access Tokens

Virtual Accounts

Logs

Audit Logs

Apply

TrueFoundry Client

Client Methods

Parameters

Returns

Usage

Parameters

Returns

Usage

TrueFoundry SDK

Clusters

Workspaces

MLRepos

Applications

Jobs

Models

Artifacts

Prompts

Secret Groups

Secrets

Model Deployments

Users

Teams

Personal Access Tokens

Virtual Accounts

Logs

Audit Logs

Apply

​Client Methods

Client Methods