Artifacts

SDK methods to register, list, retrieve, and manage artifacts in the TrueFoundry registry.

Methods

get

Get an artifact by its ID.

Parameters

id · str · required

Returns

GetArtifactResponse · GetArtifactResponse

🔗 GetArtifactResponse

The artifact data

Usage

from truefoundry import TrueFoundry

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

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

delete

Delete an artifact by its ID.

Parameters

id · str · required

Returns

EmptyResponse · EmptyResponse

🔗 EmptyResponse

Empty response indicating successful deletion

Usage

from truefoundry import TrueFoundry

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

client.artifacts.delete(
    id="id_value",
)

list

List artifacts with optional filtering by FQN, ML Repo, name, or run ID.

Parameters

fqn · typing.Optional[str]

Fully qualified name to filter artifacts by (format: ’://’)

ml_repo_id · typing.Optional[str]

ID of the ML Repo to filter artifacts by

name · typing.Optional[str]

Name of the artifact to filter by

offset · typing.Optional[int]

Number of artifacts to skip for pagination

limit · typing.Optional[int]

Maximum number of artifacts to return

run_id · typing.Optional[str]

ID of the run to filter artifacts by

include_empty_artifacts · typing.Optional[bool]

Whether to include artifacts that have no versions

Returns

SyncPager[Artifact, ListArtifactsResponse] · SyncPager[Artifact, ListArtifactsResponse]

🔗 ListArtifactsResponse

List of artifacts matching the query with pagination information

Usage

from truefoundry import TrueFoundry

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

client.artifacts.list(
    fqn="value",
    ml_repo_id="value",
    name="value",
    offset=10,
    limit=10,
    run_id="value",
    include_empty_artifacts="value",
)

# 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

Create or update an artifact version.

Parameters

manifest · ArtifactManifest · required

🔗 ArtifactManifest

Manifest containing metadata for the artifact to apply

Returns

GetArtifactVersionResponse · GetArtifactVersionResponse

🔗 GetArtifactVersionResponse

The created or updated artifact version

Usage

from truefoundry import TrueFoundry

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

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

get_by_fqn

Get Artifact by FQN.

Parameters

fqn · str · required

FQN of the artifact

Returns

GetArtifactResponse · GetArtifactResponse

🔗 GetArtifactResponse

Artifact details

Usage

from truefoundry import TrueFoundry

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

client.artifacts.get_by_fqn(
    fqn="value",
)