Route Serverless Request

Ask the serverless router for a ready worker to handle one request against a serverless endpoint group. Returns the worker URL (plus a signature the worker validates) or a backlog/scaling status when no worker is immediately available.

POST /route/

Route Serverless Request

cURL

curl --request POST \
  --url https://run.vast.ai/route/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "endpoint_id": 123,
  "endpoint": "<string>",
  "api_key": "<string>",
  "cost": 123,
  "latency": 123,
  "request_idx": 123,
  "guid": 123,
  "replay_timeout": 123
}
'

import requests

url = "https://run.vast.ai/route/"

payload = {
    "endpoint_id": 123,
    "endpoint": "<string>",
    "api_key": "<string>",
    "cost": 123,
    "latency": 123,
    "request_idx": 123,
    "guid": 123,
    "replay_timeout": 123
}
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({
    endpoint_id: 123,
    endpoint: '<string>',
    api_key: '<string>',
    cost: 123,
    latency: 123,
    request_idx: 123,
    guid: 123,
    replay_timeout: 123
  })
};

fetch('https://run.vast.ai/route/', 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://run.vast.ai/route/",
  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([
    'endpoint_id' => 123,
    'endpoint' => '<string>',
    'api_key' => '<string>',
    'cost' => 123,
    'latency' => 123,
    'request_idx' => 123,
    'guid' => 123,
    'replay_timeout' => 123
  ]),
  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://run.vast.ai/route/"

	payload := strings.NewReader("{\n  \"endpoint_id\": 123,\n  \"endpoint\": \"<string>\",\n  \"api_key\": \"<string>\",\n  \"cost\": 123,\n  \"latency\": 123,\n  \"request_idx\": 123,\n  \"guid\": 123,\n  \"replay_timeout\": 123\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://run.vast.ai/route/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"endpoint_id\": 123,\n  \"endpoint\": \"<string>\",\n  \"api_key\": \"<string>\",\n  \"cost\": 123,\n  \"latency\": 123,\n  \"request_idx\": 123,\n  \"guid\": 123,\n  \"replay_timeout\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://run.vast.ai/route/")

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  \"endpoint_id\": 123,\n  \"endpoint\": \"<string>\",\n  \"api_key\": \"<string>\",\n  \"cost\": 123,\n  \"latency\": 123,\n  \"request_idx\": 123,\n  \"guid\": 123,\n  \"replay_timeout\": 123\n}"

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

200

{
  "endpoint": "<string>",
  "request_idx": 123,
  "url": "<string>",
  "cost": 123,
  "reqnum": 123,
  "signature": "<string>",
  "status": "<string>"
}

{
  "error_msg": "<string>"
}

Authorizations

Authorization · string · header · required

API key must be provided in the Authorization header

Body

application/json

endpoint_id · integer

Endpoint group id (supply this or endpoint).

endpoint · string

Endpoint group name (supply this or endpoint_id).

api_key · string

Endpoint API key. May instead be supplied as a Bearer token in the Authorization header.

cost · number

Estimated request cost in cost units (must be ≥ 0).

latency · number

Average time a single worker takes to complete this request, in seconds.

request_idx · integer

Request index; 0 (or omitted) starts a new request, a prior value re-polls it.

guid · integer

Client-supplied request identifier.

replay_timeout · number

Seconds after which an unanswered request may be replayed on another worker.

Response

200

application/json

Success

endpoint · string

request_idx · integer

url · string

Worker URL to send the request to (present when a worker is ready).

cost · number

reqnum · integer

signature · string

Router signature the worker validates before serving the request.

status · string

Set when no worker URL is returned (e.g. "endpoint stopped").