List agents

GET

agents

List agents

curl --request GET \
  --url https://api.orq.ai/v2/agents \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.orq.ai/v2/agents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.orq.ai/v2/agents"

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

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

print(response.text)

{
  "object": "list",
  "data": [
    {
      "_id": "<string>",
      "key": "<string>",
      "path": "Default",
      "skills": [
        "<string>"
      ],
      "role": "<string>",
      "description": "<string>",
      "instructions": "<string>",
      "model": {
        "id": "<string>",
        "integration_id": "<string>",
        "parameters": {
          "name": "<string>",
          "frequency_penalty": 123,
          "max_tokens": 123,
          "max_completion_tokens": 123,
          "presence_penalty": 123,
          "response_format": {
            "type": "text"
          },
          "verbosity": "<string>",
          "seed": 123,
          "stop": "<string>",
          "thinking": {
            "type": "disabled"
          },
          "temperature": 1,
          "top_p": 0.5,
          "top_k": 123,
          "parallel_tool_calls": true,
          "modalities": [],
          "guardrails": [
            {}
          ],
          "plugins": [
            {
              "id": "pii_redaction",
              "threshold": 0.5,
              "entities": []
            }
          ],
          "fallbacks": [
            {
              "model": "openai/gpt-4o-mini"
            }
          ],
          "cache": {
            "type": "exact_match",
            "ttl": 3600
          },
          "load_balancer": {
            "type": "weight_based",
            "models": [
              {
                "model": "openai/gpt-4o",
                "weight": 0.7
              },
              {
                "model": "anthropic/claude-3-5-sonnet",
                "weight": 0.3
              }
            ]
          },
          "timeout": {
            "call_timeout": 30000
          },
          "cache_control": {
            "type": "ephemeral",
            "ttl": "5m"
          },
          "prompt_cache_key": "<string>"
        },
        "retry": {
          "count": 3,
          "on_codes": [
            429,
            500,
            502,
            503,
            504
          ]
        },
        "fallback_models": [
          "<string>"
        ]
      },
      "display_name": "<string>",
      "created_by_id": "<string>",
      "updated_by_id": "<string>",
      "created": "<string>",
      "updated": "<string>",
      "version": "<string>",
      "memory_stores": [],
      "team_of_agents": [],
      "metrics": {
        "total_cost": 0
      },
      "variables": {},
      "knowledge_bases": [
        {
          "knowledge_id": "customer-knowledge-base"
        }
      ],
      "engine": "text",
      "type": "internal",
      "system_prompt": "<string>",
      "settings": {
        "max_execution_time": 600,
        "max_iterations": 100,
        "max_cost": 0,
        "tool_approval_required": "respect_tool",
        "tools": []
      }
    }
  ],
  "has_more": true
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit

number

A limit on the number of objects to be returned. Limit can range between 1 and 200. When not provided, returns all agents without pagination.

Required range: 1 <= x <= 200

starting_after

string

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with 01JJ1HDHN79XAS7A01WB3HYSDB, your subsequent call can include after=01JJ1HDHN79XAS7A01WB3HYSDB in order to fetch the next page of the list.

ending_before

string

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with 01JJ1HDHN79XAS7A01WB3HYSDB, your subsequent call can include before=01JJ1HDHN79XAS7A01WB3HYSDB in order to fetch the previous page of the list.

type

enum<string>

Filter agents by type

Available options:

internal

Response

200 - application/json

Successfully retrieved the list of agents. Returns a paginated response containing agent manifests with complete configurations, including primary and fallback models, tools, knowledge bases, and execution settings.

object

enum<string>

required

Available options:

list

data

object[]

required

Show child attributes

has_more

boolean

required

Orq CLI

Create agent

⌘I

List agents

curl --request GET \
  --url https://api.orq.ai/v2/agents \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.orq.ai/v2/agents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.orq.ai/v2/agents"

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

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

print(response.text)

{
  "object": "list",
  "data": [
    {
      "_id": "<string>",
      "key": "<string>",
      "path": "Default",
      "skills": [
        "<string>"
      ],
      "role": "<string>",
      "description": "<string>",
      "instructions": "<string>",
      "model": {
        "id": "<string>",
        "integration_id": "<string>",
        "parameters": {
          "name": "<string>",
          "frequency_penalty": 123,
          "max_tokens": 123,
          "max_completion_tokens": 123,
          "presence_penalty": 123,
          "response_format": {
            "type": "text"
          },
          "verbosity": "<string>",
          "seed": 123,
          "stop": "<string>",
          "thinking": {
            "type": "disabled"
          },
          "temperature": 1,
          "top_p": 0.5,
          "top_k": 123,
          "parallel_tool_calls": true,
          "modalities": [],
          "guardrails": [
            {}
          ],
          "plugins": [
            {
              "id": "pii_redaction",
              "threshold": 0.5,
              "entities": []
            }
          ],
          "fallbacks": [
            {
              "model": "openai/gpt-4o-mini"
            }
          ],
          "cache": {
            "type": "exact_match",
            "ttl": 3600
          },
          "load_balancer": {
            "type": "weight_based",
            "models": [
              {
                "model": "openai/gpt-4o",
                "weight": 0.7
              },
              {
                "model": "anthropic/claude-3-5-sonnet",
                "weight": 0.3
              }
            ]
          },
          "timeout": {
            "call_timeout": 30000
          },
          "cache_control": {
            "type": "ephemeral",
            "ttl": "5m"
          },
          "prompt_cache_key": "<string>"
        },
        "retry": {
          "count": 3,
          "on_codes": [
            429,
            500,
            502,
            503,
            504
          ]
        },
        "fallback_models": [
          "<string>"
        ]
      },
      "display_name": "<string>",
      "created_by_id": "<string>",
      "updated_by_id": "<string>",
      "created": "<string>",
      "updated": "<string>",
      "version": "<string>",
      "memory_stores": [],
      "team_of_agents": [],
      "metrics": {
        "total_cost": 0
      },
      "variables": {},
      "knowledge_bases": [
        {
          "knowledge_id": "customer-knowledge-base"
        }
      ],
      "engine": "text",
      "type": "internal",
      "system_prompt": "<string>",
      "settings": {
        "max_execution_time": 600,
        "max_iterations": 100,
        "max_cost": 0,
        "tool_approval_required": "respect_tool",
        "tools": []
      }
    }
  ],
  "has_more": true
}

Orq SDK

Orq CLI

Platform APIs

Gateway APIs

Enterprise APIs (coming soon)

Authorizations

Query Parameters

Response