API

Every browseai.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Monitors

create

monitors.create Create a robot monitor Risk: write

await corsair.browseai.api.monitors.create({});

Input

Name	Type	Required	Description
`robotId`	`string`	Yes	—
`name`	`string`	Yes	—
`inputParameters`	`object`	Yes	—
`notifyOnCapturedScreenshotChange`	`boolean`	Yes	—
`notifyOnCapturedTextChange`	`boolean`	Yes	—
`capturedScreenshotNotificationThreshold`	`number`	Yes	—
`schedule`	`string`	No	—
`schedules`	`object[]`	No	—

inputParameters full type

{
}

schedules full type

{
  type: FIXED_INTERVAL,
  everyMinutes: number
}[]

Output

Name	Type	Required	Description
`statusCode`	`number`	No	—
`messageCode`	`string`	No	—
`monitor`	`object`	No	—

monitor full type

{
  id?: string | null,
  name?: string | null,
  status?: string | null,
  pausedReason?: string | null,
  inputParameters?: {
  } | null,
  schedules?: {
    type?: string | null,
    everyMinutes?: number | null
  }[] | null,
  schedule?: string | null,
  notifyOnCapturedScreenshotChange?: boolean | null,
  notifyOnCapturedTextChange?: boolean | null,
  capturedScreenshotNotificationThreshold?: number | null,
  createdAt?: number | null,
  pausedAt?: number | null,
  updatedAt?: number | null
}

delete

monitors.delete Delete a robot monitor Risk: write

await corsair.browseai.api.monitors.delete({});

Input

Name	Type	Required	Description
`robotId`	`string`	Yes	—
`monitorId`	`string`	Yes	—

Output

Name	Type	Required	Description
`statusCode`	`number`	No	—
`messageCode`	`string`	No	—

Robots

bulkRun

robots.bulkRun Start a bulk run of robot tasks Risk: write

await corsair.browseai.api.robots.bulkRun({});

Input

Name	Type	Required	Description
`robotId`	`string`	Yes	—
`title`	`string`	No	—
`inputParameters`	`object[]`	Yes	—

inputParameters full type

{
}[]

Output

Name	Type	Required	Description
`statusCode`	`number`	No	—
`messageCode`	`string`	No	—
`result`	`object`	No	—

result full type

{
  bulkRun?: {
    id?: string | null,
    title?: string | null,
    status?: string | null,
    tasksCount?: number | null,
    successfulTasks?: number | null,
    failedTasks?: number | null,
    robotId?: string | null,
    createdAt?: number | null
  } | null
}

list

robots.list List robots on the account Risk: read

await corsair.browseai.api.robots.list({});

Input: empty object Output

Name	Type	Required	Description
`statusCode`	`number`	No	—
`messageCode`	`string`	No	—
`robots`	`object`	No	—

robots full type

{
  totalCount?: number | null,
  items?: {
    id?: string | null,
    name?: string | null,
    createdAt?: number | null,
    inputParameters?: {
      type?: string | null,
      name?: string | null,
      label?: string | null,
      required?: boolean | null,
      encrypted?: boolean | null,
      defaultValue?: string | number | string[] | null,
      value?: string | number | string[] | null,
      min?: number | null,
      max?: number | null,
      pattern?: string | null,
      options?: {
        label?: string | null,
        value?: string | null
      }[] | null
    }[] | null
  }[] | null
}

run

robots.run Start a robot task Risk: write

await corsair.browseai.api.robots.run({});

Input

Name	Type	Required	Description
`robotId`	`string`	Yes	—
`recordVideo`	`boolean`	No	—
`inputParameters`	`object`	No	—

inputParameters full type

{
}

Output

Name	Type	Required	Description
`statusCode`	`number`	No	—
`messageCode`	`string`	No	—
`result`	`object`	No	—

result full type

{
  id?: string | null,
  inputParameters?: {
  } | null,
  robotId?: string | null,
  status?: string | null,
  runByUserId?: string | null,
  robotBulkRunId?: string | null,
  runByTaskMonitorId?: string | null,
  runByAPI?: boolean | null,
  createdAt?: number | null,
  startedAt?: number | null,
  finishedAt?: number | null,
  userFriendlyError?: string | null,
  triedRecordingVideo?: boolean | null,
  videoUrl?: string | null,
  videoRemovedAt?: number | null,
  retriedOriginalTaskId?: string | null,
  retriedTaskId?: string | null,
  retriedByTaskId?: string | null,
  capturedDataTemporaryUrl?: string | null,
  capturedTexts?: {
  } | null,
  capturedScreenshots?: {
  } | null,
  capturedLists?: {
  } | null
}

System

getStatus

system.getStatus Check Browse AI task-queue status Risk: read

await corsair.browseai.api.system.getStatus({});

