AgentPreview
objectAn agent preview.
idstring(uuid)read-only
agentIdstring(uuid)
promptIdstring(uuid)
promptTextstring
promptVersioninteger(int32)
agentCapabilitystring
Allowed values:ENRICHMENT_AGENTTRANSFORMATION_AGENTBRAND_COMPLIANCE_AGENTGOVERNANCE_AGENTPATH_GENERATOR_AGENT
agentPropertiesobject
* Additional properties are allowed.
createdAtstring(date-time)
Example
AgentPreviewCreateRequest
objectRequest 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
arrayAn 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
objectA request to run one agent.
agentIdstring(uuid)required
assetIdsarray[string](uuid)required
>= 1 items<= 10000 items
agentExecutionNamestring
<= 256 characters
workspaceBatchIdstring(uuid)
Example
ExecutionPreviewRequest
objectRuns 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