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

# Get a deployment adapter

> Gets an adapter attachment by its `dad_` id and returns its per-cluster load state.



## OpenAPI

````yaml openapi.yaml GET /v2/projects/{projectId}/endpoints/{endpointId}/deployments/{deploymentId}/adapters/{id}
openapi: 3.1.0
info:
  title: Together APIs
  description: The Together REST API. See https://docs.together.ai for more details.
  version: 2.0.0
  termsOfService: https://www.together.ai/terms-of-service
  contact:
    name: Together Support
    url: https://www.together.ai/contact
  license:
    name: MIT
    url: https://github.com/togethercomputer/openapi/blob/main/LICENSE
servers:
  - url: https://api.together.ai
    description: Default environment for APIs
security:
  - bearerAuth: []
paths:
  /v2/projects/{projectId}/endpoints/{endpointId}/deployments/{deploymentId}/adapters/{id}:
    get:
      tags:
        - DeploymentService
      summary: Get a deployment adapter
      description: >-
        Gets an adapter attachment by its `dad_` id and returns its per-cluster
        load state.
      operationId: DeploymentService_GetAdapter
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
            description: Project identifier.
        - name: endpointId
          in: path
          required: true
          schema:
            description: Endpoint identifier.
            type: string
        - name: deploymentId
          in: path
          required: true
          schema:
            description: Deployment identifier.
            type: string
        - name: id
          in: path
          required: true
          schema:
            description: >-
              Adapter attachment `dad_` id from a prior add, update, get, or
              list response.
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DE.AdapterEntry'
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorData'
      x-codeSamples:
        - lang: Python
          label: Together AI SDK (Python)
          source: |
            from together import Together

            client = Together()
            identity = client.whoami()
            if identity.type != "project_api_key":
                raise RuntimeError("TOGETHER_API_KEY must be a project API key")
            project_id = identity.project.id

            adapter = client.endpoints.adapters.retrieve(
                "dad_abc123",
                project_id=project_id,
                endpoint_id="ep_abc123",
                deployment_id="dep_abc123",
            )
            print(adapter)
        - lang: TypeScript
          label: Together AI SDK (TypeScript)
          source: >
            import Together from "together-ai";


            const client = new Together();

            const identity = await client.whoami();

            if (identity.type !== "project_api_key") {
              throw new Error("TOGETHER_API_KEY must be a project API key");
            }

            const projectId = identity.project.id;


            const adapter = await
            client.endpoints.adapters.retrieve("dad_abc123", {
              projectId,
              endpointId: "ep_abc123",
              deploymentId: "dep_abc123",
            });

            console.log(adapter);
        - lang: JavaScript
          label: Together AI SDK (JavaScript)
          source: >
            import Together from "together-ai";


            const client = new Together();

            const identity = await client.whoami();

            if (identity.type !== "project_api_key") {
              throw new Error("TOGETHER_API_KEY must be a project API key");
            }

            const projectId = identity.project.id;


            const adapter = await
            client.endpoints.adapters.retrieve("dad_abc123", {
              projectId,
              endpointId: "ep_abc123",
              deploymentId: "dep_abc123",
            });

            console.log(adapter);
components:
  schemas:
    DE.AdapterEntry:
      type: object
      description: >-
        Adapter attached to a deployment with desired revision and observed load
        state.
      required:
        - adapterModelId
        - desiredRevisionId
        - perCluster
        - etag
        - id
      properties:
        adapterModelId:
          type: string
          description: Adapter model identifier attached to the deployment.
        desiredRevisionId:
          type: string
          description: Adapter revision pinned on the deployment.
        perCluster:
          type: array
          items:
            $ref: '#/components/schemas/DE.DeploymentAdapterStatus'
          description: Per-cluster adapter load state reported by the controller.
        etag:
          type: string
          description: Row-level etag required for UpdateAdapter and RemoveAdapter.
        adapterModel:
          type: string
          description: >-
            Resource name of the adapter model, using
            projects/{projectId}/models/{adapterModelId}.
        desiredRevision:
          type: string
          description: >-
            Resource name of the adapter model revision pinned on the
            deployment, using
            projects/{projectId}/models/{adapterModelId}/revisions/{revisionId}.
        id:
          type: string
          description: >-
            Adapter attachment `dad_` id used by get, update, and remove; stale
            ids never address a replacement after remove and re-add.
    ErrorData:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          properties:
            message:
              type: string
              nullable: false
            type:
              type: string
              nullable: false
            param:
              type: string
              nullable: true
              default: null
            code:
              type: string
              nullable: true
              default: null
          required:
            - type
            - message
    DE.DeploymentAdapterStatus:
      type: object
      description: Controller-reported load state for an adapter on one deployment cluster.
      required:
        - adapterModelId
        - clusterId
        - state
        - readyPodCount
        - failedPodCount
        - totalPodCount
      properties:
        adapterModelId:
          type: string
          description: Adapter model identifier for this status row.
        clusterId:
          type: string
          description: Cluster reporting this adapter status.
        realizedRevisionId:
          type: string
          description: Adapter revision currently loaded on pods in this cluster.
        realizedEtag:
          type: string
          description: >-
            Adapter row etag observed by the controller when it wrote this
            status.
        state:
          enum:
            - ADAPTER_LOAD_STATE_PENDING
            - ADAPTER_LOAD_STATE_LOADING
            - ADAPTER_LOAD_STATE_READY
            - ADAPTER_LOAD_STATE_REMOVING
            - ADAPTER_LOAD_STATE_FAILED
          type: string
          description: Current adapter load state in this cluster.
        reason:
          type: string
          description: Stable reason code for the current adapter state.
        message:
          type: string
          description: Human-readable details about the current adapter state.
        readyPodCount:
          type: integer
          description: Number of pods with the adapter ready to serve.
        failedPodCount:
          type: integer
          description: Number of pods that failed to load the adapter.
        totalPodCount:
          type: integer
          description: Total pods expected to report adapter load state.
        loadedAt:
          type: string
          description: Time when the adapter first reached READY in this cluster.
          format: date-time
        updatedAt:
          type: string
          description: Time when this adapter status was last updated.
          format: date-time
        adapterModel:
          type: string
          description: >-
            Resource name of the adapter model, using
            projects/{projectId}/models/{adapterModelId}.
        realizedRevision:
          type: string
          description: >-
            Resource name of the adapter model revision currently loaded in this
            cluster, using
            projects/{projectId}/models/{adapterModelId}/revisions/{revisionId}.
        adapterValid:
          type: boolean
          description: >-
            Optional inference-probe verdict for this adapter on this cluster;
            absent until validation concludes.
        adapterValidReason:
          type: string
          description: Human-readable probe rejection detail when adapterValid is false.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      x-bearer-format: bearer
      x-default: default

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.