Get Agent Overlay

GET

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

curl --request GET \
  --url https://dashboard.quantcdn.io/api/v3/organizations/example/ai/agents/example/overlay \
  --header 'Authorization: Bearer <token>'

• 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)

Media typeapplication/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>

guardrailPreset

string

version

integer

base

Base global agent metadata

object

agentId

string

name

string

modelId

string

allowedTools

Array<string>

assignedSkillIds

Array<string>

Example^generated

{
  "overlay": {
    "modelId": "example",
    "temperature": 1,
    "maxTokens": 1,
    "disabledSkills": [
      "example"
    ],
    "additionalSkills": [
      "example"
    ],
    "additionalTools": [
      "example"
    ],
    "disabledTools": [
      "example"
    ],
    "systemPromptAppend": "example",
    "allowedCollections": [
      "example"
    ],
    "guardrailPreset": "example",
    "version": 1
  },
  "base": {
    "agentId": "example",
    "name": "example",
    "modelId": "example",
    "allowedTools": [
      "example"
    ],
    "assignedSkillIds": [
      "example"
    ]
  }
}

403

Access denied

404

Not a global agent

500

Failed to retrieve overlay