create endpoint

This endpoint creates a new job processing endpoint with specified parameters.

CLI Usage: vastai create endpoint [options]

POST /api/v0/endptjobs

create endpoint

cURL

curl --request POST \
  --url https://console.vast.ai/api/v0/endptjobs/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "min_load": 50,
  "target_util": 0.75,
  "cold_mult": 2,
  "cold_workers": 5,
  "max_workers": 20,
  "endpoint_name": "my_endpoint"
}
'

200

{
  "success": true,
  "result": 12345
}

Authorizations

Authorization · string · header · required

API key must be provided in the Authorization header

Body

application/json

min_load · number · default: 10

Minimum load for the endpoint.

Example:

50

target_util · number · default: 0.9

Target utilization for the endpoint.

Example:

0.75

cold_mult · number · default: 2.5

Multiplier for cold start.

Example:

2

cold_workers · integer · default: 5

Number of cold workers.

Example:

5

max_workers · integer · default: 20

Maximum number of workers.

Example:

20

endpoint_name · string · default: default-endpoint

Name of the endpoint.

Example:

"my_endpoint"

Response

200

application/json

Success response

success · boolean

Example:

true

result · integer

The ID of the created endpoint

Example:

12345