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

import requests

url = "https://console.vast.ai/api/v0/endptjobs"

payload = {
    "min_load": 50,
    "target_util": 0.75,
    "cold_mult": 2,
    "cold_workers": 5,
    "max_workers": 20,
    "endpoint_name": "my_endpoint"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    min_load: 50,
    target_util: 0.75,
    cold_mult: 2,
    cold_workers: 5,
    max_workers: 20,
    endpoint_name: 'my_endpoint'
  })
};

fetch('https://console.vast.ai/api/v0/endptjobs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://console.vast.ai/api/v0/endptjobs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'min_load' => 50,
    'target_util' => 0.75,
    'cold_mult' => 2,
    'cold_workers' => 5,
    'max_workers' => 20,
    'endpoint_name' => 'my_endpoint'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://console.vast.ai/api/v0/endptjobs"

	payload := strings.NewReader("{\n  \"min_load\": 50,\n  \"target_util\": 0.75,\n  \"cold_mult\": 2,\n  \"cold_workers\": 5,\n  \"max_workers\": 20,\n  \"endpoint_name\": \"my_endpoint\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://console.vast.ai/api/v0/endptjobs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"min_load\": 50,\n  \"target_util\": 0.75,\n  \"cold_mult\": 2,\n  \"cold_workers\": 5,\n  \"max_workers\": 20,\n  \"endpoint_name\": \"my_endpoint\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://console.vast.ai/api/v0/endptjobs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"min_load\": 50,\n  \"target_util\": 0.75,\n  \"cold_mult\": 2,\n  \"cold_workers\": 5,\n  \"max_workers\": 20,\n  \"endpoint_name\": \"my_endpoint\"\n}"

response = http.request(request)
puts response.read_body

200

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

{
  "error": "invalid_args"
}

{
  "success": false,
  "error": "<string>",
  "msg": "<string>"
}

{
  "success": false,
  "error": "<string>",
  "msg": "<string>"
}

{
  "detail": "API requests too frequent endpoint threshold=4.0"
}

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