Skip to main content
GET
/
v2
/
agents
/
{agent_key}
Get an agent
curl --request GET \
  --url https://api.orq.ai/v2/agents/{agent_key} \
  --header 'Authorization: Bearer <token>'
{
  "_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"
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
agent_key
string
required

The unique key of the agent to retrieve

Response

Agent retrieved successfully

​
_id
string
required
​
key
string
required
​
workspace_id
string
required
​
project_id
string
required
​
role
string
required
Minimum length: 1
​
description
string
required
​
instructions
string
required
​
status
enum<string>
required

The status of the agent. Live is the latest version of the agent. Draft is a version that is not yet published. Pending is a version that is pending approval. Published is a version that was live and has been replaced by a new version.

Available options:
live,
draft,
pending,
published
​
model
object
required
​
path
string
required

Entity storage path in the format: project/folder/subfolder/...

The first element identifies the project, followed by nested folders (auto-created as needed).

With project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key.

Example:

"Default"

​
memory_stores
string[]
required
​
team_of_agents
object[]
required

The agents that are accessible to this orchestrator. The main agent can hand off to these agents to perform tasks.

​
created_by_id
string | null
​
updated_by_id
string | null
​
created
string
​
updated
string
​
system_prompt
string
Minimum length: 1
​
settings
object
​
version_hash
string
​
metrics
object
​
variables
object

Extracted variables from agent instructions

​
knowledge_bases
object[]

Agent knowledge bases reference

​
hidden_panels
enum<string>[]

List of hidden collapsed panels in configuration. Duplicates are not allowed.