Get Agent Overlay

GET

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

const url = 'https://dashboard.quantcdn.io/api/v3/organizations/example/ai/agents/example/overlay';
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/example/overlay \
  --header 'Authorization: Bearer <token>'

Returns the per-organisation overlay for a global agent, plus base agent metadata for UI context. If no overlay exists the response contains overlay: null. Overlays can only be created for global agents.

Authorizations

BearerAuth

Parameters

Path Parameters

organisation

required

string

The organisation ID

agentId

required

string

Global agent identifier (e.g., ‘quantgov-code’)

Responses

200

Overlay retrieved (may be null if none set)

application/json

object

overlay

object

modelId

string

temperature

number

maxTokens

integer

disabledSkills

Array<string>

additionalSkills

Array<string>

additionalTools

Array<string>

disabledTools

Array<string>

systemPromptAppend

string

allowedCollections

Array<string>

mcpServers

Array<object>

object

server

string

tools

Array<string>

guardrailPreset

string

reasoningEffort

Reasoning effort for this organisation. Overrides the global agent value.

string

nullable

Allowed values: low medium high xhigh max

longContext

boolean

filterPolicies

Array<string>

version

integer

base

Base global agent metadata

object

agentId

string

name

string

modelId

string

allowedTools

Array<string>

assignedSkillIds

Array<string>

Example

{
  "overlay": {
    "reasoningEffort": "low"
  }
}

403

Access denied

404

Not a global agent

500

Failed to retrieve overlay