Get Agent Overlay

GET

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

• QuantCDN Public Cloud
• QuantGov Cloud

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)

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>

guardrailPreset

string

version

integer

base

Base global agent metadata

object

agentId

string

name

string

modelId

string

allowedTools

Array<string>

assignedSkillIds

Array<string>

403

Access denied

404

Not a global agent

500

Failed to retrieve overlay