List Agents

curl --request GET \
  --url https://api.example.com/api/v1/agents \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "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>"
    }
  ],
  "hasMore": false,
  "totalCount": 123
}

GET

api

agents

List Agents

curl --request GET \
  --url https://api.example.com/api/v1/agents \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "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>"
    }
  ],
  "hasMore": false,
  "totalCount": 123
}

Authorizations

Authorization

string

header

required

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

Query Parameters

agent_id

string<uuid4>[] | null

workspace_id

string<uuid4>[] | null

status

enum<string>[] | null

Available options:

ACTIVE,

ARCHIVED

skip

integer

default:0

Required range: x >= 0

limit

integer

default:100

Required range: 1 <= x <= 100

expand

string[] | null

total_count: Include the total number of agents that match the query, only accurate up to 100.

Allowed value: "total_count"

Response

Successful Response

data

Agent · object[]

required

Show child attributes

data.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.

data.status

enum<string>

required

Available options:

ACTIVE,

ARCHIVED

data.autoConfirm

boolean

required

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

data.emailTrigger

EmailAgentTrigger · object

required

Show child attributes

data.emailTrigger.email

string

required

The email address of the agent to send emails to to trigger the agent. The email address must be unique for each agent. The domain of the email address is fixed. The local part of the email address must be between 1 and 64 characters long and can only contain the following characters: a-z, A-Z, 0-9, -, _, . and +.

data.emailTrigger.active

boolean

default:true

If false, no emails can be send to trigger agent.

data.emailTrigger.allowedSenders

string[]

The email addresses that are allowed to send emails to trigger the agent. If empty, no emails can be send to trigger agent.

data.dataDestinations

(DataDestinationAskUiWorkflow · object | DataDestinationWebhook · object)[]

required

DataDestinationAskUiWorkflow
DataDestinationWebhook

Show child attributes

data.dataDestinations.host

enum<string>

required

Available options:

SELF,

ASKUI

data.dataDestinations.runnerTags

string[]

required

data.dataDestinations.workflows

string[]

required

Minimum array length: 1

data.dataDestinations.type

string

default:ASKUI_WORKFLOW

Allowed value: "ASKUI_WORKFLOW"

data.workspaceId

string<uuid4>

required

data.id

string<uuid4>

data.createdAt

string<date-time>

data.updatedAt

string<date-time>

data.description

string

default:""

Maximum string length: 1024

data.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.

Show child attributes

data.dataSchema.properties

Properties · object

required

Show child attributes

data.dataSchema.properties.{key}

object

data.dataSchema.title

string

default:DataToExtract

data.dataSchema.description

string

default:""

data.dataSchema.type

string

default:object

Allowed value: "object"

data.dataSchema.required

string[]

data.folderPath

string | null

hasMore

boolean

default:false

Whether there are more agents that match the query that were not included in this response.

totalCount

integer | null

The total number of agents that match the query, only accurate up to 100.

Create Agent Update Agent

⌘I

Python Vision Agent

AskUI Suite

Workspace Services API

List Agents

Authorizations

Query Parameters

Response