Create agent
curl --request POST \
--url https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/agents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"config": "<string>",
"profile": "<string>",
"name": "<string>",
"message": "<string>"
}
'import requests
url = "https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/agents"
payload = {
"config": "<string>",
"profile": "<string>",
"name": "<string>",
"message": "<string>"
}
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({config: '<string>', profile: '<string>', name: '<string>', message: '<string>'})
};
fetch('https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/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://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/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([
'config' => '<string>',
'profile' => '<string>',
'name' => '<string>',
'message' => '<string>'
]),
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://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/agents"
payload := strings.NewReader("{\n \"config\": \"<string>\",\n \"profile\": \"<string>\",\n \"name\": \"<string>\",\n \"message\": \"<string>\"\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://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/agents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"config\": \"<string>\",\n \"profile\": \"<string>\",\n \"name\": \"<string>\",\n \"message\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/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 \"config\": \"<string>\",\n \"profile\": \"<string>\",\n \"name\": \"<string>\",\n \"message\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"agent": {
"id": "<string>",
"org_id": "<string>",
"project_id": "<string>",
"state": "active",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"agent_profile_id": "<string>",
"integration_target": {
"provider": "<string>",
"provider_ref": "<string>",
"provider_ref_kind": "<string>",
"display_name": "<string>",
"provider_uri": "<string>"
},
"current_config_id": "<string>",
"model": {
"provider_config": "<string>",
"name": "<string>"
},
"archived_at": "2023-11-07T05:31:56Z"
}
}{
"agent": {
"id": "<string>",
"org_id": "<string>",
"project_id": "<string>",
"state": "active",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"agent_profile_id": "<string>",
"integration_target": {
"provider": "<string>",
"provider_ref": "<string>",
"provider_ref_kind": "<string>",
"display_name": "<string>",
"provider_uri": "<string>"
},
"current_config_id": "<string>",
"model": {
"provider_config": "<string>",
"name": "<string>"
},
"archived_at": "2023-11-07T05:31:56Z"
},
"agent_config": {
"id": "<string>",
"org_id": "<string>",
"project_id": "<string>",
"effective_definition_hash": "<string>",
"model": {
"provider_config": "<string>",
"name": "<string>",
"provider_model_slug": "<string>",
"configured_model_id": "<string>",
"current_revision_id": "<string>",
"api_format": "openai-responses",
"api_variant": "<string>",
"context_window_tokens": 123,
"max_output_tokens": 123,
"default_cache_retention": "none",
"supports_tools": true,
"supports_reasoning": true,
"default_reasoning_effort": "<string>",
"supported_reasoning_efforts": [
"<string>"
],
"input_modalities": [
"<string>"
],
"output_modalities": [
"<string>"
],
"default_max_output_tokens": 123
},
"created_at": "2023-11-07T05:31:56Z",
"source": "<string>",
"source_format": "yaml",
"compiler_version": "<string>",
"instruction_hash": "<string>",
"warnings": [
{
"message": "<string>",
"code": "missing_recommended_machine_tools"
}
]
},
"machine_bindings": [
{
"id": "<string>",
"project_id": "<string>",
"agent_id": "<string>",
"machine_id": "<string>",
"machine_ref": "<string>",
"binding_kind": "explicit",
"state": "attached",
"description": "<string>",
"cwd": "<string>",
"env_overlay": {},
"secret_env_overlay": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"agent_input": {
"id": "<string>",
"agent_id": "<string>",
"state": "<string>",
"delivery_mode": "queued",
"input_kind": "content",
"queued_at": "2023-11-07T05:31:56Z",
"actor_id": "<string>",
"content_blocks": [
{
"type": "text",
"text": "<string>",
"metadata": {}
}
]
}
}{
"error": "<string>",
"code": "invalid_request"
}{
"error": "<string>",
"code": "invalid_request"
}{
"error": "<string>",
"code": "invalid_request"
}{
"error": "<string>",
"code": "invalid_request"
}{
"error": "<string>",
"code": "invalid_request"
}{
"error": "<string>",
"code": "invalid_request"
}{
"error": "<string>",
"code": "invalid_request"
}{
"error": "<string>",
"code": "internal_error"
}Agents
Create agent
Reusing an idempotency key returns the current agent even if the retry body differs. The retry body is not applied.
POST
/
orgs
/
{orgID}
/
projects
/
{projectID}
/
agents
Create agent
curl --request POST \
--url https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/agents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"config": "<string>",
"profile": "<string>",
"name": "<string>",
"message": "<string>"
}
'import requests
url = "https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/agents"
payload = {
"config": "<string>",
"profile": "<string>",
"name": "<string>",
"message": "<string>"
}
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({config: '<string>', profile: '<string>', name: '<string>', message: '<string>'})
};
fetch('https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/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://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/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([
'config' => '<string>',
'profile' => '<string>',
'name' => '<string>',
'message' => '<string>'
]),
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://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/agents"
payload := strings.NewReader("{\n \"config\": \"<string>\",\n \"profile\": \"<string>\",\n \"name\": \"<string>\",\n \"message\": \"<string>\"\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://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/agents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"config\": \"<string>\",\n \"profile\": \"<string>\",\n \"name\": \"<string>\",\n \"message\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/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 \"config\": \"<string>\",\n \"profile\": \"<string>\",\n \"name\": \"<string>\",\n \"message\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"agent": {
"id": "<string>",
"org_id": "<string>",
"project_id": "<string>",
"state": "active",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"agent_profile_id": "<string>",
"integration_target": {
"provider": "<string>",
"provider_ref": "<string>",
"provider_ref_kind": "<string>",
"display_name": "<string>",
"provider_uri": "<string>"
},
"current_config_id": "<string>",
"model": {
"provider_config": "<string>",
"name": "<string>"
},
"archived_at": "2023-11-07T05:31:56Z"
}
}{
"agent": {
"id": "<string>",
"org_id": "<string>",
"project_id": "<string>",
"state": "active",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"agent_profile_id": "<string>",
"integration_target": {
"provider": "<string>",
"provider_ref": "<string>",
"provider_ref_kind": "<string>",
"display_name": "<string>",
"provider_uri": "<string>"
},
"current_config_id": "<string>",
"model": {
"provider_config": "<string>",
"name": "<string>"
},
"archived_at": "2023-11-07T05:31:56Z"
},
"agent_config": {
"id": "<string>",
"org_id": "<string>",
"project_id": "<string>",
"effective_definition_hash": "<string>",
"model": {
"provider_config": "<string>",
"name": "<string>",
"provider_model_slug": "<string>",
"configured_model_id": "<string>",
"current_revision_id": "<string>",
"api_format": "openai-responses",
"api_variant": "<string>",
"context_window_tokens": 123,
"max_output_tokens": 123,
"default_cache_retention": "none",
"supports_tools": true,
"supports_reasoning": true,
"default_reasoning_effort": "<string>",
"supported_reasoning_efforts": [
"<string>"
],
"input_modalities": [
"<string>"
],
"output_modalities": [
"<string>"
],
"default_max_output_tokens": 123
},
"created_at": "2023-11-07T05:31:56Z",
"source": "<string>",
"source_format": "yaml",
"compiler_version": "<string>",
"instruction_hash": "<string>",
"warnings": [
{
"message": "<string>",
"code": "missing_recommended_machine_tools"
}
]
},
"machine_bindings": [
{
"id": "<string>",
"project_id": "<string>",
"agent_id": "<string>",
"machine_id": "<string>",
"machine_ref": "<string>",
"binding_kind": "explicit",
"state": "attached",
"description": "<string>",
"cwd": "<string>",
"env_overlay": {},
"secret_env_overlay": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"agent_input": {
"id": "<string>",
"agent_id": "<string>",
"state": "<string>",
"delivery_mode": "queued",
"input_kind": "content",
"queued_at": "2023-11-07T05:31:56Z",
"actor_id": "<string>",
"content_blocks": [
{
"type": "text",
"text": "<string>",
"metadata": {}
}
]
}
}{
"error": "<string>",
"code": "invalid_request"
}{
"error": "<string>",
"code": "invalid_request"
}{
"error": "<string>",
"code": "invalid_request"
}{
"error": "<string>",
"code": "invalid_request"
}{
"error": "<string>",
"code": "invalid_request"
}{
"error": "<string>",
"code": "invalid_request"
}{
"error": "<string>",
"code": "invalid_request"
}{
"error": "<string>",
"code": "internal_error"
}Authorizations
bearerAuthbrowserSessionCookie & csrfHeader
An opaque Omnara personal or organization bearer token.
Headers
Idempotency key for replay-safe mutating requests.
Required string length:
1 - 255Path Parameters
Pattern:
^org_[a-z2-7]{26}$Pattern:
^proj_[a-z2-7]{26}$Body
application/json
Response
Current state of the previously created agent.
Show child attributes
Show child attributes
⌘I