v2

latestOpenAPI 3.1.02026-08-014610794.4 KB
agents

Update Agent

patch/api/v1/agents/{agent_id}

Path parameters

agent_idstring uuid4 required

Request body

namestring nullable

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.

descriptionstring nullable
status'ACTIVE' | 'ARCHIVED' nullable
autoConfirmboolean nullable

Response

Successful Response

idstring uuid4
createdAtstring date-time
updatedAtstring date-time
namestring 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'ACTIVE' | 'ARCHIVED' required
autoConfirmboolean required

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

descriptionstring
workspaceIdstring uuid4 required
folderPathstring nullable