Truefoundry Docs

On this page

Methods

Methods

list

List virtual accounts for the tenant.

Parameters

limit

typing.Optional[int]

Number of items per page

offset

typing.Optional[int]

Number of items to skip

Returns

🔗 VirtualAccountReturn all virtual accounts for the tenant

Usage

from truefoundry import TrueFoundry

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

client.virtual_accounts.list(
    limit=10,
    offset=10,
)

# Iterate through results
for item in response:
    print(item.name)

# Or paginate page by page
for page in response.iter_pages():
    for item in page:
        print(item.name)

create_or_update

Creates a new virtual account or updates an existing one based on the provided manifest.

Parameters

manifest

VirtualAccountManifest

required

🔗 VirtualAccountManifestVirtual account manifest

dry_run

typing.Optional[bool]

Dry run

Returns

GetVirtualAccountResponse

🔗 GetVirtualAccountResponseVirtual account created/updated successfully

Usage

from truefoundry import TrueFoundry

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

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

get

Get virtual account by id

Parameters

str

required

serviceaccount id

Returns

GetVirtualAccountResponse

🔗 GetVirtualAccountResponseReturns the virtual account associated with the provided virtual account id

Usage

from truefoundry import TrueFoundry

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

client.virtual_accounts.get(
    id="id_value",
)

delete

Delete a virtual account associated with the provided virtual account id.

Parameters

str

required

serviceaccount id

Returns

DeleteVirtualAccountResponse

🔗 DeleteVirtualAccountResponseVirtual account deleted successfully

Usage

from truefoundry import TrueFoundry

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

client.virtual_accounts.delete(
    id="id_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

Virtual Accounts

Methods

Parameters

Returns

Usage

Parameters

Returns

Usage

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

​Methods

Methods