FriendliAI Dedicated.Endpoint API
The Dedicated.Endpoint API from FriendliAI — 9 operation(s) for dedicated.endpoint.
OpenAPI Specification
openapi: 3.1.0
info:
title: Friendli Suite API Reference Container.Audio Dedicated.Endpoint API
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
tags:
- name: Dedicated.Endpoint
paths:
/dedicated/endpoint/wandb-artifact-create:
post:
tags:
- Dedicated.Endpoint
summary: Create endpoint from W&B artifact
description: Create an endpoint from Weights & Biases artifact. If the idempotency key is provided, the API will check if the endpoint already exists, and rollout the existing endpoint if it does. In such cases, the project id must be provided.
operationId: dedicatedEndpointWandbArtifactCreate
security:
- token: []
parameters:
- 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).
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DedicatedEndpointWandbArtifactCreateBody'
responses:
'200':
description: Successfully created the endpoint from W&B artifact.
content:
application/json:
schema:
$ref: '#/components/schemas/DedicatedEndpointWandbArtifactCreateResponse'
examples:
Example:
value:
endpointId: endpoint-id
endpointName: endpoint-name
projectId: project-id
projectName: project-name
teamId: team-id
teamName: team-name
'400':
description: Bad Request
'422':
description: Unprocessable Entity
x-speakeasy-name-override: wandbArtifactCreate
x-mint:
metadata:
title: Dedicated Create Endpoint from W&B Artifact
sidebarTitle: Create Endpoint from W&B Artifact
og:title: Dedicated Create Endpoint from W&B Artifact
description: Create a Friendli Dedicated Endpoint from a Weights & Biases artifact via the API. Deploy W&B-managed models directly to dedicated GPU hardware.
og:description: Create a Friendli Dedicated Endpoint from a Weights & Biases artifact via the API. Deploy W&B-managed models directly to dedicated GPU hardware.
href: /openapi/dedicated/endpoint/wandb-artifact-create
content: 'Create an endpoint from Weights & Biases artifact.
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.'
/dedicated/beta/endpoint:
post:
tags:
- Dedicated.Endpoint
summary: Create a new endpoint
description: Create a new endpoint and return its status
operationId: dedicatedCreateEndpoint
security:
- token: []
parameters:
- 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).
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DedicatedEndpointCreateBody'
responses:
'200':
description: Successfully created the endpoint.
content:
application/json:
schema:
$ref: '#/components/schemas/DedicatedEndpointStatus'
examples:
Example:
value:
status: INITIALIZING
createdAt: '2025-01-01T00:00:00Z'
updatedAt: '2025-01-01T00:00:00Z'
phase: DOWNLOADING_MODEL
'400':
description: Bad Request
'422':
description: Unprocessable Entity
'500':
description: Internal Server Error
x-speakeasy-name-override: create
x-mint:
metadata:
title: Dedicated Create Endpoint
sidebarTitle: Create an Endpoint with Hugging Face Model
og:title: Dedicated Create Endpoint
description: Create a Friendli Dedicated Endpoint deployment for a Hugging Face model via the API. Specify GPU type, replica count, and model configuration.
og:description: Create a Friendli Dedicated Endpoint deployment for a Hugging Face model via the API. Specify GPU type, replica count, and model configuration.
href: /openapi/dedicated/endpoint/create
content: 'Create a Dedicated Endpoint deployment for a Hugging Face model.
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>'
get:
tags:
- Dedicated.Endpoint
summary: List all endpoints
description: List all endpoint statuses
operationId: dedicatedListEndpoints
security:
- token: []
parameters:
- name: project_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: The ID of the project. If omitted, query all endpoints under the team.
default: ''
title: Project Id
description: The ID of the project. If omitted, query all endpoints under the team.
- name: cursor
in: query
required: false
schema:
anyOf:
- type: string
format: binary
- type: 'null'
description: Cursor for pagination
title: Cursor
description: Cursor for pagination
- name: limit
in: query
required: false
schema:
anyOf:
- type: integer
maximum: 100
minimum: 1
- type: 'null'
description: Limit of items per page
default: 20
title: Limit
description: Limit of items per page
- 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 listed endpoints.
content:
application/json:
schema:
$ref: '#/components/schemas/DedicatedEndpointListResponse'
examples:
Example:
value:
data:
endpoint-id-1:
status: INITIALIZING
createdAt: '2025-01-01T00:00:00Z'
updatedAt: '2025-01-01T00:00:00Z'
phase: DOWNLOADING_MODEL
endpoint-id-2:
status: RUNNING
createdAt: '2025-01-01T00:00:00Z'
updatedAt: '2025-01-01T00:00:00Z'
'400':
description: Bad Request
'422':
description: Unprocessable Entity
x-speakeasy-name-override: list
x-mint:
metadata:
title: Dedicated List Endpoints
sidebarTitle: List Endpoints
og:title: Dedicated List Endpoints
description: List all Friendli Dedicated Endpoint deployments in your project. Returns endpoint IDs, statuses, model names, and GPU configurations.
og:description: List all Friendli Dedicated Endpoint deployments in your project. Returns endpoint IDs, statuses, model names, and GPU configurations.
href: /openapi/dedicated/endpoint/list
content: 'List Dedicated Endpoint deployments.
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>'
/dedicated/beta/endpoint/{endpoint_id}:
get:
tags:
- Dedicated.Endpoint
summary: Get endpoint specification
description: Get the specification of an endpoint
operationId: dedicatedGetEndpoint
security:
- token: []
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
x-speakeasy-name-override: getSpec
x-mint:
metadata:
title: Dedicated Get Endpoint
sidebarTitle: Retrieve an Endpoint Specification
og:title: Dedicated Get Endpoint
description: Retrieve the full specification of a Friendli Dedicated Endpoint by ID, including model config, GPU type, replica count, and deployment settings.
og:description: Retrieve the full specification of a Friendli Dedicated Endpoint by ID, including model config, GPU type, replica count, and deployment settings.
href: /openapi/dedicated/endpoint/get-spec
content: '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>'
put:
tags:
- Dedicated.Endpoint
summary: Update endpoint spec
description: Update the specification of a specific endpoint
operationId: dedicatedUpdateEndpoint
security:
- token: []
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).
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DedicatedEndpointUpdateBody'
responses:
'200':
description: Successfully updated 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
x-speakeasy-name-override: update
x-mint:
metadata:
title: Dedicated Update Endpoint
sidebarTitle: Update an Endpoint with New Configuration
og:title: Dedicated Update Endpoint
description: Update a Friendli Dedicated Endpoint with a new model, GPU type, or replica count. Changes are applied as a new version in the deployment history.
og:description: Update a Friendli Dedicated Endpoint with a new model, GPU type, or replica count. Changes are applied as a new version in the deployment history.
href: /openapi/dedicated/endpoint/update
content: 'Update a Dedicated Endpoint deployment with new configuration.
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>'
delete:
tags:
- Dedicated.Endpoint
summary: Delete endpoint
description: Delete a specific endpoint
operationId: dedicatedDeleteEndpoint
security:
- token: []
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: Successful Response
content:
application/json:
schema: {}
'400':
description: Bad Request
'404':
description: Not Found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-speakeasy-name-override: delete
x-mint:
metadata:
title: Dedicated Delete Endpoint
sidebarTitle: Delete an Endpoint
og:title: Dedicated Delete Endpoint
description: Permanently delete a Friendli Dedicated Endpoint deployment by ID. This stops the endpoint and releases all associated GPU resources immediately.
og:description: Permanently delete a Friendli Dedicated Endpoint deployment by ID. This stops the endpoint and releases all associated GPU resources immediately.
href: /openapi/dedicated/endpoint/delete
content: 'Delete an endpoint.
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>'
/dedicated/beta/endpoint/{endpoint_id}/version:
get:
tags:
- Dedicated.Endpoint
summary: Get endpoint version history
description: Get version history of a specific endpoint
operationId: dedicatedGetEndpointVersionHistory
security:
- token: []
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: cursor
in: query
required: false
schema:
anyOf:
- type: string
format: binary
- type: 'null'
description: Cursor for pagination
title: Cursor
description: Cursor for pagination
- name: limit
in: query
required: false
schema:
anyOf:
- type: integer
maximum: 100
minimum: 1
- type: 'null'
description: Limit of items per page
default: 20
title: Limit
description: Limit of items per page
- 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 version history.
content:
application/json:
schema:
$ref: '#/components/schemas/DedicatedEndpointVersionHistoryResponse'
examples:
Example:
value:
data:
'0':
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
x-speakeasy-name-override: getVersionHistory
x-mint:
metadata:
title: Dedicated Get Endpoint Version
sidebarTitle: Retrieve Endpoint Version History
og:title: Dedicated Get Endpoint Version
description: Retrieve the version history of a Friendli Dedicated Endpoint by ID. View past configurations and rollback points for deployment tracking.
og:description: Retrieve the version history of a Friendli Dedicated Endpoint by ID. View past configurations and rollback points for deployment tracking.
href: /openapi/dedicated/endpoint/get-version
content: 'Given an endpoint ID, return its version history.
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>'
/dedicated/beta/endpoint/{endpoint_id}/status:
get:
tags:
- Dedicated.Endpoint
summary: Get endpoint status
description: Get the status of a specific endpoint
operationId: dedicatedGetEndpointStatus
security:
- token: []
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 status.
content:
application/json:
schema:
$ref: '#/components/schemas/DedicatedEndpointStatus'
examples:
Example:
value:
status: INITIALIZING
createdAt: '2025-01-01T00:00:00Z'
updatedAt: '2025-01-01T00:00:00Z'
phase: DOWNLOADING_MODEL
'400':
description: Bad Request
'404':
description: Not Found
'422':
description: Unprocessable Entity
x-speakeasy-name-override: getStatus
x-mint:
metadata:
title: Dedicated Get Endpoint Status
sidebarTitle: Retrieve an Endpoint Status
og:title: Dedicated Get Endpoint Status
description: Check the current status of a Friendli Dedicated Endpoint by ID. Returns the lifecycle state such as running, sleeping, initializing, or terminated.
og:description: Check the current status of a Friendli Dedicated Endpoint by ID. Returns the lifecycle state such as running, sleeping, initializing, or terminated.
href: /openapi/dedicated/endpoint/get-status
content: 'Given an endpoint ID, return its current status.
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>'
/dedicated/beta/endpoint/{endpoint_id}/sleep:
put:
tags:
- Dedicated.Endpoint
summary: Sleep endpoint
description: Put a specific endpoint to sleep
operationId: dedicatedSleepEndpoint
security:
- token: []
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 requested to put the endpoint to sleep.
content:
application/json:
schema:
$ref: '#/components/schemas/DedicatedEndpointStatus'
examples:
Example:
value:
status: SLEEPING
createdAt: '2025-01-01T00:00:00Z'
updatedAt: '2025-01-01T00:00:00Z'
'400':
description: Bad Request
'404':
description: Not Found
'422':
description: Unprocessable Entity
x-speakeasy-name-override: sleep
x-mint:
metadata:
title: Dedicated Sleep Endpoint
sidebarTitle: Sleep an Endpoint
og:title: Dedicated Sleep Endpoint
description: Put a Friendli Dedicated Endpoint into sleep mode by ID. The endpoint stops serving but retains its configuration for quick wake-up later.
og:description: Put a Friendli Dedicated Endpoint into sleep mode by ID. The endpoint stops serving but retains its configuration for quick wake-up later.
href: /openapi/dedicated/endpoint/sleep
content: 'Put a Dedicated Endpoint to sleep mode.
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>'
/dedicated/beta/endpoint/{endpoint_id}/wake:
put:
tags:
- Dedicated.Endpoint
summary: Wake endpoint
description: Wake up a specific endpoint
operationId: dedicatedWakeEndpoint
security:
- token: []
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 requested to wake up the endpoint.
content:
application/json:
schema:
$ref: '#/components/schemas/DedicatedEndpointStatus'
examples:
Example:
value:
status: AWAKING
createdAt: '2025-01-01T00:00:00Z'
updatedAt: '2025-01-01T00:00:00Z'
phase: ENGINE_INITIALIZING
'400':
description: Bad Request
'404':
description: Not Found
'422':
description: Unprocessable Entity
'500':
description: Internal Server Error
x-speakeasy-name-override: wake
x-mint:
metadata:
title: Dedicated Wake Endpoint
sidebarTitle: Wake Up an Endpoint
og:title: Dedicated Wake Endpoint
description: Wake up a sleeping Friendli Dedicated Endpoint by ID. The endpoint resumes serving with its previous model and GPU configuration intact.
og:description: Wake up a sleeping Friendli Dedicated Endpoi
# --- truncated at 32 KB (58 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/friendliai/refs/heads/main/openapi/friendliai-dedicated-endpoint-api-openapi.yml