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

# Dedicated Get Endpoint

> Retrieve the full specification of a Friendli Dedicated Endpoint by ID, including model config, GPU type, replica count, and deployment settings.

Given an endpoint ID, return its specification.

To request successfully, it is mandatory to enter a **Personal API Key** (e.g. flp\_XXX) value in the **Bearer Token** field.
Refer to the [authentication section](/openapi/introduction#authentication) on our introduction page to learn how to acquire this variable and [visit here](https://friendli.ai/suite/~/setting/keys) to generate your API Key.

<Info>
  This API is currently in **Beta**.
  While we strive to provide a stable and reliable experience, this feature is still under active development.
  As a result, you may encounter unexpected behavior or limitations.
  We encourage you to provide feedback to help us improve the feature before its official release.

  * [Feature request & feedback](mailto:support@friendli.ai)
  * [Contact support](mailto:support@friendli.ai)
</Info>


## OpenAPI

````yaml https://github.com/friendliai/friendli-openapi/raw/refs/heads/main/openapi.yaml get /dedicated/beta/endpoint/{endpoint_id}
openapi: 3.1.0
info:
  title: Friendli Suite API Reference
  description: This is an OpenAPI reference of Friendli Suite API.
  termsOfService: https://friendli.ai/terms-of-service
  contact:
    name: FriendliAI Support Team
    email: support@friendli.ai
  version: 0.1.0
servers:
  - url: https://api.friendli.ai
security: []
tags:
  - name: Serverless.Chat
  - name: Serverless.ToolAssistedChat
  - name: Serverless.Messages
  - name: Serverless.ChatRender
  - name: Serverless.Completions
  - name: Serverless.Token
  - name: Serverless.Audio
  - name: Serverless.Model
  - name: Serverless.Knowledge
  - name: Dedicated.Chat
  - name: Dedicated.Messages
  - name: Dedicated.ChatRender
  - name: Dedicated.Completions
  - name: Dedicated.Embeddings
  - name: Dedicated.TextClassification
  - name: Dedicated.Token
  - name: Dedicated.Image
  - name: Dedicated.Audio
  - name: Dedicated.Endpoint
  - name: Container.Chat
  - name: Container.Messages
  - name: Container.Completions
  - name: Container.TextClassification
  - name: Container.Token
  - name: Container.Image
  - name: Container.Audio
  - name: Cost
  - name: Dataset
  - name: File
paths:
  /dedicated/beta/endpoint/{endpoint_id}:
    get:
      tags:
        - Dedicated.Endpoint
      summary: Get endpoint specification
      description: Get the specification of an endpoint
      operationId: dedicatedGetEndpoint
      parameters:
        - name: endpoint_id
          in: path
          required: true
          schema:
            type: string
            description: The ID of the endpoint
            title: Endpoint Id
          description: The ID of the endpoint
        - name: X-Friendli-Team
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: ID of team to run requests as (optional parameter).
            title: X-Friendli-Team
          description: ID of team to run requests as (optional parameter).
      responses:
        '200':
          description: Successfully retrieved the endpoint specification.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DedicatedEndpointSpec'
              examples:
                Example:
                  value:
                    name: endpoint-name
                    gpuType: NVIDIA H100
                    numGpu: 1
                    instanceId: instance-id
                    projectId: project-id
                    creatorId: creator-id
                    teamId: team-id
                    autoscalingMin: 0
                    autoscalingMax: 1
                    autoscalingCooldown: 300
                    maxBatchSize: 10
                    maxInputLength: 1024
                    tokenizerSkipSpecialTokens: true
                    tokenizerAddSpecialTokens: true
                    currReplicaCnt: 1
                    desiredReplicaCnt: 1
                    updatedReplicaCnt: 1
        '400':
          description: Bad Request
        '404':
          description: Not Found
        '422':
          description: Unprocessable Entity
      security:
        - token: []
components:
  schemas:
    DedicatedEndpointSpec:
      properties:
        name:
          type: string
          title: Name
          description: The name of the endpoint.
        gpuType:
          type: string
          title: GPU Type
          description: The type of GPU to use for the endpoint.
        numGpu:
          type: integer
          title: Number of GPUs
          description: The number of GPUs to use per replica.
        instanceId:
          anyOf:
            - type: string
            - type: 'null'
          title: Instance ID
          description: The ID of the instance.
        projectId:
          type: string
          title: Project ID
          description: The ID of the project that owns the endpoint.
        creatorId:
          type: string
          title: Creator ID
          description: The ID of the user who created the endpoint.
        teamId:
          type: string
          title: Team ID
          description: The ID of the team that owns the endpoint.
        autoscalingMin:
          type: integer
          title: Minimum Replicas
          description: The minimum number of replicas to maintain.
        autoscalingMax:
          type: integer
          title: Maximum Replicas
          description: The maximum number of replicas allowed.
        autoscalingCooldown:
          type: integer
          title: Autoscaling Cooldown
          description: The cooldown period in seconds between scaling operations.
        maxBatchSize:
          type: integer
          title: Maximum Batch Size
          description: The maximum batch size for inference requests.
        maxInputLength:
          anyOf:
            - type: integer
            - type: 'null'
          title: Maximum Input Length
          description: The maximum allowed input length.
        tokenizerSkipSpecialTokens:
          type: boolean
          title: Skip Special Tokens
          description: Whether to skip special tokens in tokenizer output.
        tokenizerAddSpecialTokens:
          type: boolean
          title: Add Special Tokens
          description: Whether to add special tokens in tokenizer input.
        currReplicaCnt:
          anyOf:
            - type: integer
            - type: 'null'
          title: Current Replica Count
          description: The current number of replicas.
        desiredReplicaCnt:
          anyOf:
            - type: integer
            - type: 'null'
          title: Desired Replica Count
          description: The desired number of replicas.
        updatedReplicaCnt:
          anyOf:
            - type: integer
            - type: 'null'
          title: Updated Replica Count
          description: The updated number of replicas.
      type: object
      required:
        - name
        - gpuType
        - numGpu
        - projectId
        - creatorId
        - teamId
        - autoscalingMin
        - autoscalingMax
        - autoscalingCooldown
        - maxBatchSize
        - tokenizerSkipSpecialTokens
        - tokenizerAddSpecialTokens
      title: DedicatedEndpointSpec
      description: Dedicated endpoint specification.
  securitySchemes:
    token:
      type: http
      description: >-
        When using Friendli Suite API for inference requests, you need to
        provide a **Personal API Key** for authentication and authorization
        purposes.


        For more detailed information, please refer
        [here](https://friendli.ai/docs/openapi/introduction#authentication).
      scheme: bearer

````