Update OrchestratorAgentRuntime
curl --request PUT \
--url https://platform.kodexa.ai/api/agent-runtimes/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"agentRuntimeArn": "<string>",
"awsRuntimeId": "<string>",
"changeSequence": 123,
"configMapName": "<string>",
"configMapResourceVersion": "<string>",
"createdBy": "<string>",
"description": "<string>",
"endpointArn": "<string>",
"endpointId": "<string>",
"endpointName": "<string>",
"environmentVars": null,
"failureReason": "<string>",
"image": "<string>",
"maxConcurrency": 123,
"metadata": null,
"name": "<string>",
"networkMode": "<string>",
"organization": {
"id": "<string>",
"name": "<string>",
"slug": "<string>"
},
"protocolConfiguration": "<string>",
"roleArn": "<string>",
"securityGroups": "<string>",
"slug": "<string>",
"status": "<string>",
"subnets": "<string>"
}
'import requests
url = "https://platform.kodexa.ai/api/agent-runtimes/{id}"
payload = {
"agentRuntimeArn": "<string>",
"awsRuntimeId": "<string>",
"changeSequence": 123,
"configMapName": "<string>",
"configMapResourceVersion": "<string>",
"createdBy": "<string>",
"description": "<string>",
"endpointArn": "<string>",
"endpointId": "<string>",
"endpointName": "<string>",
"environmentVars": None,
"failureReason": "<string>",
"image": "<string>",
"maxConcurrency": 123,
"metadata": None,
"name": "<string>",
"networkMode": "<string>",
"organization": {
"id": "<string>",
"name": "<string>",
"slug": "<string>"
},
"protocolConfiguration": "<string>",
"roleArn": "<string>",
"securityGroups": "<string>",
"slug": "<string>",
"status": "<string>",
"subnets": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
agentRuntimeArn: '<string>',
awsRuntimeId: '<string>',
changeSequence: 123,
configMapName: '<string>',
configMapResourceVersion: '<string>',
createdBy: '<string>',
description: '<string>',
endpointArn: '<string>',
endpointId: '<string>',
endpointName: '<string>',
environmentVars: null,
failureReason: '<string>',
image: '<string>',
maxConcurrency: 123,
metadata: null,
name: '<string>',
networkMode: '<string>',
organization: {id: '<string>', name: '<string>', slug: '<string>'},
protocolConfiguration: '<string>',
roleArn: '<string>',
securityGroups: '<string>',
slug: '<string>',
status: '<string>',
subnets: '<string>'
})
};
fetch('https://platform.kodexa.ai/api/agent-runtimes/{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://platform.kodexa.ai/api/agent-runtimes/{id}",
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([
'agentRuntimeArn' => '<string>',
'awsRuntimeId' => '<string>',
'changeSequence' => 123,
'configMapName' => '<string>',
'configMapResourceVersion' => '<string>',
'createdBy' => '<string>',
'description' => '<string>',
'endpointArn' => '<string>',
'endpointId' => '<string>',
'endpointName' => '<string>',
'environmentVars' => null,
'failureReason' => '<string>',
'image' => '<string>',
'maxConcurrency' => 123,
'metadata' => null,
'name' => '<string>',
'networkMode' => '<string>',
'organization' => [
'id' => '<string>',
'name' => '<string>',
'slug' => '<string>'
],
'protocolConfiguration' => '<string>',
'roleArn' => '<string>',
'securityGroups' => '<string>',
'slug' => '<string>',
'status' => '<string>',
'subnets' => '<string>'
]),
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://platform.kodexa.ai/api/agent-runtimes/{id}"
payload := strings.NewReader("{\n \"agentRuntimeArn\": \"<string>\",\n \"awsRuntimeId\": \"<string>\",\n \"changeSequence\": 123,\n \"configMapName\": \"<string>\",\n \"configMapResourceVersion\": \"<string>\",\n \"createdBy\": \"<string>\",\n \"description\": \"<string>\",\n \"endpointArn\": \"<string>\",\n \"endpointId\": \"<string>\",\n \"endpointName\": \"<string>\",\n \"environmentVars\": null,\n \"failureReason\": \"<string>\",\n \"image\": \"<string>\",\n \"maxConcurrency\": 123,\n \"metadata\": null,\n \"name\": \"<string>\",\n \"networkMode\": \"<string>\",\n \"organization\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"slug\": \"<string>\"\n },\n \"protocolConfiguration\": \"<string>\",\n \"roleArn\": \"<string>\",\n \"securityGroups\": \"<string>\",\n \"slug\": \"<string>\",\n \"status\": \"<string>\",\n \"subnets\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://platform.kodexa.ai/api/agent-runtimes/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agentRuntimeArn\": \"<string>\",\n \"awsRuntimeId\": \"<string>\",\n \"changeSequence\": 123,\n \"configMapName\": \"<string>\",\n \"configMapResourceVersion\": \"<string>\",\n \"createdBy\": \"<string>\",\n \"description\": \"<string>\",\n \"endpointArn\": \"<string>\",\n \"endpointId\": \"<string>\",\n \"endpointName\": \"<string>\",\n \"environmentVars\": null,\n \"failureReason\": \"<string>\",\n \"image\": \"<string>\",\n \"maxConcurrency\": 123,\n \"metadata\": null,\n \"name\": \"<string>\",\n \"networkMode\": \"<string>\",\n \"organization\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"slug\": \"<string>\"\n },\n \"protocolConfiguration\": \"<string>\",\n \"roleArn\": \"<string>\",\n \"securityGroups\": \"<string>\",\n \"slug\": \"<string>\",\n \"status\": \"<string>\",\n \"subnets\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/agent-runtimes/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agentRuntimeArn\": \"<string>\",\n \"awsRuntimeId\": \"<string>\",\n \"changeSequence\": 123,\n \"configMapName\": \"<string>\",\n \"configMapResourceVersion\": \"<string>\",\n \"createdBy\": \"<string>\",\n \"description\": \"<string>\",\n \"endpointArn\": \"<string>\",\n \"endpointId\": \"<string>\",\n \"endpointName\": \"<string>\",\n \"environmentVars\": null,\n \"failureReason\": \"<string>\",\n \"image\": \"<string>\",\n \"maxConcurrency\": 123,\n \"metadata\": null,\n \"name\": \"<string>\",\n \"networkMode\": \"<string>\",\n \"organization\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"slug\": \"<string>\"\n },\n \"protocolConfiguration\": \"<string>\",\n \"roleArn\": \"<string>\",\n \"securityGroups\": \"<string>\",\n \"slug\": \"<string>\",\n \"status\": \"<string>\",\n \"subnets\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"agentRuntimeArn": "<string>",
"awsRuntimeId": "<string>",
"changeSequence": 123,
"configMapName": "<string>",
"configMapResourceVersion": "<string>",
"createdBy": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"endpointArn": "<string>",
"endpointId": "<string>",
"endpointName": "<string>",
"environmentVars": null,
"failureReason": "<string>",
"id": "<string>",
"image": "<string>",
"metadata": null,
"name": "<string>",
"networkMode": "<string>",
"organizationId": "<string>",
"protocolConfiguration": "<string>",
"roleArn": "<string>",
"securityGroups": "<string>",
"slug": "<string>",
"status": "<string>",
"subnets": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"maxConcurrency": 123,
"organization": {
"id": "<string>",
"name": "<string>",
"slug": "<string>"
}
}Agent Runtimes
Update OrchestratorAgentRuntime
Updates an existing OrchestratorAgentRuntime. Agent runtimes define agent processing environments backed by AWS Bedrock AgentCore.
PUT
/
api
/
agent-runtimes
/
{id}
Update OrchestratorAgentRuntime
curl --request PUT \
--url https://platform.kodexa.ai/api/agent-runtimes/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"agentRuntimeArn": "<string>",
"awsRuntimeId": "<string>",
"changeSequence": 123,
"configMapName": "<string>",
"configMapResourceVersion": "<string>",
"createdBy": "<string>",
"description": "<string>",
"endpointArn": "<string>",
"endpointId": "<string>",
"endpointName": "<string>",
"environmentVars": null,
"failureReason": "<string>",
"image": "<string>",
"maxConcurrency": 123,
"metadata": null,
"name": "<string>",
"networkMode": "<string>",
"organization": {
"id": "<string>",
"name": "<string>",
"slug": "<string>"
},
"protocolConfiguration": "<string>",
"roleArn": "<string>",
"securityGroups": "<string>",
"slug": "<string>",
"status": "<string>",
"subnets": "<string>"
}
'import requests
url = "https://platform.kodexa.ai/api/agent-runtimes/{id}"
payload = {
"agentRuntimeArn": "<string>",
"awsRuntimeId": "<string>",
"changeSequence": 123,
"configMapName": "<string>",
"configMapResourceVersion": "<string>",
"createdBy": "<string>",
"description": "<string>",
"endpointArn": "<string>",
"endpointId": "<string>",
"endpointName": "<string>",
"environmentVars": None,
"failureReason": "<string>",
"image": "<string>",
"maxConcurrency": 123,
"metadata": None,
"name": "<string>",
"networkMode": "<string>",
"organization": {
"id": "<string>",
"name": "<string>",
"slug": "<string>"
},
"protocolConfiguration": "<string>",
"roleArn": "<string>",
"securityGroups": "<string>",
"slug": "<string>",
"status": "<string>",
"subnets": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
agentRuntimeArn: '<string>',
awsRuntimeId: '<string>',
changeSequence: 123,
configMapName: '<string>',
configMapResourceVersion: '<string>',
createdBy: '<string>',
description: '<string>',
endpointArn: '<string>',
endpointId: '<string>',
endpointName: '<string>',
environmentVars: null,
failureReason: '<string>',
image: '<string>',
maxConcurrency: 123,
metadata: null,
name: '<string>',
networkMode: '<string>',
organization: {id: '<string>', name: '<string>', slug: '<string>'},
protocolConfiguration: '<string>',
roleArn: '<string>',
securityGroups: '<string>',
slug: '<string>',
status: '<string>',
subnets: '<string>'
})
};
fetch('https://platform.kodexa.ai/api/agent-runtimes/{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://platform.kodexa.ai/api/agent-runtimes/{id}",
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([
'agentRuntimeArn' => '<string>',
'awsRuntimeId' => '<string>',
'changeSequence' => 123,
'configMapName' => '<string>',
'configMapResourceVersion' => '<string>',
'createdBy' => '<string>',
'description' => '<string>',
'endpointArn' => '<string>',
'endpointId' => '<string>',
'endpointName' => '<string>',
'environmentVars' => null,
'failureReason' => '<string>',
'image' => '<string>',
'maxConcurrency' => 123,
'metadata' => null,
'name' => '<string>',
'networkMode' => '<string>',
'organization' => [
'id' => '<string>',
'name' => '<string>',
'slug' => '<string>'
],
'protocolConfiguration' => '<string>',
'roleArn' => '<string>',
'securityGroups' => '<string>',
'slug' => '<string>',
'status' => '<string>',
'subnets' => '<string>'
]),
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://platform.kodexa.ai/api/agent-runtimes/{id}"
payload := strings.NewReader("{\n \"agentRuntimeArn\": \"<string>\",\n \"awsRuntimeId\": \"<string>\",\n \"changeSequence\": 123,\n \"configMapName\": \"<string>\",\n \"configMapResourceVersion\": \"<string>\",\n \"createdBy\": \"<string>\",\n \"description\": \"<string>\",\n \"endpointArn\": \"<string>\",\n \"endpointId\": \"<string>\",\n \"endpointName\": \"<string>\",\n \"environmentVars\": null,\n \"failureReason\": \"<string>\",\n \"image\": \"<string>\",\n \"maxConcurrency\": 123,\n \"metadata\": null,\n \"name\": \"<string>\",\n \"networkMode\": \"<string>\",\n \"organization\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"slug\": \"<string>\"\n },\n \"protocolConfiguration\": \"<string>\",\n \"roleArn\": \"<string>\",\n \"securityGroups\": \"<string>\",\n \"slug\": \"<string>\",\n \"status\": \"<string>\",\n \"subnets\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://platform.kodexa.ai/api/agent-runtimes/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agentRuntimeArn\": \"<string>\",\n \"awsRuntimeId\": \"<string>\",\n \"changeSequence\": 123,\n \"configMapName\": \"<string>\",\n \"configMapResourceVersion\": \"<string>\",\n \"createdBy\": \"<string>\",\n \"description\": \"<string>\",\n \"endpointArn\": \"<string>\",\n \"endpointId\": \"<string>\",\n \"endpointName\": \"<string>\",\n \"environmentVars\": null,\n \"failureReason\": \"<string>\",\n \"image\": \"<string>\",\n \"maxConcurrency\": 123,\n \"metadata\": null,\n \"name\": \"<string>\",\n \"networkMode\": \"<string>\",\n \"organization\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"slug\": \"<string>\"\n },\n \"protocolConfiguration\": \"<string>\",\n \"roleArn\": \"<string>\",\n \"securityGroups\": \"<string>\",\n \"slug\": \"<string>\",\n \"status\": \"<string>\",\n \"subnets\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/agent-runtimes/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agentRuntimeArn\": \"<string>\",\n \"awsRuntimeId\": \"<string>\",\n \"changeSequence\": 123,\n \"configMapName\": \"<string>\",\n \"configMapResourceVersion\": \"<string>\",\n \"createdBy\": \"<string>\",\n \"description\": \"<string>\",\n \"endpointArn\": \"<string>\",\n \"endpointId\": \"<string>\",\n \"endpointName\": \"<string>\",\n \"environmentVars\": null,\n \"failureReason\": \"<string>\",\n \"image\": \"<string>\",\n \"maxConcurrency\": 123,\n \"metadata\": null,\n \"name\": \"<string>\",\n \"networkMode\": \"<string>\",\n \"organization\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"slug\": \"<string>\"\n },\n \"protocolConfiguration\": \"<string>\",\n \"roleArn\": \"<string>\",\n \"securityGroups\": \"<string>\",\n \"slug\": \"<string>\",\n \"status\": \"<string>\",\n \"subnets\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"agentRuntimeArn": "<string>",
"awsRuntimeId": "<string>",
"changeSequence": 123,
"configMapName": "<string>",
"configMapResourceVersion": "<string>",
"createdBy": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"endpointArn": "<string>",
"endpointId": "<string>",
"endpointName": "<string>",
"environmentVars": null,
"failureReason": "<string>",
"id": "<string>",
"image": "<string>",
"metadata": null,
"name": "<string>",
"networkMode": "<string>",
"organizationId": "<string>",
"protocolConfiguration": "<string>",
"roleArn": "<string>",
"securityGroups": "<string>",
"slug": "<string>",
"status": "<string>",
"subnets": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"maxConcurrency": 123,
"organization": {
"id": "<string>",
"name": "<string>",
"slug": "<string>"
}
}Authorizations
x-api-keybearerAuth
API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.
Path Parameters
Unique identifier (UUID) of the resource.
Body
application/json
An orchestrator agent runtime defines an agent processing environment.
Show child attributes
Show child attributes
Response
Updated OrchestratorAgentRuntime
An orchestrator agent runtime defines an agent processing environment.
Show child attributes
Show child attributes