Get Agent Details

GET

/api/v3/organizations/{organisation}/ai/agents/{agentId}

const url = 'https://dashboard.quantcdn.io/api/v3/organizations/example/ai/agents/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://dashboard.quantcdn.io/api/v3/organizations/example/ai/agents/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Retrieves detailed configuration for a specific AI agent.

Authorizations

BearerAuth

Parameters

Path Parameters

organisation

required

string

The organisation ID

agentId

required

string format: uuid

The agent ID

Responses

200

Agent details retrieved successfully

application/json

object

agent

object

agentId

string format: uuid

name

string

description

string

group

string

systemPrompt

string

modelId

string

temperature

number

maxTokens

integer

allowedTools

Array<string>

allowedCollections

Array<string>

assignedSkills

Array<string>

longContext

Whether 1M context window is enabled

boolean

reasoningEffort

Reasoning effort (Anthropic effort). Must be one of the levels the model lists in capabilities.effortLevels. Unset uses the caller or model default.

string

nullable

Allowed values: low medium high xhigh max

guardrailPreset

Guardrail preset name

string

isGlobal

Whether this is a platform-managed global agent

boolean

hasOverlay

Whether the requesting org has a per-org overlay for this global agent

boolean

createdBy

string

createdAt

string format: date-time

updatedAt

string format: date-time

Example

{
  "agent": {
    "reasoningEffort": "low"
  }
}

403

Access denied

404

Agent not found

500

Failed to retrieve agent