> ## Documentation Index
> Fetch the complete documentation index at: https://www.truefoundry.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Model Versions

> SDK methods to list, fetch, tag, and manage versions of models registered in TrueFoundry.

## Methods

<Accordion title="apply_tags">
  Apply tags to a model version.

  #### Parameters

  <ParamField body="model_version_id" type="str" required>
    ID of the model version to apply tags to
  </ParamField>

  <ParamField body="tags" type="typing.Sequence[str]" required>
    List of tags to apply to the model version
  </ParamField>

  <ParamField body="force" type="typing.Optional[bool]">
    Whether to overwrite existing tags if they conflict
  </ParamField>

  #### Returns

  <ResponseField name="EmptyResponse" type="EmptyResponse">
    [🔗 EmptyResponse](/docs/truefoundry_sdk/types#emptyresponse)

    Empty response indicating successful tag application
  </ResponseField>

  #### Usage

  ```python lines theme={"dark"}
  from truefoundry import TrueFoundry

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

  client.model_versions.apply_tags(
      model_version_id="value",
      tags="value",
      force="value",
  )
  ```
</Accordion>

<Accordion title="get">
  Get a model version by its ID.

  #### Parameters

  <ParamField body="id" type="str" required />

  #### Returns

  <ResponseField name="GetModelVersionResponse" type="GetModelVersionResponse">
    [🔗 GetModelVersionResponse](/docs/truefoundry_sdk/types#getmodelversionresponse)

    The model version data
  </ResponseField>

  #### Usage

  ```python lines theme={"dark"}
  from truefoundry import TrueFoundry

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

  client.model_versions.get(
      id="id_value",
  )
  ```
</Accordion>

<Accordion title="delete">
  Delete a model version by its ID.

  #### Parameters

  <ParamField body="id" type="str" required />

  #### Returns

  <ResponseField name="EmptyResponse" type="EmptyResponse">
    [🔗 EmptyResponse](/docs/truefoundry_sdk/types#emptyresponse)

    Empty response indicating successful deletion
  </ResponseField>

  #### Usage

  ```python lines theme={"dark"}
  from truefoundry import TrueFoundry

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

  client.model_versions.delete(
      id="id_value",
  )
  ```
</Accordion>

<Accordion title="list">
  List model versions with optional filtering by tag, FQN, model ID, ML Repo, name, version, run IDs, or run steps.

  #### Parameters

  <ParamField body="tag" type="typing.Optional[str]">
    Tag to filter model versions by
  </ParamField>

  <ParamField body="fqn" type="typing.Optional[str]">
    Fully qualified name to filter model versions by (format: 'model:{tenant_name}/{ml_repo_name}/{model_name}' or 'model:{tenant_name}/{ml_repo_name}/{model_name}:{version}')
  </ParamField>

  <ParamField body="model_id" type="typing.Optional[str]">
    ID of the model to filter versions by
  </ParamField>

  <ParamField body="ml_repo_id" type="typing.Optional[str]">
    ID of the ML Repo to filter model versions by
  </ParamField>

  <ParamField body="name" type="typing.Optional[str]">
    Name of the model to filter versions by
  </ParamField>

  <ParamField body="version" type="typing.Optional[int]">
    Version number (positive integer) or 'latest' to filter by specific version
  </ParamField>

  <ParamField body="run_ids" type="typing.Optional[typing.Union[str, typing.Sequence[str]]]">
    List of run IDs to filter model versions by
  </ParamField>

  <ParamField body="run_steps" type="typing.Optional[typing.Union[int, typing.Sequence[int]]]">
    List of run step numbers to filter model versions by
  </ParamField>

  <ParamField body="offset" type="typing.Optional[int]">
    Number of model versions to skip for pagination
  </ParamField>

  <ParamField body="limit" type="typing.Optional[int]">
    Maximum number of model versions to return
  </ParamField>

  <ParamField body="include_internal_metadata" type="typing.Optional[bool]">
    Whether to include internal metadata in the response
  </ParamField>

  #### Returns

  <ResponseField name="SyncPager[ModelVersion, ListModelVersionsResponse]" type="SyncPager[ModelVersion, ListModelVersionsResponse]">
    [🔗 ListModelVersionsResponse](/docs/truefoundry_sdk/types#listmodelversionsresponse)

    List of model versions matching the query with pagination information
  </ResponseField>

  #### Usage

  ```python lines theme={"dark"}
  from truefoundry import TrueFoundry

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

  client.model_versions.list(
      tag="value",
      fqn="value",
      model_id="value",
      ml_repo_id="value",
      name="value",
      version="value",
      run_ids="value",
      run_steps="value",
      offset=10,
      limit=10,
      include_internal_metadata="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)
  ```
</Accordion>

<Accordion title="get_by_fqn">
  Get Model Version by FQN.

  #### Parameters

  <ParamField body="fqn" type="str" required>
    FQN of the model version
  </ParamField>

  #### Returns

  <ResponseField name="GetModelVersionResponse" type="GetModelVersionResponse">
    [🔗 GetModelVersionResponse](/docs/truefoundry_sdk/types#getmodelversionresponse)

    Model version details
  </ResponseField>

  #### Usage

  ```python lines theme={"dark"}
  from truefoundry import TrueFoundry

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

  client.model_versions.get_by_fqn(
      fqn="value",
  )
  ```
</Accordion>