AI Agents

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

PaginatedExecutions

object

A page of executions. metadata.nextPage is a query string to add to the same request URL, or null on the last page.

itemsarray[object]

An agent execution.

Show Child Parameters
metadataobject
Show Child Parameters
Example

AssetExecution

object

The execution of an agent on a single asset, including capability-specific results (for example, suggestions for the enrichment capability).

idstring(uuid)
agentExecutionIdstring(uuid)
assetIdstring(uuid)
statusstring

The status of the asset execution.

Allowed values:SCHEDULEDRUNNINGFAILEDCOMPLETEDACCEPTEDAUTO_APPLIEDDISCARDEDCANCELEDREVERTED

createdAtstring(date-time)
resultsobject
* Additional properties are allowed.
assetNamestring
draftboolean
removedboolean
errorCodestring
agentTypestring

Allowed values:ENRICHMENT_AGENTTRANSFORMATION_AGENTBRAND_COMPLIANCE_AGENTGOVERNANCE_AGENTPATH_GENERATOR_AGENT

thumbnailobject
Show Child Parameters
Example