Save Templates

Saves one or more templates to the authenticated user’s library, creating new template records or linking existing ones as appropriate.

POST /api/v0/users/{user_id}/templates

Save Templates

cURL

curl --request POST \
  --url https://console.vast.ai/api/v0/users/{user_id}/templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "templates": "<array>",
  "referral_template_id": 999,
  "is_an_edit": true
}
'

import requests

url = "https://console.vast.ai/api/v0/users/{user_id}/templates"

payload = {
    "templates": "<array>",
    "referral_template_id": 999,
    "is_an_edit": True
}
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({templates: '<array>', referral_template_id: 999, is_an_edit: true})
};

fetch('https://console.vast.ai/api/v0/users/{user_id}/templates', 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/users/{user_id}/templates",
  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([
    'templates' => '<array>',
    'referral_template_id' => 999,
    'is_an_edit' => true
  ]),
  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/users/{user_id}/templates"

	payload := strings.NewReader("{\n  \"templates\": \"<array>\",\n  \"referral_template_id\": 999,\n  \"is_an_edit\": true\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/users/{user_id}/templates")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"templates\": \"<array>\",\n  \"referral_template_id\": 999,\n  \"is_an_edit\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://console.vast.ai/api/v0/users/{user_id}/templates")

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  \"templates\": \"<array>\",\n  \"referral_template_id\": 999,\n  \"is_an_edit\": true\n}"

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

200

{
  "success": true,
  "templates": [
    {}
  ]
}

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

Authorizations

Authorization · string · header · required

API key must be provided in the Authorization header

Path Parameters

user_id · integer · required

ID of the user saving templates (URL path parameter)

Body

application/json

templates · array

Array of template objects to save; each may include an id if updating an existing template (required)

referral_template_id · integer

ID of a referral template to ensure remains visible at the top of the user's template list

Example:

999

is_an_edit · boolean

When true, marks previous template versions as deleted in the user's library after saving new versions

Response

200

application/json

Returns {success: true, templates: [...]} with the user's created templates

success · boolean

Always true

templates · object[]

Updated list of templates created by and associated with the user