Build Smarter Agents with Nemotron 3 Nano Omni on FriendliAI — Explore models
API Reference
Model APIs
Dedicated
- Overview
- GETList endpoints
- GETRetrieve an endpoint specification
- GETRetrieve endpoint version history
- GETRetrieve an endpoint status
- POSTCreate an endpoint with Hugging Face model
- POSTCreate endpoint from W&B artifact
- PUTUpdate an endpoint with new configuration
- PUTTerminate an endpoint
- PUTRestart an endpoint
- PUTSleep an endpoint
- PUTWake up an endpoint
- DELDelete an endpoint
Container
Dataset & File
BetaFriendli SDK
curl --request GET \
--url https://api.friendli.ai/dedicated/beta/endpoint \
--header 'Authorization: Bearer <token>'{
"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"
}
}
}Dedicated list endpoints
List all Friendli Dedicated Endpoint deployments in your project. Returns endpoint IDs, statuses, model names, and GPU configurations.
curl --request GET \
--url https://api.friendli.ai/dedicated/beta/endpoint \
--header 'Authorization: Bearer <token>'{
"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"
}
}
}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 on our introduction page to learn how to acquire this variable and visit here to generate your API Key.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.
Authorizations
Headers
ID of team to run requests as (optional parameter).
Query Parameters
The ID of the project. If omitted, query all endpoints under the team.
Cursor for pagination
Limit of items per page
1 <= x <= 100Response
Successfully listed endpoints.
Dedicated endpoint list response.
The response data containing endpoint statuses.
Hide child attributes
Hide child attributes
Dedicated endpoint status.
Hide child attributes
Hide child attributes
The current status of the endpoint deployment.
UNKNOWN, INITIALIZING, RUNNING, UPDATING, SLEEPING, AWAKING, FAILED, STOPPING, TERMINATING, TERMINATED, READY When the endpoint was created.
ErrorCode type.
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 When the endpoint was last updated.
The current phase of the endpoint.
REQUESTING_VIRTUAL_MACHINE, DOWNLOADING_MODEL, ENGINE_INITIALIZING The next cursor for pagination.