Dedicated List Endpoints

{ "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" } } }

Authorizations

Authorization

string

header

required

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.

Headers

X-Friendli-Team

string | null

ID of team to run requests as (optional parameter).

Query Parameters

project_id

string | null

default:""

The ID of the project. If omitted, query all endpoints under the team.

cursor

file | null

Cursor for pagination

limit

integer | null

default:20

Limit of items per page

Required range: 1 <= x <= 100

Response

Successfully listed endpoints.

Dedicated endpoint list response.

data

Data · object

The response data containing endpoint statuses.

Hide child attributes

data.{key}

DedicatedEndpointStatus · object

Dedicated endpoint status.

Hide child attributes

data.{key}.status

enum<string>

required

The current status of the endpoint deployment.

Available options:

UNKNOWN,

INITIALIZING,

RUNNING,

UPDATING,

SLEEPING,

AWAKING,

FAILED,

STOPPING,

TERMINATING,

TERMINATED,

READY

data.{key}.createdAt

string<date-time>

required

When the endpoint was created.

data.{key}.errorCode

enum<string> | null

ErrorCode type.

Available options:

WORKLOAD_INIT_UNKNOWN_ERROR,

WORKLOAD_INIT_SETTINGS_ERROR,

WORKLOAD_INIT_GRPC_ERROR,

WORKLOAD_INIT_MANIFEST_NOT_FOUND_ERROR,

WORKLOAD_INIT_MANIFEST_TYPE_ERROR,

WORKLOAD_INIT_DOWNLOAD_ERROR,

WORKLOAD_INIT_INVALID_TOKEN_ERROR,

WORKLOAD_INIT_CANNOT_ACCESS_REPO_ERROR,

WORKLOAD_INIT_HF_WANDB_API_ERROR,

WORKLOAD_INIT_INSUFFICIENT_DISK_ERROR,

INFERENCE_ENGINE_UNKNOWN_ERROR,

INFERENCE_ENGINE_INVALID_ARGUMENT_ERROR,

INFERENCE_ENGINE_MEMORY_ERROR,

INFERENCE_ENGINE_METERING_CLIENT_CONFIG_ERROR

data.{key}.updatedAt

string<date-time> | null

When the endpoint was last updated.

data.{key}.phase

enum<string> | null

The current phase of the endpoint.

Available options:

REQUESTING_VIRTUAL_MACHINE,

DOWNLOADING_MODEL,

ENGINE_INITIALIZING

nextCursor

file | null

The next cursor for pagination.