API ReferenceAop

Get AOP configuration

Beta
Retrieve the full configuration of an AOP asset by its ID. Returns prompt, agent config, structured output schema, and other settings.

Authentication

X-API-KEYstring
API Key authentication via header

Path parameters

asset_idstringRequired
Unique identifier of the AOP asset

Response

AOP configuration retrieved successfully
asset_idstring
ID of the AOP asset
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
descriptionstringOptionalDefaults to

Human-readable description of what the AOP does

iconstringOptionalDefaults to ListTodo
Icon identifier for UI display
promptstringOptionalDefaults to

The main prompt/instructions for the AOP

sectionstringOptionalDefaults to

Section/category for organization

structured_inputsmap from strings to any or nullOptional

Computed structured inputs schema (derived from prompt template placeholders)

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

Title/name of the AOP

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

Errors

403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error