Sign in

v2

latestOpenAPI 3.1.02026-08-014610794.4 KB
agents

Create Agent

post/api/v1/agents

Request body

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.

descriptionstring
autoConfirmboolean

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

parentIdstring uuid4 nullable

The ID of an agent that this agent is created from, i.e., of the previous version of this agent. Parent is going to be archived as part of the creation of the new (active) agent.

workspaceIdstring uuid4 required
templateIdstring required

The ID of the template to copy files from.

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