Create OrchestratorAgent
curl --request POST \
--url https://platform.kodexa.ai/api/agents \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"agentRuntimeId": "<string>",
"name": "<string>",
"organizationId": "<string>",
"projectId": "<string>",
"slug": "<string>",
"agentRuntimeRef": "<string>",
"createdBy": "<string>",
"description": "<string>",
"metadata": null,
"moduleRefs": [
"<string>"
],
"status": "<string>",
"taskId": "<string>",
"userId": "<string>"
}
'import requests
url = "https://platform.kodexa.ai/api/agents"
payload = {
"agentRuntimeId": "<string>",
"name": "<string>",
"organizationId": "<string>",
"projectId": "<string>",
"slug": "<string>",
"agentRuntimeRef": "<string>",
"createdBy": "<string>",
"description": "<string>",
"metadata": None,
"moduleRefs": ["<string>"],
"status": "<string>",
"taskId": "<string>",
"userId": "<string>"
}
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({
agentRuntimeId: '<string>',
name: '<string>',
organizationId: '<string>',
projectId: '<string>',
slug: '<string>',
agentRuntimeRef: '<string>',
createdBy: '<string>',
description: '<string>',
metadata: null,
moduleRefs: ['<string>'],
status: '<string>',
taskId: '<string>',
userId: '<string>'
})
};
fetch('https://platform.kodexa.ai/api/agents', 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/agents",
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([
'agentRuntimeId' => '<string>',
'name' => '<string>',
'organizationId' => '<string>',
'projectId' => '<string>',
'slug' => '<string>',
'agentRuntimeRef' => '<string>',
'createdBy' => '<string>',
'description' => '<string>',
'metadata' => null,
'moduleRefs' => [
'<string>'
],
'status' => '<string>',
'taskId' => '<string>',
'userId' => '<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/agents"
payload := strings.NewReader("{\n \"agentRuntimeId\": \"<string>\",\n \"name\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"projectId\": \"<string>\",\n \"slug\": \"<string>\",\n \"agentRuntimeRef\": \"<string>\",\n \"createdBy\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": null,\n \"moduleRefs\": [\n \"<string>\"\n ],\n \"status\": \"<string>\",\n \"taskId\": \"<string>\",\n \"userId\": \"<string>\"\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://platform.kodexa.ai/api/agents")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agentRuntimeId\": \"<string>\",\n \"name\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"projectId\": \"<string>\",\n \"slug\": \"<string>\",\n \"agentRuntimeRef\": \"<string>\",\n \"createdBy\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": null,\n \"moduleRefs\": [\n \"<string>\"\n ],\n \"status\": \"<string>\",\n \"taskId\": \"<string>\",\n \"userId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/agents")
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 \"agentRuntimeId\": \"<string>\",\n \"name\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"projectId\": \"<string>\",\n \"slug\": \"<string>\",\n \"agentRuntimeRef\": \"<string>\",\n \"createdBy\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": null,\n \"moduleRefs\": [\n \"<string>\"\n ],\n \"status\": \"<string>\",\n \"taskId\": \"<string>\",\n \"userId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"agentRuntimeId": "<string>",
"agentRuntimeRef": "<string>",
"changeSequence": 123,
"createdBy": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"id": "<string>",
"metadata": null,
"moduleRefs": [
"<string>"
],
"name": "<string>",
"organizationId": "<string>",
"projectId": "<string>",
"slug": "<string>",
"status": "<string>",
"taskId": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"userId": "<string>"
}Agents
Create OrchestratorAgent
Creates a new OrchestratorAgent. Agents are instantiated agent runtimes within an org+project, tracking lifecycle and configuration.
POST
/
api
/
agents
Create OrchestratorAgent
curl --request POST \
--url https://platform.kodexa.ai/api/agents \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"agentRuntimeId": "<string>",
"name": "<string>",
"organizationId": "<string>",
"projectId": "<string>",
"slug": "<string>",
"agentRuntimeRef": "<string>",
"createdBy": "<string>",
"description": "<string>",
"metadata": null,
"moduleRefs": [
"<string>"
],
"status": "<string>",
"taskId": "<string>",
"userId": "<string>"
}
'import requests
url = "https://platform.kodexa.ai/api/agents"
payload = {
"agentRuntimeId": "<string>",
"name": "<string>",
"organizationId": "<string>",
"projectId": "<string>",
"slug": "<string>",
"agentRuntimeRef": "<string>",
"createdBy": "<string>",
"description": "<string>",
"metadata": None,
"moduleRefs": ["<string>"],
"status": "<string>",
"taskId": "<string>",
"userId": "<string>"
}
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({
agentRuntimeId: '<string>',
name: '<string>',
organizationId: '<string>',
projectId: '<string>',
slug: '<string>',
agentRuntimeRef: '<string>',
createdBy: '<string>',
description: '<string>',
metadata: null,
moduleRefs: ['<string>'],
status: '<string>',
taskId: '<string>',
userId: '<string>'
})
};
fetch('https://platform.kodexa.ai/api/agents', 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/agents",
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([
'agentRuntimeId' => '<string>',
'name' => '<string>',
'organizationId' => '<string>',
'projectId' => '<string>',
'slug' => '<string>',
'agentRuntimeRef' => '<string>',
'createdBy' => '<string>',
'description' => '<string>',
'metadata' => null,
'moduleRefs' => [
'<string>'
],
'status' => '<string>',
'taskId' => '<string>',
'userId' => '<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/agents"
payload := strings.NewReader("{\n \"agentRuntimeId\": \"<string>\",\n \"name\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"projectId\": \"<string>\",\n \"slug\": \"<string>\",\n \"agentRuntimeRef\": \"<string>\",\n \"createdBy\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": null,\n \"moduleRefs\": [\n \"<string>\"\n ],\n \"status\": \"<string>\",\n \"taskId\": \"<string>\",\n \"userId\": \"<string>\"\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://platform.kodexa.ai/api/agents")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agentRuntimeId\": \"<string>\",\n \"name\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"projectId\": \"<string>\",\n \"slug\": \"<string>\",\n \"agentRuntimeRef\": \"<string>\",\n \"createdBy\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": null,\n \"moduleRefs\": [\n \"<string>\"\n ],\n \"status\": \"<string>\",\n \"taskId\": \"<string>\",\n \"userId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/agents")
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 \"agentRuntimeId\": \"<string>\",\n \"name\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"projectId\": \"<string>\",\n \"slug\": \"<string>\",\n \"agentRuntimeRef\": \"<string>\",\n \"createdBy\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": null,\n \"moduleRefs\": [\n \"<string>\"\n ],\n \"status\": \"<string>\",\n \"taskId\": \"<string>\",\n \"userId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"agentRuntimeId": "<string>",
"agentRuntimeRef": "<string>",
"changeSequence": 123,
"createdBy": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"id": "<string>",
"metadata": null,
"moduleRefs": [
"<string>"
],
"name": "<string>",
"organizationId": "<string>",
"projectId": "<string>",
"slug": "<string>",
"status": "<string>",
"taskId": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"userId": "<string>"
}Authorizations
x-api-keybearerAuth
API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.
Body
application/json
An agent is an instantiated agent runtime within an org+project, tracking lifecycle and configuration.
Response
Created OrchestratorAgent
An agent is an instantiated agent runtime within an org+project, tracking lifecycle and configuration.