v3

OpenAPI 3.1.0MIT2026-07-31192456807.8 KB
Endpoints

Update endpoint, this can also be used to start or stop a dedicated endpoint

Updates an existing endpoint's configuration. You can modify the display name, autoscaling settings, or change the endpoint's state (start/stop).

patch/endpoints/{endpointId}

Path parameters

endpointIdstring required

The ID of the endpoint to update

Example:endpoint-d23901de-ef8f-44bf-b3e7-de9c1ca8f2d7

Request body

display_namestring

A human-readable name for the endpoint

state'STARTED' | 'STOPPED'

The desired state of the endpoint

inactive_timeoutinteger nullable

The number of minutes of inactivity after which the endpoint stops automatically. Set to 0 to disable automatic timeout.

Example request

{
  "display_name": "My Llama3 70b endpoint",
  "state": "STARTED",
  "autoscaling": {
    "min_replicas": 2,
    "max_replicas": 5
  },
  "inactive_timeout": 60
}

Response

200

object'endpoint' required

The object type, which is always endpoint.

idstring required

Unique identifier for the endpoint

namestring required

System name for the endpoint

display_namestring required

Human-readable name for the endpoint

modelstring required

The model deployed on this endpoint

hardwarestring required

The hardware configuration used for this endpoint

type'dedicated' required

The type of endpoint

ownerstring required

The owner of this endpoint

state'PENDING' | 'STARTING' | 'STARTED' | 'STOPPING' | 'STOPPED' | 'ERROR' required

Current state of the endpoint

created_atstring date-time required

Timestamp when the endpoint was created

Example response

{
  "id": "endpoint-d23901de-ef8f-44bf-b3e7-de9c1ca8f2d7",
  "name": "devuser/deepseek-ai/DeepSeek-R1-a32b82a1",
  "display_name": "My DeepSeek R1 endpoint",
  "model": "deepseek-ai/DeepSeek-R1",
  "hardware": "8x_nvidia_h200_140gb_sxm",
  "type": "dedicated",
  "owner": "devuser",
  "state": "STARTED",
  "autoscaling": {
    "min_replicas": 2,
    "max_replicas": 5
  },
  "created_at": "2025-02-04T10:43:55.405Z"
}