Skip to main content
PATCH
/
api
/
v1
/
agents
/
{agent_id}
Update Agent
curl --request PATCH \
  --url https://api.example.com/api/v1/agents/{agent_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "",
  "status": "ACTIVE",
  "emailTrigger": {
    "active": true,
    "allowedSenders": [
      "<string>"
    ],
    "localPart": "<string>"
  },
  "autoConfirm": true
}
'
{
  "name": "<string>",
  "status": "ACTIVE",
  "autoConfirm": true,
  "emailTrigger": {
    "email": "<string>",
    "active": true,
    "allowedSenders": [
      "<string>"
    ]
  },
  "dataDestinations": [
    {
      "host": "SELF",
      "runnerTags": [
        "<string>"
      ],
      "workflows": [
        "<string>"
      ],
      "type": "ASKUI_WORKFLOW"
    }
  ],
  "workspaceId": "<string>",
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "description": "",
  "dataSchema": {
    "properties": {},
    "title": "DataToExtract",
    "description": "",
    "type": "object",
    "required": [
      "<string>"
    ]
  },
  "folderPath": "<string>"
}

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.

​
description
string | null
default:""
Maximum string length: 1024
​
status
enum<string> | null
Available options:
ACTIVE,
ARCHIVED
​
emailTrigger
EmailAgentTriggerUpdate · object
​
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.

​
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
The data schema describes the data to extract in form of a [JSON schema draft 2020-12](https://json-schema.org/draft/2020-12/release-notes). Use the ["description" keyword](https://json-schema.org/understanding-json-schema/reference/annotations) of each property to provide additional information about the field, e.g., the prompt for extraction from sources.
​
folderPath
string | null