Skip to main content
POST
Execute an AOP

Authorizations

Authorization
string
header
required

Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.

Path Parameters

aopId
string
required

Body

application/json
dry_run
boolean
default:false

Execute as a Test run: the agent uses its real prompt, config, and read-only tools, but side-effectful tool calls are captured instead of executed.

user_inputs
object | null

Optional user inputs appended to the AOP prompt as key-value pairs.

organizationId
string

Required for session auth. Optional for API keys.

Maximum string length: 120

Response

Success

status
string
required
Example:

"started"

thread_id
string
required
sync_server
string
required

OmniCommerce origin. Clients can ignore this field.

trigger_type
string
required
Allowed value: "api"
aop_id
string
required
aop_title
string
required
base_prompt
string
required
final_prompt
string
required
aop_config
object
required
message
string
conversation
object