> ## 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.

# Internal

> Internal SDK helpers, including utilities for resolving entity IDs from FQNs.

## Methods

<Accordion title="get_id_from_fqn">
  Get IDs associated with the FQN for various entity types, such as deployment, application, workspace, or cluster.

  #### Parameters

  <ParamField body="type" type="str" required>
    Entity Type
  </ParamField>

  <ParamField body="fqn" type="str" required>
    Entity FQN
  </ParamField>

  #### Returns

  <ResponseField name="typing.Dict[str, typing.Any]" type="typing.Dict[str, typing.Any]">
    Returns the IDs for the specified entity type based on the provided FQN. For example, deploymentId, applicationId, and workspaceId for type deployment, or applicationId and workspaceId for type app.
  </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.internal.get_id_from_fqn(
      type="value",
      fqn="value",
  )
  ```
</Accordion>

<Accordion title="users">
  #### 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.internal.users(
  )
  ```
</Accordion>

<Accordion title="ai_gateway">
  #### 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.internal.ai_gateway(
  )
  ```
</Accordion>

<Accordion title="clusters">
  #### 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.internal.clusters(
  )
  ```
</Accordion>

<Accordion title="deployments">
  #### 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.internal.deployments(
  )
  ```
</Accordion>

<Accordion title="applications">
  #### 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.internal.applications(
  )
  ```
</Accordion>

<Accordion title="metrics">
  #### 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.internal.metrics(
  )
  ```
</Accordion>

<Accordion title="vcs">
  #### 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.internal.vcs(
  )
  ```
</Accordion>

<Accordion title="docker_registries">
  #### 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.internal.docker_registries(
  )
  ```
</Accordion>

<Accordion title="workflows">
  #### 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.internal.workflows(
  )
  ```
</Accordion>

<Accordion title="build_logs">
  #### 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.internal.build_logs(
  )
  ```
</Accordion>

<Accordion title="artifact_versions">
  #### 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.internal.artifact_versions(
  )
  ```
</Accordion>

<Accordion title="ml">
  #### 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.internal.ml(
  )
  ```
</Accordion>
