Skip to content

Upsert Agent Overlay

PUT
/api/v3/organizations/{organisation}/ai/agents/{agentId}/overlay
curl --request PUT \
--url https://dashboard.quantcdn.io/api/v3/organizations/example/ai/agents/example/overlay \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "modelId": "example", "temperature": 1, "maxTokens": 1, "disabledSkills": [ "example" ], "additionalSkills": [ "example" ], "additionalTools": [ "example" ], "disabledTools": [ "example" ], "systemPromptAppend": "example", "allowedCollections": [ "example" ], "guardrailPreset": "official", "version": 1 }'

Creates or replaces the per-organisation overlay for a global agent. PUT is full replacement — omitted optional fields are removed. Include version from a prior GET to enable compare-and-swap (409 on conflict). Omit for last-writer-wins.

organisation
required
string

The organisation ID

agentId
required
string

Global agent identifier

Media typeapplication/json
object
modelId

Override the base agent’s model

string
temperature

Override temperature

number
<= 1
maxTokens

Override max tokens

integer
>= 1
disabledSkills

Global skill IDs to exclude

Array<string>
additionalSkills

Org-owned skill IDs to add

Array<string>
additionalTools

Tool names to add

Array<string>
disabledTools

Tool names to remove

Array<string>
systemPromptAppend

Text appended to base system prompt

string
allowedCollections

Vector DB collections

Array<string>
guardrailPreset

Guardrail preset

string
nullable
Allowed values: official official-sensitive protected
version

Current version for optimistic concurrency

integer

Overlay created or updated

Media typeapplication/json
object
overlay
object
Examplegenerated
{
"overlay": {}
}

Invalid request parameters

Access denied

Not a global agent

Version conflict — overlay was modified concurrently

Failed to save overlay