List agents

curl --request GET \
  --url https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/agents \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/agents"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/agents"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

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::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "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"
    }
  ],
  "next_cursor": "<string>"
}

{
  "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"
}

GET

orgs

{orgID}

projects

{projectID}

agents

List agents

curl --request GET \
  --url https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/agents \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/agents"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/agents"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

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::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "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"
    }
  ],
  "next_cursor": "<string>"
}

{
  "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

Authorization

string

header

required

An opaque Omnara personal or organization bearer token.

Path Parameters

orgID

string

required

Pattern: ^org_[a-z2-7]{26}$

projectID

string

required

Pattern: ^proj_[a-z2-7]{26}$

Query Parameters

name

string

Case-insensitive glob over the list's logical name. * matches zero or more characters, ? matches one character, and \ escapes a wildcard.

Required string length: 1 - 200

agent_profile_id

string

Return only agents launched from this agent profile.

Pattern: ^aprf_[a-z2-7]{26}$

sort

enum<string>

default:-created_at

Sort order for named resources that expose created and modified timestamps.

Available options:

name,

-name,

-updated_at,

updated_at,

-created_at,

created_at

limit

integer<int32>

default:50

Maximum number of items to return in one page.

Required range: 1 <= x <= 100

cursor

string

Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.

Maximum string length: 1024

Response

Active agents in the project, newest first.

data

object[]

required

Show child attributes

next_cursor

string | null

required

Opaque cursor for the next page, or null when this is the last page.

API reference

Endpoints

List agents

Authorizations

Path Parameters

Query Parameters

Response