Add or update Atlas AI agents
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/ai/agents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"externalId": "<string>",
"name": "<string>",
"description": "<string>",
"instructions": "<string>",
"labels": [
"<string>"
],
"model": "azure/gpt-4.1",
"runtimeVersion": "<string>",
"skills": [],
"subagents": [],
"tools": []
}
]
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/ai/agents"
payload = { "items": [
{
"externalId": "<string>",
"name": "<string>",
"description": "<string>",
"instructions": "<string>",
"labels": ["<string>"],
"model": "azure/gpt-4.1",
"runtimeVersion": "<string>",
"skills": [],
"subagents": [],
"tools": []
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
externalId: '<string>',
name: '<string>',
description: '<string>',
instructions: '<string>',
labels: ['<string>'],
model: 'azure/gpt-4.1',
runtimeVersion: '<string>',
skills: [],
subagents: [],
tools: []
}
]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/ai/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://{cluster}.cognitedata.com/api/v1/projects/{project}/ai/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([
'items' => [
[
'externalId' => '<string>',
'name' => '<string>',
'description' => '<string>',
'instructions' => '<string>',
'labels' => [
'<string>'
],
'model' => 'azure/gpt-4.1',
'runtimeVersion' => '<string>',
'skills' => [
],
'subagents' => [
],
'tools' => [
]
]
]
]),
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://{cluster}.cognitedata.com/api/v1/projects/{project}/ai/agents"
payload := strings.NewReader("{\n \"items\": [\n {\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"instructions\": \"<string>\",\n \"labels\": [\n \"<string>\"\n ],\n \"model\": \"azure/gpt-4.1\",\n \"runtimeVersion\": \"<string>\",\n \"skills\": [],\n \"subagents\": [],\n \"tools\": []\n }\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://{cluster}.cognitedata.com/api/v1/projects/{project}/ai/agents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"instructions\": \"<string>\",\n \"labels\": [\n \"<string>\"\n ],\n \"model\": \"azure/gpt-4.1\",\n \"runtimeVersion\": \"<string>\",\n \"skills\": [],\n \"subagents\": [],\n \"tools\": []\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/ai/agents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"instructions\": \"<string>\",\n \"labels\": [\n \"<string>\"\n ],\n \"model\": \"azure/gpt-4.1\",\n \"runtimeVersion\": \"<string>\",\n \"skills\": [],\n \"subagents\": [],\n \"tools\": []\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"createdTime": 123,
"externalId": "<string>",
"lastUpdatedTime": 123,
"name": "<string>",
"ownerId": "<string>",
"runtimeVersion": "<string>",
"description": "<string>",
"instructions": "<string>",
"labels": [
"<string>"
],
"model": "azure/gpt-4.1",
"skills": [],
"subagents": [],
"tools": []
}
]
}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}Add or update Atlas AI agents
Add or update (upsert) Atlas AI agents.
POST
/
ai
/
agents
Add or update Atlas AI agents
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/ai/agents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"externalId": "<string>",
"name": "<string>",
"description": "<string>",
"instructions": "<string>",
"labels": [
"<string>"
],
"model": "azure/gpt-4.1",
"runtimeVersion": "<string>",
"skills": [],
"subagents": [],
"tools": []
}
]
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/ai/agents"
payload = { "items": [
{
"externalId": "<string>",
"name": "<string>",
"description": "<string>",
"instructions": "<string>",
"labels": ["<string>"],
"model": "azure/gpt-4.1",
"runtimeVersion": "<string>",
"skills": [],
"subagents": [],
"tools": []
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
externalId: '<string>',
name: '<string>',
description: '<string>',
instructions: '<string>',
labels: ['<string>'],
model: 'azure/gpt-4.1',
runtimeVersion: '<string>',
skills: [],
subagents: [],
tools: []
}
]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/ai/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://{cluster}.cognitedata.com/api/v1/projects/{project}/ai/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([
'items' => [
[
'externalId' => '<string>',
'name' => '<string>',
'description' => '<string>',
'instructions' => '<string>',
'labels' => [
'<string>'
],
'model' => 'azure/gpt-4.1',
'runtimeVersion' => '<string>',
'skills' => [
],
'subagents' => [
],
'tools' => [
]
]
]
]),
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://{cluster}.cognitedata.com/api/v1/projects/{project}/ai/agents"
payload := strings.NewReader("{\n \"items\": [\n {\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"instructions\": \"<string>\",\n \"labels\": [\n \"<string>\"\n ],\n \"model\": \"azure/gpt-4.1\",\n \"runtimeVersion\": \"<string>\",\n \"skills\": [],\n \"subagents\": [],\n \"tools\": []\n }\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://{cluster}.cognitedata.com/api/v1/projects/{project}/ai/agents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"instructions\": \"<string>\",\n \"labels\": [\n \"<string>\"\n ],\n \"model\": \"azure/gpt-4.1\",\n \"runtimeVersion\": \"<string>\",\n \"skills\": [],\n \"subagents\": [],\n \"tools\": []\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/ai/agents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"instructions\": \"<string>\",\n \"labels\": [\n \"<string>\"\n ],\n \"model\": \"azure/gpt-4.1\",\n \"runtimeVersion\": \"<string>\",\n \"skills\": [],\n \"subagents\": [],\n \"tools\": []\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"createdTime": 123,
"externalId": "<string>",
"lastUpdatedTime": 123,
"name": "<string>",
"ownerId": "<string>",
"runtimeVersion": "<string>",
"description": "<string>",
"instructions": "<string>",
"labels": [
"<string>"
],
"model": "azure/gpt-4.1",
"skills": [],
"subagents": [],
"tools": []
}
]
}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}Authorizations
oidc-tokenoauth2-client-credentialsoauth2-open-industrial-dataoauth2-auth-code
Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
Body
application/json
A list of agents to create or update.
Required array length:
1 elementShow child attributes
Show child attributes
Response
Successful Response
A list of created agents.
Show child attributes
Show child attributes
Last modified on July 13, 2026
Was this page helpful?
⌘I