Skip to main content
PATCH
Update Agent

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agent_id
string<uuid4>
required

Body

application/json
name
string | null

The name of the agent. The name must only contain the following characters: a-z, A-Z, 0-9, -, _, and space. The name must not be empty. The name must start and end with a letter or a number. The name must not be longer than 64 characters.

Pattern: ^[a-zA-Z0-9]([a-zA-Z0-9-_. ]{0,62}[a-zA-Z0-9])?$
description
string | null
default:""
Maximum string length: 1024
status
enum<string> | null
Available options:
ACTIVE,
ARCHIVED
emailTrigger
EmailAgentTriggerUpdate · object | null
autoConfirm
boolean | null

Response

Successful Response

name
string
required

The name of the agent. The name must only contain the following characters: a-z, A-Z, 0-9, -, _, and space. The name must not be empty. The name must start and end with a letter or a number. The name must not be longer than 64 characters.

Pattern: ^[a-zA-Z0-9]([a-zA-Z0-9-_. ]{0,62}[a-zA-Z0-9])?$
status
enum<string>
required
Available options:
ACTIVE,
ARCHIVED
autoConfirm
boolean
required

If true, the agent will automatically confirm the data extracted, i.e., no review is necessary.

emailTrigger
EmailAgentTrigger · object
required
dataDestinations
(DataDestinationAskUiWorkflow · object | DataDestinationWebhook · object)[]
required
workspaceId
string<uuid4>
required
id
string<uuid4>
createdAt
string<date-time>
updatedAt
string<date-time>
description
string
default:""
Maximum string length: 1024
dataSchema
JsonSchema · object | null
folderPath
string | null