AI Agents

PaginatedAgents

object

A page of agents.

itemsarray[object]

An agent.

Show Child Parameters
metadataobject
Show Child Parameters
Example

Prompt

object

An agent prompt.

idstring(uuid)read-only
textstring
versioninteger(int32)read-only
isActivebooleanread-only
createdAtstring(date-time)
modifiedAtstring(date-time)
Example

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