List Agents

GET

api

agents

{
  "data": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "status": "ACTIVE",
      "autoConfirm": true,
      "description": "",
      "emailTrigger": {
        "active": true,
        "allowedSenders": [
          "<string>"
        ],
        "email": "<string>"
      },
      "dataSchema": {
        "title": "DataToExtract",
        "description": "",
        "type": "object",
        "properties": {},
        "required": [
          "<string>"
        ]
      },
      "dataDestinations": [
        {
          "type": "ASKUI_WORKFLOW",
          "host": "SELF",
          "runnerTags": [
            "<string>"
          ],
          "workflows": [
            "<string>"
          ]
        }
      ],
      "workspaceId": "<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[] | null

workspace_id

string[] | null

status

enum<string>[] | null

Available options:

ACTIVE,

ARCHIVED

skip

integer

default:

Required range: x >= 0

limit

integer

default:

100

Required range: 1 <= x <= 100

expand

enum<string>[] | null

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

Available options:

total_count

Response

200

application/json

Successful Response

data

object[]

required

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

object

required

data.dataDestinations

object[]

required

data.workspaceId

string

required

data.id

string

data.createdAt

string

data.updatedAt

string

data.description

string

default:

Maximum length: 1024

data.dataSchema

object | null

        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.

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

{
  "data": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "status": "ACTIVE",
      "autoConfirm": true,
      "description": "",
      "emailTrigger": {
        "active": true,
        "allowedSenders": [
          "<string>"
        ],
        "email": "<string>"
      },
      "dataSchema": {
        "title": "DataToExtract",
        "description": "",
        "type": "object",
        "properties": {},
        "required": [
          "<string>"
        ]
      },
      "dataDestinations": [
        {
          "type": "ASKUI_WORKFLOW",
          "host": "SELF",
          "runnerTags": [
            "<string>"
          ],
          "workflows": [
            "<string>"
          ]
        }
      ],
      "workspaceId": "<string>",
      "folderPath": "<string>"
    }
  ],
  "hasMore": false,
  "totalCount": 123
}

Python Vision Agent

AskUI Suite

Workspace Services API

Authorizations

Query Parameters

Response