Skip to main content
PUT
/
v3
/
models
/
{model_id}
/
deploy-surrogate
Update a surrogate model
curl --request PUT \
  --url https://api.example.com/v3/models/{model_id}/deploy-surrogate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "env_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deployment_params": {
    "artifact_type": "SURROGATE",
    "deployment_type": "BASE_CONTAINER",
    "image_uri": "<string>",
    "replicas": 2,
    "cpu": 500,
    "memory": 512
  }
}
'
import requests

url = "https://api.example.com/v3/models/{model_id}/deploy-surrogate"

payload = {
"env_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deployment_params": {
"artifact_type": "SURROGATE",
"deployment_type": "BASE_CONTAINER",
"image_uri": "<string>",
"replicas": 2,
"cpu": 500,
"memory": 512
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
env_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
deployment_params: {
artifact_type: 'SURROGATE',
deployment_type: 'BASE_CONTAINER',
image_uri: '<string>',
replicas: 2,
cpu: 500,
memory: 512
}
})
};

fetch('https://api.example.com/v3/models/{model_id}/deploy-surrogate', 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://api.example.com/v3/models/{model_id}/deploy-surrogate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'env_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'deployment_params' => [
'artifact_type' => 'SURROGATE',
'deployment_type' => 'BASE_CONTAINER',
'image_uri' => '<string>',
'replicas' => 2,
'cpu' => 500,
'memory' => 512
]
]),
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://api.example.com/v3/models/{model_id}/deploy-surrogate"

payload := strings.NewReader("{\n \"env_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"deployment_params\": {\n \"artifact_type\": \"SURROGATE\",\n \"deployment_type\": \"BASE_CONTAINER\",\n \"image_uri\": \"<string>\",\n \"replicas\": 2,\n \"cpu\": 500,\n \"memory\": 512\n }\n}")

req, _ := http.NewRequest("PUT", 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.put("https://api.example.com/v3/models/{model_id}/deploy-surrogate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"env_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"deployment_params\": {\n \"artifact_type\": \"SURROGATE\",\n \"deployment_type\": \"BASE_CONTAINER\",\n \"image_uri\": \"<string>\",\n \"replicas\": 2,\n \"cpu\": 500,\n \"memory\": 512\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v3/models/{model_id}/deploy-surrogate")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"env_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"deployment_params\": {\n \"artifact_type\": \"SURROGATE\",\n \"deployment_type\": \"BASE_CONTAINER\",\n \"image_uri\": \"<string>\",\n \"replicas\": 2,\n \"cpu\": 500,\n \"memory\": 512\n }\n}"

response = http.request(request)
puts response.read_body
{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "job": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    }
  }
}
{
"api_version": "3.0",
"kind": "ERROR",
"error": {
"code": 400,
"message": "Resource Not Found",
"errors": [
{
"reason": "ResourceNotFoundException",
"message": "Resource Not Found",
"help": "<string>"
}
]
}
}
{
"api_version": "3.0",
"kind": "ERROR",
"error": {
"code": 400,
"message": "Resource Not Found",
"errors": [
{
"reason": "ResourceNotFoundException",
"message": "Resource Not Found",
"help": "<string>"
}
]
}
}
{
"api_version": "3.0",
"kind": "ERROR",
"error": {
"code": 400,
"message": "Resource Not Found",
"errors": [
{
"reason": "ResourceNotFoundException",
"message": "Resource Not Found",
"help": "<string>"
}
]
}
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

model_id
string<uuid>
required

model id path parameter

Body

application/json

Request payload for to deploy a surrogate model

env_id
string<uuid>
required

Unique identifier of the environment associated to the model

deployment_params
object
required

Additoinal paramteres specified to deploy surrogate model

Response

Surrogate model updating task with job id

Response object for standard API responses.

api_version
enum<string>
default:3.0

API version.

Available options:
2.0,
3.0
kind
enum<string>
default:NORMAL

Type of response, indicating a normal response.

Available options:
NORMAL
data
object