---
title: "Get endpoint specification"
method: GET
path: "/dedicated/beta/endpoint/{endpoint_id}"
tags: ["Dedicated.Endpoint"]
---

# Get endpoint specification

`GET /dedicated/beta/endpoint/{endpoint_id}`

## Request

- Base URL: `https://api.friendli.ai`
- URL: `https://api.friendli.ai/dedicated/beta/endpoint/{endpoint_id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/friendli/apis/friendli-suite-api-reference/docs/dedicated/beta/endpoint/:endpoint_id/get.ts> (a function with typed inputs; its response is checked against the schema)

Get the specification of an endpoint

## Path parameters

- `endpoint_id` string, required: The ID of the endpoint

## Headers

- `X-Friendli-Team` string, nullable: ID of team to run requests as (optional parameter).

## Response `200`

Successfully retrieved the endpoint specification.

- DedicatedEndpointSpec: Dedicated endpoint specification.
  - `name` string, required: The name of the endpoint.
  - `gpuType` string, required: The type of GPU to use for the endpoint.
  - `numGpu` integer, required: The number of GPUs to use per replica.
  - `instanceId` string, nullable: The ID of the instance.
  - `projectId` string, required: The ID of the project that owns the endpoint.
  - `creatorId` string, required: The ID of the user who created the endpoint.
  - `teamId` string, required: The ID of the team that owns the endpoint.
  - `autoscalingMin` integer, required: The minimum number of replicas to maintain.
  - `autoscalingMax` integer, required: The maximum number of replicas allowed.
  - `autoscalingCooldown` integer, required: The cooldown period in seconds between scaling operations.
  - `maxBatchSize` integer, required: The maximum batch size for inference requests.
  - `maxInputLength` integer, nullable: The maximum allowed input length.
  - `tokenizerSkipSpecialTokens` boolean, required: Whether to skip special tokens in tokenizer output.
  - `tokenizerAddSpecialTokens` boolean, required: Whether to add special tokens in tokenizer input.
  - `currReplicaCnt` integer, nullable: The current number of replicas.
  - `desiredReplicaCnt` integer, nullable: The desired number of replicas.
  - `updatedReplicaCnt` integer, nullable: The updated number of replicas.

## Other responses

- `400`: Bad Request
- `404`: Not Found
- `422`: Unprocessable Entity

---

[API](https://skmtc.dev/friendli/apis/friendli-suite-api-reference.md) - [All operations](https://skmtc.dev/friendli/apis/friendli-suite-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/friendli/apis/friendli-suite-api-reference/revisions/38fb43993a11?raw)