Input: empty object Output

Name	Type	Required	Description
`statusCode`	`number`	No	—
`messageCode`	`string`	No	—
`tasksQueueStatus`	`string`	No	—

Tasks

get

tasks.get Get a robot task by id Risk: read

await corsair.browseai.api.tasks.get({});

Input

Name	Type	Required	Description
`robotId`	`string`	Yes	—
`taskId`	`string`	Yes	—

Output

Name	Type	Required	Description
`statusCode`	`number`	No	—
`messageCode`	`string`	No	—
`result`	`object`	No	—

result full type

{
  id?: string | null,
  inputParameters?: {
  } | null,
  robotId?: string | null,
  status?: string | null,
  runByUserId?: string | null,
  robotBulkRunId?: string | null,
  runByTaskMonitorId?: string | null,
  runByAPI?: boolean | null,
  createdAt?: number | null,
  startedAt?: number | null,
  finishedAt?: number | null,
  userFriendlyError?: string | null,
  triedRecordingVideo?: boolean | null,
  videoUrl?: string | null,
  videoRemovedAt?: number | null,
  retriedOriginalTaskId?: string | null,
  retriedTaskId?: string | null,
  retriedByTaskId?: string | null,
  capturedDataTemporaryUrl?: string | null,
  capturedTexts?: {
  } | null,
  capturedScreenshots?: {
  } | null,
  capturedLists?: {
  } | null
}

list

tasks.list List tasks for a robot Risk: read

await corsair.browseai.api.tasks.list({});

Input

Name	Type	Required	Description
`robotId`	`string`	Yes	—
`page`	`number`	No	—
`pageSize`	`number`	No	—
`status`	`failed \| successful \| in-progress`	No	—
`robotBulkRunId`	`string`	No	—
`sort`	`string`	No	—
`includeRetried`	`boolean`	No	—
`fromDate`	`number`	No	—
`toDate`	`number`	No	—

Output

Name	Type	Required	Description
`statusCode`	`number`	No	—
`messageCode`	`string`	No	—
`result`	`object`	No	—

result full type

{
  robotTasks?: {
    totalCount?: number | null,
    pageNumber?: number | null,
    hasMore?: boolean | null,
    items?: {
      id?: string | null,
      inputParameters?: {
      } | null,
      robotId?: string | null,
      status?: string | null,
      runByUserId?: string | null,
      robotBulkRunId?: string | null,
      runByTaskMonitorId?: string | null,
      runByAPI?: boolean | null,
      createdAt?: number | null,
      startedAt?: number | null,
      finishedAt?: number | null,
      userFriendlyError?: string | null,
      triedRecordingVideo?: boolean | null,
      videoUrl?: string | null,
      videoRemovedAt?: number | null,
      retriedOriginalTaskId?: string | null,
      retriedTaskId?: string | null,
      retriedByTaskId?: string | null,
      capturedDataTemporaryUrl?: string | null,
      capturedTexts?: {
      } | null,
      capturedScreenshots?: {
      } | null,
      capturedLists?: {
      } | null
    }[] | null
  } | null
}

Webhooks

create

webhooks.create Create a robot webhook Risk: write

await corsair.browseai.api.webhooks.create({});

Input

Name	Type	Required	Description
`robotId`	`string`	Yes	—
`hookUrl`	`string`	Yes	—
`eventType`	`taskCapturedDataChanged \| taskFinished \| taskFinishedSuccessfully \| taskFinishedWithError \| tableExportFinishedSuccessfully`	Yes	—

Output

Name	Type	Required	Description
`statusCode`	`number`	No	—
`messageCode`	`string`	No	—
`webhook`	`object`	No	—

webhook full type

{
  id?: string | null,
  url?: string | null,
  webhookEvent?: string | null,
  createdAt?: number | null
}

list

webhooks.list List webhooks for a robot Risk: read

await corsair.browseai.api.webhooks.list({});

Input

Name	Type	Required	Description
`robotId`	`string`	Yes	—

Output

Name	Type	Required	Description
`statusCode`	`number`	No	—
`messageCode`	`string`	No	—
`webhooks`	`object`	No	—

webhooks full type

{
  totalCount?: number | null,
  items?: {
    id?: string | null,
    url?: string | null,
    webhookEvent?: string | null,
    createdAt?: number | null
  }[] | null
}

Overview

Plugins

Monitors

create

delete

Robots

bulkRun

list

run

System

getStatus

Tasks

get

list

Webhooks

create

list

​Monitors

​create

​delete

​Robots

​bulkRun

​list

​run

​System

​getStatus

​Tasks

​get

​list

​Webhooks

​create

​list

Monitors

create

delete

Robots

bulkRun

list

run

System

getStatus

Tasks

get

list

Webhooks

create

list