Skip to content

Upsert Agent Overlay

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

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.

Authorizations

Parameters

Path Parameters

organisation
required
string

The organisation ID

agentId
required
string

Global agent identifier

Request Body required

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
Allowed values: official official-sensitive protected
version

Current version for optimistic concurrency

integer

Responses

200

Overlay created or updated

object
overlay
object

400

Invalid request parameters

403

Access denied

404

Not a global agent

409

Version conflict — overlay was modified concurrently

500

Failed to save overlay