Genai Agents Query

POST /agents/query

Genai Agents Query

cURL

curl --request POST \
  --url https://api.example.com/agents/query \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "<string>",
  "filters": {
    "agent_name": "<string>"
  },
  "sort_by": [
    {
      "field": "<string>",
      "direction": "desc"
    }
  ],
  "limit": 100,
  "offset": 0
}
'

import requests

url = "https://api.example.com/agents/query"

payload = {
    "project_id": "<string>",
    "filters": { "agent_name": "<string>" },
    "sort_by": [
        {
            "field": "<string>",
            "direction": "desc"
        }
    ],
    "limit": 100,
    "offset": 0
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    project_id: '<string>',
    filters: {agent_name: '<string>'},
    sort_by: [{field: '<string>', direction: 'desc'}],
    limit: 100,
    offset: 0
  })
};

fetch('https://api.example.com/agents/query', 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.example.com/agents/query",
  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([
    'project_id' => '<string>',
    'filters' => [
        'agent_name' => '<string>'
    ],
    'sort_by' => [
        [
                'field' => '<string>',
                'direction' => 'desc'
        ]
    ],
    'limit' => 100,
    'offset' => 0
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "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.example.com/agents/query"

	payload := strings.NewReader("{\n  \"project_id\": \"<string>\",\n  \"filters\": {\n    \"agent_name\": \"<string>\"\n  },\n  \"sort_by\": [\n    {\n      \"field\": \"<string>\",\n      \"direction\": \"desc\"\n    }\n  ],\n  \"limit\": 100,\n  \"offset\": 0\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	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.example.com/agents/query")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"project_id\": \"<string>\",\n  \"filters\": {\n    \"agent_name\": \"<string>\"\n  },\n  \"sort_by\": [\n    {\n      \"field\": \"<string>\",\n      \"direction\": \"desc\"\n    }\n  ],\n  \"limit\": 100,\n  \"offset\": 0\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/agents/query")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"project_id\": \"<string>\",\n  \"filters\": {\n    \"agent_name\": \"<string>\"\n  },\n  \"sort_by\": [\n    {\n      \"field\": \"<string>\",\n      \"direction\": \"desc\"\n    }\n  ],\n  \"limit\": 100,\n  \"offset\": 0\n}"

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

200

{
  "agents": [
    {
      "project_id": "<string>",
      "agent_name": "<string>",
      "invocation_count": 123,
      "span_count": 123,
      "total_input_tokens": 123,
      "total_output_tokens": 123,
      "total_duration_ms": 123,
      "error_count": 123,
      "first_seen": "2023-11-07T05:31:56Z",
      "last_seen": "2023-11-07T05:31:56Z"
    }
  ],
  "total_count": 0
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

HTTPBasicHTTPBearer

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

Request to list agents with aggregated stats for a project.

project_id · string · required

filters · AgentsQueryFilters · object | null

Optional filters for querying agents.

Show child attributes

sort_by · AgentSortBy · object[] | null

Show child attributes

limit · integer · default: 100

Required range: 0 <= x <= 10000

offset · integer · default: 0

Required range: x >= 0

Response

200

application/json

Successful Response

Response containing aggregated agent stats.

agents · AgentSchema · object[] · required

Show child attributes

total_count · integer · default: 0