AI Agents

AgentPreviewCreateRequest

object

Request body for creating an agent preview, which lets you try a prompt, capability, and properties before saving an agent. To run an existing preview against an asset, use ExecutionPreviewRequest.

promptTextstringrequired
agentCapabilitystringrequired

Allowed values:ENRICHMENT_AGENTTRANSFORMATION_AGENTBRAND_COMPLIANCE_AGENTGOVERNANCE_AGENTPATH_GENERATOR_AGENT

agentPropertiesobjectrequired
* Additional properties are allowed.
agentIdstring(uuid)
Example

ExecutionRequest

array

An array of per-agent run requests, not a single object. Each item must include its own agentId.

>= 1 items<= 100 items

agentIdstring(uuid)required
assetIdsarray[string](uuid)required

>= 1 items<= 10000 items

agentExecutionNamestring

<= 256 characters

workspaceBatchIdstring(uuid)

ExecutionRequestItem

object

A request to run one agent.

agentIdstring(uuid)required
assetIdsarray[string](uuid)required

>= 1 items<= 10000 items

agentExecutionNamestring

<= 256 characters

workspaceBatchIdstring(uuid)
Example

ExecutionPreviewRequest

object

Runs an existing preview (see AgentPreviewCreateRequest) against a single asset. Note the singular assetId, unlike the plural assetIds in ExecutionRequestItem.

previewIdstring(uuid)required
assetIdstring(uuid)required
Example

Execution

object

An agent execution.

idstring(uuid)
statusstring

Allowed values:RUNNINGACTION_REQUIREDCOMPLETED

agentIdstring(uuid)
agentNamestring
assetCountinteger
createdAtstring(date-time)
modifiedAtstring(date-time)
assetStatusCountsobject

Number of asset executions per status.

ranByobject

Who started the execution: a user or an automation rule.

Show Child Parameters
accountIdstring(uuid)
workspaceBatchIdstring(uuid)
agentCapabilitystring

Allowed values:ENRICHMENT_AGENTTRANSFORMATION_AGENTBRAND_COMPLIANCE_AGENTGOVERNANCE_AGENTPATH_GENERATOR_AGENT

Example