curl --request PATCH \
--url https://api.egp.scale.com/v5/models/{model_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"model_metadata": {}
}
'import requests
url = "https://api.egp.scale.com/v5/models/{model_id}"
payload = { "model_metadata": {} }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({model_metadata: {}})
};
fetch('https://api.egp.scale.com/v5/models/{model_id}', 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.egp.scale.com/v5/models/{model_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'model_metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.egp.scale.com/v5/models/{model_id}"
payload := strings.NewReader("{\n \"model_metadata\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.patch("https://api.egp.scale.com/v5/models/{model_id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"model_metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.egp.scale.com/v5/models/{model_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"model_metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"model_type": "generic",
"model_vendor": "openai",
"status": "failed",
"created_at": "2023-11-07T05:31:56Z",
"created_by_user_id": "<string>",
"created_by_identity_type": "user",
"object": "model",
"vendor_configuration": {
"model_image": {
"registry": "<string>",
"repository": "<string>",
"tag": "<string>",
"command": [
"<string>"
],
"predict_route": "/predict",
"streaming_predict_route": "<string>",
"streaming_command": [
"<string>"
],
"request_schema": {},
"response_schema": {},
"env_vars": {},
"readiness_delay": 120,
"healthcheck_route": "/readyz"
},
"model_infra": {
"endpoint_type": "sync",
"cpus": 3,
"gpus": 0,
"gpu_type": "nvidia-tesla-t4",
"memory": "8Gi",
"storage": "16Gi",
"min_workers": 0,
"max_workers": 1,
"per_worker": 10,
"high_priority": false,
"labels": {},
"public_inference": false
}
},
"status_reason": "<string>",
"model_metadata": {},
"model_availability": "unknown"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Update a custom model
Update a custom model record; vendor-configuration changes are applied asynchronously by redeploying the model.
This supports three kinds of update: changing model metadata only, renaming the model, and changing the vendor configuration. A vendor-configuration change is asynchronous — it puts the model back into a deploying status, records an update job, and starts a Temporal workflow to redeploy, so the new configuration is not live when this returns; metadata-only and rename changes take effect immediately. The vendor configuration supplied must match the model’s own vendor (launch or llmengine), and only those two vendors are supported. A model that is currently deploying cannot be modified and the request fails until deployment finishes. When renaming with on_conflict set to swap, the name is exchanged with an existing model of the same name and vendor instead of failing on the uniqueness constraint.
curl --request PATCH \
--url https://api.egp.scale.com/v5/models/{model_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"model_metadata": {}
}
'import requests
url = "https://api.egp.scale.com/v5/models/{model_id}"
payload = { "model_metadata": {} }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({model_metadata: {}})
};
fetch('https://api.egp.scale.com/v5/models/{model_id}', 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.egp.scale.com/v5/models/{model_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'model_metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.egp.scale.com/v5/models/{model_id}"
payload := strings.NewReader("{\n \"model_metadata\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.patch("https://api.egp.scale.com/v5/models/{model_id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"model_metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.egp.scale.com/v5/models/{model_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"model_metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"model_type": "generic",
"model_vendor": "openai",
"status": "failed",
"created_at": "2023-11-07T05:31:56Z",
"created_by_user_id": "<string>",
"created_by_identity_type": "user",
"object": "model",
"vendor_configuration": {
"model_image": {
"registry": "<string>",
"repository": "<string>",
"tag": "<string>",
"command": [
"<string>"
],
"predict_route": "/predict",
"streaming_predict_route": "<string>",
"streaming_command": [
"<string>"
],
"request_schema": {},
"response_schema": {},
"env_vars": {},
"readiness_delay": 120,
"healthcheck_route": "/readyz"
},
"model_infra": {
"endpoint_type": "sync",
"cpus": 3,
"gpus": 0,
"gpu_type": "nvidia-tesla-t4",
"memory": "8Gi",
"storage": "16Gi",
"min_workers": 0,
"max_workers": 1,
"per_worker": 10,
"high_priority": false,
"labels": {},
"public_inference": false
}
},
"status_reason": "<string>",
"model_metadata": {},
"model_availability": "unknown"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Headers
Path Parameters
Body
- DefaultModelPatchRequest
- ModelConfigurationPatchRequest
- SwapNamesModelPatchRequest
Response
Successful Response
The unique identifier of the entity.
generic, completion, chat_completion openai, cohere, vertex_ai, anthropic, azure, gemini, launch, llmengine, model_zoo, bedrock, xai, fireworks_ai failed, ready, deploying, deployment_timeout The date and time when the entity was created in ISO format.
The user who originally created the entity.
The type of identity that created the entity.
user, service_account "model"- LaunchVendorConfiguration
- LLMEngineVendorConfiguration
Show child attributes
Show child attributes
unknown, available, unavailable 
