Skip to main content
GET
/
v2
/
agents
/
List all agents
curl --request GET \
  --url https://api.orq.ai/v2/agents/ \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "_id": "<string>",
      "key": "<string>",
      "workspace_id": "<string>",
      "project_id": "<string>",
      "created_by_id": "<string>",
      "updated_by_id": "<string>",
      "created": "<string>",
      "updated": "<string>",
      "role": "<string>",
      "description": "<string>",
      "system_prompt": "<string>",
      "instructions": "<string>",
      "status": "live",
      "settings": {
        "max_execution_time": 300,
        "max_iterations": 15,
        "tool_approval_required": "respect_tool",
        "tools": []
      },
      "model": {
        "id": "<string>",
        "integration_id": "<string>",
        "fallback_models": [
          "<string>"
        ],
        "max_tokens": 123,
        "temperature": 1
      },
      "version_hash": "<string>",
      "path": "Default",
      "memory_stores": [
        "<string>"
      ],
      "team_of_agents": [
        {
          "key": "<string>",
          "role": "<string>"
        }
      ],
      "metrics": {
        "total_cost": 0
      },
      "variables": {},
      "knowledge_bases": [
        {
          "knowledge_id": "customer-knowledge-base"
        }
      ],
      "hidden_panels": [
        "model"
      ]
    }
  ],
  "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
default:10

A limit on the number of objects to be returned. Limit can range between 1 and 50, and the default is 10

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.

Response

200 - application/json

List of agents with their configurations including fallback models

object
enum<string>
required
Available options:
list
data
object[]
required
has_more
boolean
required