API ReferenceAop

Overwrite AOP configuration

Beta
Overwrite the configuration of an existing AOP asset. Replaces the entire AOP configuration (prompt, agent config, structured output, etc.) with the provided values. Fields not included in the request body will be reset to their defaults, except user_notification_configs, which is preserved from the existing configuration when omitted; send an explicit null to clear it. The update is rejected with 400 when the configuration would enable more tools at run time than the per-run limit, counting every tool of each toolkit @mentioned in the prompt; the detail names toolkits to remove and the existing configuration is left untouched.

Authentication

X-API-KEYstring
API Key authentication via header

Path parameters

asset_idstringRequired
Unique identifier of the AOP asset to update

Request

This endpoint expects an object.
agentIdstring or nullOptional
ID of the agent to use for execution
agent_configmap from strings to any or nullOptional
Full agent configuration override for this AOP
descriptionstring or nullOptional

Human-readable description of what the AOP does

iconstring or nullOptional
Icon identifier for UI display
promptstring or nullOptional

The main prompt/instructions for the AOP

sectionstring or nullOptional

Section/category for organization

structured_outputmap from strings to any or nullOptional
JSON schema for structured output
user_notification_configsmap from strings to maps from strings to any or nullOptional

Per-user notification preferences. Map of user_id -> notification config controlling who receives AOP result notifications. When omitted, the AOP’s existing notification configs are preserved; send an explicit null to clear them

Response

AOP configuration updated successfully
asset_idstring
ID of the AOP asset that was updated
messagestringOptionalDefaults to AOP configuration updated successfully

Human-readable status message

statusstringOptionalDefaults to updated
Status of the operation

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error