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

# Get Dedicated Deployment

> Get deployment details and all replicas.

Accepts either:
- User Bearer token — JWT is validated; user_id is taken from the token.
- INFERENCE_PROXY_SERVICE_TOKEN — service token; caller must supply X-User-Id header.

In both cases ownership is enforced: the deployment must belong to the resolved user_id.

If include_terminated is False (default), returns 404 for deployments whose status is
stopped. Set include_terminated=true to retrieve any deployment regardless of status.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v2/external/inference/get
openapi: 3.1.0
info:
  title: Lyceum Cloud Execution API
  version: 0.1.0
servers: []
security: []
paths:
  /api/v2/external/inference/get:
    get:
      tags:
        - Dedicated Inference
      summary: Get Dedicated Deployment
      description: >-
        Get deployment details and all replicas.


        Accepts either:

        - User Bearer token — JWT is validated; user_id is taken from the token.

        - INFERENCE_PROXY_SERVICE_TOKEN — service token; caller must supply
        X-User-Id header.


        In both cases ownership is enforced: the deployment must belong to the
        resolved user_id.


        If include_terminated is False (default), returns 404 for deployments
        whose status is

        stopped. Set include_terminated=true to retrieve any deployment
        regardless of status.
      operationId: get_dedicated_deployment_api_v2_external_inference_get_get
      parameters:
        - name: deployment_id
          in: query
          required: true
          schema:
            type: string
            title: Deployment Id
        - name: include_terminated
          in: query
          required: false
          schema:
            type: boolean
            default: false
            title: Include Terminated
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
        - name: X-User-Id
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-User-Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeployGetResp'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    DeployGetResp:
      properties:
        deployment_id:
          type: string
          format: uuid
          title: Deployment Id
        hf_model_id:
          type: string
          title: Hf Model Id
        hardware_profile:
          type: string
          title: Hardware Profile
        min_replicas:
          type: integer
          title: Min Replicas
        max_replicas:
          type: integer
          title: Max Replicas
        current_replicas:
          type: integer
          title: Current Replicas
        desired_replicas:
          anyOf:
            - type: integer
            - type: 'null'
          title: Desired Replicas
        target_rps:
          anyOf:
            - type: number
            - type: 'null'
          title: Target Rps
        target_latency_p95_ms:
          anyOf:
            - type: number
            - type: 'null'
          title: Target Latency P95 Ms
        stabilisation_window:
          anyOf:
            - type: integer
            - type: 'null'
          title: Stabilisation Window
        status:
          type: string
          title: Status
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
        replicas:
          items:
            $ref: '#/components/schemas/DeployReplicaInfo'
          type: array
          title: Replicas
      type: object
      required:
        - deployment_id
        - hf_model_id
        - hardware_profile
        - min_replicas
        - max_replicas
        - current_replicas
        - status
        - created_at
        - updated_at
        - replicas
      title: DeployGetResp
      description: Response body for GET /api/v2/external/inference/get.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    DeployReplicaInfo:
      properties:
        replica_id:
          type: string
          format: uuid
          title: Replica Id
        status:
          type: string
          title: Status
        healthy:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Healthy
        last_health_check:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Health Check
        node_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Node Id
        fail_reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Fail Reason
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
      type: object
      required:
        - replica_id
        - status
        - created_at
        - updated_at
      title: DeployReplicaInfo
      description: Details of a single replica within a dedicated deployment.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````