AI Agents

PromptInput

object

The prompt to set on an agent when you create or edit it. Unlike the read-only Prompt in responses, id and version are optional here.

idstring(uuid)
versioninteger(int32)
textstringrequired

<= 10000 characters

Example

AgentPreview

object

An 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

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