curl --request POST \
--url https://api.egp.scale.com/v5/agentex/deployments \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"manifest_file": "<string>",
"environment_config": "<string>",
"build_id": "<string>",
"image_name": "<string>",
"image_tag": "<string>",
"preview": false,
"preview_label": "<string>",
"expires_at": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.egp.scale.com/v5/agentex/deployments"
payload = {
"manifest_file": "<string>",
"environment_config": "<string>",
"build_id": "<string>",
"image_name": "<string>",
"image_tag": "<string>",
"preview": False,
"preview_label": "<string>",
"expires_at": "2023-11-07T05:31:56Z"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
manifest_file: '<string>',
environment_config: '<string>',
build_id: '<string>',
image_name: '<string>',
image_tag: '<string>',
preview: false,
preview_label: '<string>',
expires_at: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.egp.scale.com/v5/agentex/deployments', 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/agentex/deployments",
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([
'manifest_file' => '<string>',
'environment_config' => '<string>',
'build_id' => '<string>',
'image_name' => '<string>',
'image_tag' => '<string>',
'preview' => false,
'preview_label' => '<string>',
'expires_at' => '2023-11-07T05:31:56Z'
]),
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/agentex/deployments"
payload := strings.NewReader("{\n \"manifest_file\": \"<string>\",\n \"environment_config\": \"<string>\",\n \"build_id\": \"<string>\",\n \"image_name\": \"<string>\",\n \"image_tag\": \"<string>\",\n \"preview\": false,\n \"preview_label\": \"<string>\",\n \"expires_at\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.egp.scale.com/v5/agentex/deployments")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"manifest_file\": \"<string>\",\n \"environment_config\": \"<string>\",\n \"build_id\": \"<string>\",\n \"image_name\": \"<string>\",\n \"image_tag\": \"<string>\",\n \"preview\": false,\n \"preview_label\": \"<string>\",\n \"expires_at\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.egp.scale.com/v5/agentex/deployments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"manifest_file\": \"<string>\",\n \"environment_config\": \"<string>\",\n \"build_id\": \"<string>\",\n \"image_name\": \"<string>\",\n \"image_tag\": \"<string>\",\n \"preview\": false,\n \"preview_label\": \"<string>\",\n \"expires_at\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"namespace": "<string>",
"manifest_file": "<string>",
"environment_config": "<string>",
"status": "<string>",
"account_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"created_by": {
"id": "<string>",
"type": "user",
"object": "identity"
},
"object": "agentex_cloud_deploy",
"build_id": "<string>",
"helm_release_name": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"preview_label": "<string>",
"deploy_events": [
{
"type": "<string>",
"reason": "<string>",
"message": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Create Deployment
Create a new deployment.
Submits a deployment request. The deployment will:
- Parse and merge configuration files
- Create a Kubernetes Job running helm install
- Wait for deployment completion
- Return results
curl --request POST \
--url https://api.egp.scale.com/v5/agentex/deployments \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"manifest_file": "<string>",
"environment_config": "<string>",
"build_id": "<string>",
"image_name": "<string>",
"image_tag": "<string>",
"preview": false,
"preview_label": "<string>",
"expires_at": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.egp.scale.com/v5/agentex/deployments"
payload = {
"manifest_file": "<string>",
"environment_config": "<string>",
"build_id": "<string>",
"image_name": "<string>",
"image_tag": "<string>",
"preview": False,
"preview_label": "<string>",
"expires_at": "2023-11-07T05:31:56Z"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
manifest_file: '<string>',
environment_config: '<string>',
build_id: '<string>',
image_name: '<string>',
image_tag: '<string>',
preview: false,
preview_label: '<string>',
expires_at: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.egp.scale.com/v5/agentex/deployments', 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/agentex/deployments",
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([
'manifest_file' => '<string>',
'environment_config' => '<string>',
'build_id' => '<string>',
'image_name' => '<string>',
'image_tag' => '<string>',
'preview' => false,
'preview_label' => '<string>',
'expires_at' => '2023-11-07T05:31:56Z'
]),
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/agentex/deployments"
payload := strings.NewReader("{\n \"manifest_file\": \"<string>\",\n \"environment_config\": \"<string>\",\n \"build_id\": \"<string>\",\n \"image_name\": \"<string>\",\n \"image_tag\": \"<string>\",\n \"preview\": false,\n \"preview_label\": \"<string>\",\n \"expires_at\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.egp.scale.com/v5/agentex/deployments")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"manifest_file\": \"<string>\",\n \"environment_config\": \"<string>\",\n \"build_id\": \"<string>\",\n \"image_name\": \"<string>\",\n \"image_tag\": \"<string>\",\n \"preview\": false,\n \"preview_label\": \"<string>\",\n \"expires_at\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.egp.scale.com/v5/agentex/deployments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"manifest_file\": \"<string>\",\n \"environment_config\": \"<string>\",\n \"build_id\": \"<string>\",\n \"image_name\": \"<string>\",\n \"image_tag\": \"<string>\",\n \"preview\": false,\n \"preview_label\": \"<string>\",\n \"expires_at\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"namespace": "<string>",
"manifest_file": "<string>",
"environment_config": "<string>",
"status": "<string>",
"account_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"created_by": {
"id": "<string>",
"type": "user",
"object": "identity"
},
"object": "agentex_cloud_deploy",
"build_id": "<string>",
"helm_release_name": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"preview_label": "<string>",
"deploy_events": [
{
"type": "<string>",
"reason": "<string>",
"message": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Headers
Body
The build_id of the cloud build. Required if image_name and image_tag are not provided.
Name of the image to deploy. Required if build_id is not provided.
Tag of the image to deploy. Required if build_id is not provided.
When True, creates a preview deployment with a unique deployment-id suffix appended to the helm release name.
Non-unique grouping label for the preview (e.g. branch name, PR number). Persisted on the deployment record so callers can list all deploys for a given label via GET /v5/agentex/deployments?preview_label=X&limit=1 (get the latest). Sanitized to lowercase alphanumeric + hyphens for K8s DNS-label compatibility (max 30 characters after sanitization). Each deploy still gets a unique helm release name regardless of label, so concurrent redeploys never share K8s resources. Only valid when preview=True.
ISO 8601 expiry timestamp. Only valid for preview deployments. If omitted on a preview deployment, defaults to 8 hours from now. Previews are always ephemeral and always have an expires_at.
Response
Successful Response
The identity that created the entity.
Show child attributes
Show child attributes
"agentex_cloud_deploy"Kubernetes events for this deployment.
Show child attributes
Show child attributes

