API - Corsair

Every botpress.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.

Account

get

account.get Get the authenticated account Risk: read

await corsair.botpress.api.account.get({});

Input: empty object Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`email`	`string`	No	—
`displayName`	`string`	No	—
`createdAt`	`string`	No	—
`emailVerified`	`boolean`	No	—

getPreference

account.getPreference Get an account preference by key Risk: read

await corsair.botpress.api.account.getPreference({});

Input

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

Output

Name	Type	Required	Description
`value`	`any`	No	—

setPreference

account.setPreference Set an account preference by key Risk: write

await corsair.botpress.api.account.setPreference({});

Input

Name	Type	Required	Description
`key`	`string`	Yes	—
`value`	`any`	Yes	—

Output: empty object

update

account.update Update the authenticated account profile Risk: write

await corsair.botpress.api.account.update({});

Input

Name	Type	Required	Description
`displayName`	`string`	No	—
`profilePicture`	`string`	No	—
`refresh`	`boolean`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`email`	`string`	No	—
`displayName`	`string`	No	—
`createdAt`	`string`	No	—
`emailVerified`	`boolean`	No	—

Billing

chargeUnpaidInvoices

billing.chargeUnpaidInvoices Charge outstanding invoices for a workspace [DESTRUCTIVE - real financial action] Risk: destructive

await corsair.botpress.api.billing.chargeUnpaidInvoices({});

Input

Name	Type	Required	Description
`workspaceId`	`string`	Yes	—
`invoiceIds`	`string[]`	Yes	—

Output

Name	Type	Required	Description
`chargedInvoices`	`object[]`	No	—
`failedInvoices`	`object[]`	No	—

chargedInvoices full type

{
  id: string,
  amount: number
}[]

failedInvoices full type

{
  id: string,
  amount: number,
  failedReason: string
}[]

getUpcomingInvoice

billing.getUpcomingInvoice Preview the upcoming invoice for a workspace Risk: read

await corsair.botpress.api.billing.getUpcomingInvoice({});

Input

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

Output

Name	Type	Required	Description
`total`	`number`	No	—
`lineItems`	`object[]`	No	—

lineItems full type

{
  id: string,
  description?: string | null,
  totalInCents?: number | null,
  currency?: string | null,
  pricePerUnitInCents?: number | null,
  quantity?: number | null,
  type?: invoiceitem | subscription | null,
  periodStart?: string | null,
  periodEnd?: string | null
}[]

listInvoices

billing.listInvoices List invoices billed to a workspace Risk: read

await corsair.botpress.api.billing.listInvoices({});

Input

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

Output: object[]

Output full type

{
  id: string,
  period: {
    month: number,
    year: number
  },
  date?: string | null,
  amount?: number | null,
  currency?: string | null,
  paymentStatus?: deleted | draft | open | paid | uncollectible | void | null,
  dueDate?: string | null,
  paymentAttemptCount?: number | null,
  nextPaymentAttemptDate?: string | null,
  pdfUrl?: string | null
}[]

listUsageHistory

billing.listUsageHistory List usage history for a workspace or bot Risk: read

await corsair.botpress.api.billing.listUsageHistory({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`type`	`invocation_timeout \| invocation_calls \| storage_count \| bot_count \| knowledgebase_vector_storage \| workspace_ratelimit \| table_row_count \| workspace_member_count \| integrations_owned_count \| ai_spend \| openai_spend \| bing_search_spend \| always_alive \| indexed_file_count \| file_max_size_bytes`	Yes	—

Output: object[]

Output full type

{
  id?: string | null,
  period?: string | null,
  value?: number | null,
  quota?: number | null,
  type?: invocation_timeout | invocation_calls | storage_count | bot_count | knowledgebase_vector_storage | workspace_ratelimit | table_row_count | workspace_member_count | integrations_owned_count | ai_spend | openai_spend | bing_search_spend | always_alive | indexed_file_count | file_max_size_bytes | null
}[]

Bots

create

bots.create Create a bot in a workspace Risk: write

await corsair.botpress.api.bots.create({});

Input

Name	Type	Required	Description
`name`	`string`	No	—
`description`	`string`	No	—
`tags`	`object`	No	—
`dev`	`boolean`	No	—
`code`	`string`	No	—
`url`	`string`	No	—
`states`	`object`	No	—
`events`	`object`	No	—
`recurringEvents`	`object`	No	—
`actions`	`object`	No	—
`configuration`	`object`	No	—
`user`	`object`	No	—
`conversation`	`object`	No	—
`message`	`object`	No	—
`subscriptions`	`object`	No	—
`maxExecutionTime`	`number`	No	—
`medias`	`object`	No	—
`secrets`	`object`	No	—
`type`	`studio \| adk`	No	—
`moduleFormat`	`cjs \| esm`	No	—

tags full type

{
}

states full type

{
}

events full type

{
}

recurringEvents full type

{
}

actions full type

{
}

configuration full type

{
}

user full type

{
}

conversation full type

{
}

message full type

{
}

subscriptions full type

{
}

medias full type

{
}

secrets full type

{
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—
`createdBy`	`string`	No	—
`dev`	`boolean`	No	—
`alwaysAlive`	`boolean`	No	—
`status`	`string`	No	—
`type`	`string`	No	—
`signingSecret`	`string`	No	—
`tags`	`object`	No	—

tags full type

{
}

listActionRuns

bots.listActionRuns List a bot’s action-run history Risk: read

await corsair.botpress.api.bots.listActionRuns({});

Input

Name	Type	Required	Description
`nextToken`	`string`	No	—
`pageSize`	`number`	No	—
`id`	`string`	Yes	—
`integrationName`	`string`	No	—
`timestampFrom`	`string`	No	—
`timestampUntil`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`nextToken`	`string`	No	—

data full type

{
  timestamp?: string | null,
  integrationName?: string | null,
  actionType?: string | null,
  input?: {
  } | null,
  inputTruncated?: boolean | null,
  output?: {
  } | null,
  outputTruncated?: boolean | null,
  status?: SUCCESS | FAILURE | null,
  durationMs?: number | null,
  cached?: boolean | null,
  errorMessage?: string | null
}[]

listIssues

bots.listIssues List configuration and runtime issues for a bot Risk: read

await corsair.botpress.api.bots.listIssues({});

Input

Name	Type	Required	Description
`nextToken`	`string`	No	—
`pageSize`	`number`	No	—
`id`	`string`	Yes	—

Output

Name	Type	Required	Description
`issues`	`object[]`	Yes	—
`nextToken`	`string`	No	—

issues full type

{
  id: string,
  code?: string | null,
  createdAt?: string | null,
  lastSeenAt?: string | null,
  title?: string | null,
  description?: string | null,
  eventsCount?: number | null,
  category?: user_code | limits | configuration | other | null,
  resolutionLink?: string | null
}[]

update

bots.update Update a bot Risk: write

await corsair.botpress.api.bots.update({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`description`	`string`	No	—
`tags`	`object`	No	—
`blocked`	`boolean`	No	—
`alwaysAlive`	`boolean`	No	—
`maxExecutionTime`	`number`	No	—
`url`	`string`	No	—
`authentication`	`iam \| hmac-sha256`	No	—
`configuration`	`object`	No	—
`user`	`object`	No	—
`message`	`object`	No	—
`conversation`	`object`	No	—
`events`	`object`	No	—
`actions`	`object`	No	—
`states`	`object`	No	—
`recurringEvents`	`object`	No	—
`integrations`	`object`	No	—
`plugins`	`object`	No	—
`subscriptions`	`object`	No	—
`code`	`string`	No	—
`medias`	`object`	No	—
`secrets`	`object`	No	—
`layers`	`string[]`	No	—
`type`	`studio \| adk`	No	—
`moduleFormat`	`cjs \| esm`	No	—

tags full type

{
}

configuration full type

{
}

user full type

{
}

message full type

{
}

conversation full type

{
}

events full type

{
}

actions full type

{
}

states full type

{
}

recurringEvents full type

{
}

integrations full type

{
}

plugins full type

{
}

subscriptions full type

{
}

medias full type

{
}

secrets full type

{
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—
`createdBy`	`string`	No	—
`dev`	`boolean`	No	—
`alwaysAlive`	`boolean`	No	—
`status`	`string`	No	—
`type`	`string`	No	—
`signingSecret`	`string`	No	—
`tags`	`object`	No	—

tags full type

{
}

Chat

createConversation

chat.createConversation Create a conversation on a channel Risk: write

await corsair.botpress.api.chat.createConversation({});

Input

Name	Type	Required	Description
`botId`	`string`	Yes	—
`channel`	`string`	Yes	—
`tags`	`object`	Yes	—
`properties`	`object`	No	—

tags full type

{
}

properties full type

{
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—
`channel`	`string`	No	—
`integration`	`string`	No	—
`tags`	`object`	No	—
`messageCount`	`number`	No	—
`properties`	`object`	No	—

tags full type

{
}

properties full type

{
}

listConversations

chat.listConversations List a bot’s conversations Risk: read

await corsair.botpress.api.chat.listConversations({});

Input

Name	Type	Required	Description
`nextToken`	`string`	No	—
`pageSize`	`number`	No	—
`botId`	`string`	Yes	—
`tags`	`object`	No	—
`sortField`	`createdAt \| updatedAt`	No	—
`sortDirection`	`asc \| desc`	No	—
`participantIds`	`string[]`	No	—
`integrationName`	`string`	No	—
`channel`	`string`	No	—
`afterDate`	`string`	No	—
`beforeDate`	`string`	No	—
`minMessageCount`	`number`	No	—
`maxMessageCount`	`number`	No	—

tags full type

{
}

Output

Name	Type	Required	Description
`conversations`	`object[]`	Yes	—
`nextToken`	`string`	No	—

conversations full type

{
  id: string,
  createdAt?: string | null,
  updatedAt?: string | null,
  channel?: string | null,
  integration?: string | null,
  tags?: {
  } | null,
  messageCount?: number | null,
  properties?: {
  } | null
}[]

sendMessage

chat.sendMessage Send a message into a conversation Risk: write

await corsair.botpress.api.chat.sendMessage({});

Input

Name	Type	Required	Description
`botId`	`string`	Yes	—
`conversationId`	`string`	Yes	—
`userId`	`string`	Yes	—
`type`	`string`	Yes	—
`payload`	`object`	Yes	—
`tags`	`object`	Yes	—
`schedule`	`object`	No	—
`origin`	`synthetic`	No	—

payload full type

{
}

tags full type

{
}

schedule full type

{
  dateTime?: string,
  delay?: number
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—
`type`	`string`	No	—
`payload`	`object`	No	—
`direction`	`incoming \| outgoing`	No	—
`userId`	`string`	No	—
`conversationId`	`string`	No	—
`tags`	`object`	No	—
`origin`	`synthetic`	No	—

payload full type

{
}

tags full type

{
}

updateWorkflow

chat.updateWorkflow Update a workflow’s status, output or failure reason Risk: write

await corsair.botpress.api.chat.updateWorkflow({});

Input

Name	Type	Required	Description
`botId`	`string`	Yes	—
`id`	`string`	Yes	—
`status`	`completed \| cancelled \| listening \| paused \| failed \| in_progress`	No	—
`output`	`object`	No	—
`timeoutAt`	`string`	No	—
`failureReason`	`string`	No	—
`tags`	`object`	No	—
`userId`	`string`	No	—
`eventId`	`string`	No	—

output full type

{
}

tags full type

{
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`status`	`pending \| in_progress \| failed \| completed \| listening \| paused \| timedout \| cancelled`	No	—
`input`	`object`	No	—
`output`	`object`	No	—
`parentWorkflowId`	`string`	No	—
`conversationId`	`string`	No	—
`userId`	`string`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—
`completedAt`	`string`	No	—
`failureReason`	`string`	No	—
`timeoutAt`	`string`	No	—
`tags`	`object`	No	—

input full type

{
}

output full type

{
}

tags full type

{
}

Files

delete

files.delete Delete a file from a bot’s storage [DESTRUCTIVE] Risk: destructive

await corsair.botpress.api.files.delete({});

Input

Name	Type	Required	Description
`botId`	`string`	Yes	—
`id`	`string`	Yes	—

Output: empty object

files.listTags List tags used across a bot’s files Risk: read

await corsair.botpress.api.files.listTags({});

Input

Name	Type	Required	Description
`nextToken`	`string`	No	—
`pageSize`	`number`	No	—
`botId`	`string`	Yes	—

Output

Name	Type	Required	Description
`tags`	`string[]`	Yes	—
`nextToken`	`string`	No	—

listTagValues

files.listTagValues List all values seen for a given file tag Risk: read

await corsair.botpress.api.files.listTagValues({});

Input

Name	Type	Required	Description
`nextToken`	`string`	No	—
`pageSize`	`number`	No	—
`botId`	`string`	Yes	—
`tag`	`string`	Yes	—

Output

Name	Type	Required	Description
`values`	`string[]`	Yes	—
`nextToken`	`string`	No	—

Hub

getDereferencedPluginById

hub.getDereferencedPluginById Get a public plugin with interface entity references resolved Risk: read

await corsair.botpress.api.hub.getDereferencedPluginById({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`interfaces`	`object`	Yes	—

interfaces full type

{
}

Output: object

Output full type

{
}

getIntegration

hub.getIntegration Get a public integration by name and version Risk: read

await corsair.botpress.api.hub.getIntegration({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`version`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	Yes	—
`version`	`string`	Yes	—
`title`	`string`	No	—
`description`	`string`	No	—
`iconUrl`	`string`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—
`public`	`boolean`	No	—
`visibility`	`string`	No	—
`verificationStatus`	`string`	No	—
`lifecycleStatus`	`string`	No	—
`ownerWorkspace`	`object`	No	—

ownerWorkspace full type

{
  id?: string | null,
  handle?: string | null,
  name?: string | null
}

getIntegrationById

hub.getIntegrationById Get a public integration by id Risk: read

await corsair.botpress.api.hub.getIntegrationById({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	Yes	—
`version`	`string`	Yes	—
`title`	`string`	No	—
`description`	`string`	No	—
`iconUrl`	`string`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—
`public`	`boolean`	No	—
`visibility`	`string`	No	—
`verificationStatus`	`string`	No	—
`lifecycleStatus`	`string`	No	—
`ownerWorkspace`	`object`	No	—

ownerWorkspace full type

{
  id?: string | null,
  handle?: string | null,
  name?: string | null
}

getInterface

hub.getInterface Get a public interface by name and version Risk: read

await corsair.botpress.api.hub.getInterface({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`version`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	Yes	—
`version`	`string`	Yes	—
`title`	`string`	No	—
`description`	`string`	No	—
`iconUrl`	`string`	No	—
`readmeUrl`	`string`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—
`public`	`boolean`	No	—

getInterfaceById

hub.getInterfaceById Get a public interface by id Risk: read

await corsair.botpress.api.hub.getInterfaceById({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	Yes	—
`version`	`string`	Yes	—
`title`	`string`	No	—
`description`	`string`	No	—
`iconUrl`	`string`	No	—
`readmeUrl`	`string`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—
`public`	`boolean`	No	—

getPlugin

hub.getPlugin Get a public plugin by name and version Risk: read

await corsair.botpress.api.hub.getPlugin({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`version`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	Yes	—
`version`	`string`	Yes	—
`title`	`string`	No	—
`description`	`string`	No	—
`iconUrl`	`string`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—
`public`	`boolean`	No	—
`visibility`	`string`	No	—
`lifecycleStatus`	`string`	No	—

getPluginById

hub.getPluginById Get a public plugin by id Risk: read

await corsair.botpress.api.hub.getPluginById({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	Yes	—
`version`	`string`	Yes	—
`title`	`string`	No	—
`description`	`string`	No	—
`iconUrl`	`string`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—
`public`	`boolean`	No	—
`visibility`	`string`	No	—
`lifecycleStatus`	`string`	No	—

getPluginCode

hub.getPluginCode Get a public plugin’s source code for a platform Risk: read

await corsair.botpress.api.hub.getPluginCode({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`platform`	`node \| browser`	Yes	—

Output

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

listIntegrations

hub.listIntegrations List public integrations in the hub Risk: read

await corsair.botpress.api.hub.listIntegrations({});

Input

Name	Type	Required	Description
`nextToken`	`string`	No	—
`pageSize`	`number`	No	—
`limit`	`number`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`interfaceId`	`string`	No	—
`interfaceName`	`string`	No	—
`installedByBotId`	`string`	No	—
`verificationStatus`	`unapproved \| pending \| approved \| rejected`	No	—
`search`	`string`	No	—
`sortBy`	`popularity \| name \| createdAt \| updatedAt \| installCount`	No	—
`direction`	`asc \| desc`	No	—

Output

Name	Type	Required	Description
`integrations`	`object[]`	Yes	—
`nextToken`	`string`	No	—

integrations full type

{
  id: string,
  name: string,
  version: string,
  title?: string | null,
  description?: string | null,
  iconUrl?: string | null,
  createdAt?: string | null,
  updatedAt?: string | null,
  public?: boolean | null,
  visibility?: string | null,
  verificationStatus?: string | null,
  lifecycleStatus?: string | null,
  ownerWorkspace?: {
    id?: string | null,
    handle?: string | null,
    name?: string | null
  } | null
}[]

listInterfaces

hub.listInterfaces List public interfaces in the hub Risk: read

await corsair.botpress.api.hub.listInterfaces({});

Input

Name	Type	Required	Description
`nextToken`	`string`	No	—
`pageSize`	`number`	No	—
`name`	`string`	No	—
`version`	`string`	No	—

Output

Name	Type	Required	Description
`interfaces`	`object[]`	Yes	—
`nextToken`	`string`	No	—

interfaces full type

{
  id: string,
  name: string,
  version: string,
  title?: string | null,
  description?: string | null,
  iconUrl?: string | null,
  readmeUrl?: string | null,
  createdAt?: string | null,
  updatedAt?: string | null,
  public?: boolean | null
}[]

listPlugins

hub.listPlugins List public plugins in the hub Risk: read

await corsair.botpress.api.hub.listPlugins({});

Input

Name	Type	Required	Description
`nextToken`	`string`	No	—
`pageSize`	`number`	No	—
`name`	`string`	No	—
`version`	`string`	No	—

Output

Name	Type	Required	Description
`plugins`	`object[]`	Yes	—
`nextToken`	`string`	No	—

plugins full type

{
  id: string,
  name: string,
  version: string,
  title?: string | null,
  description?: string | null,
  iconUrl?: string | null,
  createdAt?: string | null,
  updatedAt?: string | null,
  public?: boolean | null,
  visibility?: string | null,
  lifecycleStatus?: string | null
}[]

Integrations

create

integrations.create Create an integration in a workspace Risk: write

await corsair.botpress.api.integrations.create({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`version`	`string`	Yes	—
`title`	`string`	No	—
`description`	`string`	No	—
`url`	`string`	No	—
`code`	`string`	No	—
`configuration`	`object`	No	—
`configurations`	`object`	No	—
`states`	`object`	No	—
`events`	`object`	No	—
`actions`	`object`	No	—
`entities`	`object`	No	—
`channels`	`object`	No	—
`user`	`object`	No	—
`interfaces`	`object`	No	—
`identifier`	`object`	No	—
`extraOperations`	`object`	No	—
`sdkVersion`	`string`	No	—
`secrets`	`object`	No	—
`icon`	`string`	No	—
`readme`	`string`	No	—
`public`	`boolean`	No	—
`visibility`	`public \| private \| unlisted`	No	—
`layers`	`string[]`	No	—
`attributes`	`object`	No	—

configuration full type

{
}

configurations full type

{
}

states full type

{
}

events full type

{
}

actions full type

{
}

entities full type

{
}

channels full type

{
}

user full type

{
}

interfaces full type

{
}

identifier full type

{
  fallbackHandlerScript?: string,
  extractScript?: string
}

extraOperations full type

{
}

secrets full type

{
}

attributes full type

{
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	Yes	—
`version`	`string`	Yes	—
`title`	`string`	No	—
`description`	`string`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—
`visibility`	`public \| private \| unlisted`	No	—
`verificationStatus`	`string`	No	—
`dev`	`boolean`	No	—
`url`	`string`	No	—
`iconUrl`	`string`	No	—
`readmeUrl`	`string`	No	—
`signingSecret`	`string`	No	—

deleteShareableId

integrations.deleteShareableId Delete the shareable id for a bot-integration pair [DESTRUCTIVE] Risk: destructive

await corsair.botpress.api.integrations.deleteShareableId({});

Input

Name	Type	Required	Description
`botId`	`string`	Yes	—
`integrationId`	`string`	Yes	—
`integrationInstanceAlias`	`string`	No	—

Output: empty object

get

integrations.get Get an integration by id Risk: read

await corsair.botpress.api.integrations.get({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`version`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	Yes	—
`version`	`string`	Yes	—
`title`	`string`	No	—
`description`	`string`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—
`visibility`	`public \| private \| unlisted`	No	—
`verificationStatus`	`string`	No	—
`dev`	`boolean`	No	—
`url`	`string`	No	—
`iconUrl`	`string`	No	—
`readmeUrl`	`string`	No	—
`signingSecret`	`string`	No	—

list

integrations.list List integrations owned by the workspace Risk: read

await corsair.botpress.api.integrations.list({});

Input

Name	Type	Required	Description
`nextToken`	`string`	No	—
`pageSize`	`number`	No	—
`limit`	`number`	No	—
`name`	`string`	No	—
`version`	`string`	No	—
`interfaceId`	`string`	No	—
`interfaceName`	`string`	No	—
`installedByBotId`	`string`	No	—
`verificationStatus`	`unapproved \| pending \| approved \| rejected`	No	—
`search`	`string`	No	—
`sortBy`	`popularity \| name \| createdAt \| updatedAt \| installCount`	No	—
`direction`	`asc \| desc`	No	—
`visibility`	`public \| private`	No	—
`dev`	`boolean`	No	—

Output

Name	Type	Required	Description
`integrations`	`object[]`	Yes	—
`nextToken`	`string`	No	—

integrations full type

{
  id: string,
  name: string,
  version: string,
  title?: string | null,
  description?: string | null,
  createdAt?: string | null,
  updatedAt?: string | null,
  visibility?: public | private | unlisted | null,
  verificationStatus?: string | null,
  dev?: boolean | null,
  url?: string | null,
  iconUrl?: string | null,
  readmeUrl?: string | null,
  signingSecret?: string | null
}[]

listApiKeys

integrations.listApiKeys List Integration API Keys (IAKs) for an integration Risk: read

await corsair.botpress.api.integrations.listApiKeys({});

Input

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

Output: object[]

Output full type

{
  id: string,
  createdAt?: string | null,
  note?: string | null
}[]

requestVerification

integrations.requestVerification Submit an integration for verification Risk: write

await corsair.botpress.api.integrations.requestVerification({});

Input

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

Output: empty object

validateUpdate

integrations.validateUpdate Validate that an integration update would succeed Risk: read

await corsair.botpress.api.integrations.validateUpdate({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`configuration`	`object`	No	—
`configurations`	`object`	No	—
`states`	`object`	No	—
`events`	`object`	No	—
`actions`	`object`	No	—
`entities`	`object`	No	—
`channels`	`object`	No	—
`user`	`object`	No	—
`interfaces`	`object`	No	—
`identifier`	`object`	No	—
`extraOperations`	`object`	No	—
`sdkVersion`	`string`	No	—
`maxExecutionTime`	`number`	No	—
`secrets`	`object`	No	—
`icon`	`string`	No	—
`readme`	`string`	No	—
`title`	`string`	No	—
`description`	`string`	No	—
`url`	`string`	No	—
`public`	`boolean`	No	—
`visibility`	`public \| private \| unlisted`	No	—
`layers`	`string[]`	No	—

configuration full type

{
}

configurations full type

{
}

states full type

{
}

events full type

{
}

actions full type

{
}

entities full type

{
}

channels full type

{
}

user full type

{
}

interfaces full type

{
}

identifier full type

{
  fallbackHandlerScript?: string,
  extractScript?: string
}

extraOperations full type

{
}

secrets full type

{
}

Output: empty object

Knowledge Bases

delete

knowledgeBases.delete Permanently delete a knowledge base [DESTRUCTIVE] Risk: destructive

await corsair.botpress.api.knowledgeBases.delete({});

Input

Name	Type	Required	Description
`botId`	`string`	Yes	—
`id`	`string`	Yes	—

Output: empty object

list

knowledgeBases.list List a bot’s knowledge bases Risk: read

await corsair.botpress.api.knowledgeBases.list({});

Input

Name	Type	Required	Description
`nextToken`	`string`	No	—
`pageSize`	`number`	No	—
`botId`	`string`	Yes	—
`tags`	`object`	No	—

tags full type

{
}

Output

Name	Type	Required	Description
`knowledgeBases`	`object[]`	Yes	—
`nextToken`	`string`	No	—

knowledgeBases full type

{
  id: string,
  name: string,
  description?: string | null,
  createdAt?: string | null,
  tags?: {
  } | null
}[]

Plugins

list

plugins.list List plugins installed in the workspace Risk: read

await corsair.botpress.api.plugins.list({});

Input

Name	Type	Required	Description
`nextToken`	`string`	No	—
`pageSize`	`number`	No	—
`name`	`string`	No	—
`version`	`string`	No	—

Output

Name	Type	Required	Description
`plugins`	`object[]`	Yes	—
`nextToken`	`string`	No	—

plugins full type

{
  id: string,
  name: string,
  version: string,
  title?: string | null,
  description?: string | null,
  iconUrl?: string | null,
  createdAt?: string | null,
  updatedAt?: string | null,
  public?: boolean | null,
  visibility?: string | null,
  lifecycleStatus?: string | null
}[]

Tools

getTableRow

tools.getTableRow Fetch a single row from a table by id Risk: read

await corsair.botpress.api.tools.getTableRow({});

Input

Name	Type	Required	Description
`botId`	`string`	Yes	—
`table`	`string`	Yes	—
`id`	`number`	Yes	—

Output

Name	Type	Required	Description
`id`	`number`	Yes	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—

runVrl

tools.runVrl Execute a VRL script against input data Risk: write

await corsair.botpress.api.tools.runVrl({});

Input

Name	Type	Required	Description
`data`	`object`	Yes	—
`script`	`string`	Yes	—

data full type

{
}

Output

Name	Type	Required	Description
`data`	`any`	Yes	—
`result`	`any`	Yes	—

Workspaces

breakDownUsageByBot

workspaces.breakDownUsageByBot Break down a workspace’s usage of a quota type by bot Risk: read

await corsair.botpress.api.workspaces.breakDownUsageByBot({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`type`	`invocation_timeout \| invocation_calls \| storage_count \| bot_count \| knowledgebase_vector_storage \| workspace_ratelimit \| table_row_count \| workspace_member_count \| integrations_owned_count \| ai_spend \| openai_spend \| bing_search_spend \| always_alive \| indexed_file_count \| file_max_size_bytes`	Yes	—
`period`	`string`	No	—

Output: object[]

Output full type

{
  botId?: string | null,
  value?: number | null
}[]

checkHandleAvailability

workspaces.checkHandleAvailability Check whether a workspace handle is available Risk: read

await corsair.botpress.api.workspaces.checkHandleAvailability({});

Input

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

Output

Name	Type	Required	Description
`available`	`boolean`	Yes	—
`suggestions`	`string[]`	No	—
`usedBy`	`string`	No	—

create

workspaces.create Create a workspace Risk: write

await corsair.botpress.api.workspaces.create({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`billingVersion`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	Yes	—
`ownerId`	`string`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—
`blocked`	`boolean`	No	—
`plan`	`string`	No	—
`billingVersion`	`string`	No	—
`spendingLimit`	`number`	No	—
`botCount`	`number`	No	—
`about`	`string`	No	—
`profilePicture`	`string`	No	—
`contactEmail`	`string`	No	—
`website`	`string`	No	—
`socialAccounts`	`any[]`	No	—
`isPublic`	`boolean`	No	—
`handle`	`string`	No	—
`activeTrialId`	`string`	No	—

delete

workspaces.delete Permanently delete a workspace [DESTRUCTIVE] Risk: destructive

await corsair.botpress.api.workspaces.delete({});

Input

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

Output: empty object

get

workspaces.get Get a workspace by id Risk: read

await corsair.botpress.api.workspaces.get({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	Yes	—
`ownerId`	`string`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—
`blocked`	`boolean`	No	—
`plan`	`string`	No	—
`billingVersion`	`string`	No	—
`spendingLimit`	`number`	No	—
`botCount`	`number`	No	—
`about`	`string`	No	—
`profilePicture`	`string`	No	—
`contactEmail`	`string`	No	—
`website`	`string`	No	—
`socialAccounts`	`any[]`	No	—
`isPublic`	`boolean`	No	—
`handle`	`string`	No	—
`activeTrialId`	`string`	No	—

getAllQuotaCompletion

workspaces.getAllQuotaCompletion Get the highest quota completion rate for every workspace Risk: read

await corsair.botpress.api.workspaces.getAllQuotaCompletion({});

Input: empty object Output: object

Output full type

{
}

getQuota

workspaces.getQuota Get a workspace’s usage against a quota type Risk: read

await corsair.botpress.api.workspaces.getQuota({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`type`	`invocation_timeout \| invocation_calls \| storage_count \| bot_count \| knowledgebase_vector_storage \| workspace_ratelimit \| table_row_count \| workspace_member_count \| integrations_owned_count \| ai_spend \| openai_spend \| bing_search_spend \| always_alive \| indexed_file_count \| file_max_size_bytes`	Yes	—
`period`	`string`	No	—

Output

Name	Type	Required	Description
`period`	`string`	No	—
`value`	`number`	No	—
`type`	`invocation_timeout \| invocation_calls \| storage_count \| bot_count \| knowledgebase_vector_storage \| workspace_ratelimit \| table_row_count \| workspace_member_count \| integrations_owned_count \| ai_spend \| openai_spend \| bing_search_spend \| always_alive \| indexed_file_count \| file_max_size_bytes`	No	—

list

workspaces.list List workspaces owned by the account Risk: read

await corsair.botpress.api.workspaces.list({});

Input

Name	Type	Required	Description
`nextToken`	`string`	No	—
`pageSize`	`number`	No	—
`handle`	`string`	No	—

Output

Name	Type	Required	Description
`workspaces`	`object[]`	Yes	—
`nextToken`	`string`	No	—

workspaces full type

{
  id: string,
  name: string,
  ownerId?: string | null,
  createdAt?: string | null,
  updatedAt?: string | null,
  blocked?: boolean | null,
  plan?: string | null,
  billingVersion?: string | null,
  spendingLimit?: number | null,
  botCount?: number | null,
  about?: string | null,
  profilePicture?: string | null,
  contactEmail?: string | null,
  website?: string | null,
  socialAccounts?: any[] | null,
  isPublic?: boolean | null,
  handle?: string | null,
  activeTrialId?: string | null
}[]

listPublic

workspaces.listPublic List public workspaces Risk: read

await corsair.botpress.api.workspaces.listPublic({});

Input

Name	Type	Required	Description
`nextToken`	`string`	No	—
`pageSize`	`number`	No	—
`workspaceIds`	`string[]`	No	—
`search`	`string`	No	—

Output

Name	Type	Required	Description
`workspaces`	`object[]`	Yes	—
`nextToken`	`string`	No	—

workspaces full type

{
  id: string,
  name: string,
  ownerId?: string | null,
  createdAt?: string | null,
  updatedAt?: string | null,
  blocked?: boolean | null,
  plan?: string | null,
  billingVersion?: string | null,
  spendingLimit?: number | null,
  botCount?: number | null,
  about?: string | null,
  profilePicture?: string | null,
  contactEmail?: string | null,
  website?: string | null,
  socialAccounts?: any[] | null,
  isPublic?: boolean | null,
  handle?: string | null,
  activeTrialId?: string | null
}[]

setPreference

workspaces.setPreference Set a workspace preference by key Risk: write

await corsair.botpress.api.workspaces.setPreference({});

Input

Name	Type	Required	Description
`key`	`string`	Yes	—
`value`	`any`	Yes	—

Output: empty object

update

workspaces.update Update workspace settings Risk: write

await corsair.botpress.api.workspaces.update({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`spendingLimit`	`number`	No	—
`about`	`string`	No	—
`profilePicture`	`string`	No	—
`contactEmail`	`string`	No	—
`website`	`string`	No	—
`socialAccounts`	`any[]`	No	—
`isPublic`	`boolean`	No	—
`handle`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	Yes	—
`ownerId`	`string`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—
`blocked`	`boolean`	No	—
`plan`	`string`	No	—
`billingVersion`	`string`	No	—
`spendingLimit`	`number`	No	—
`botCount`	`number`	No	—
`about`	`string`	No	—
`profilePicture`	`string`	No	—
`contactEmail`	`string`	No	—
`website`	`string`	No	—
`socialAccounts`	`any[]`	No	—
`isPublic`	`boolean`	No	—
`handle`	`string`	No	—
`activeTrialId`	`string`	No	—

​Account

​get

​getPreference

​setPreference

​update

​Billing

​chargeUnpaidInvoices

​getUpcomingInvoice

​listInvoices

​listUsageHistory

​Bots

​create

​listActionRuns

​listIssues

​update

​Chat

​createConversation

​listConversations

​sendMessage

​updateWorkflow

​Files

​delete

​listTags

​listTagValues

​Hub

​getDereferencedPluginById

​getIntegration

​getIntegrationById

​getInterface

​getInterfaceById

​getPlugin

​getPluginById

​getPluginCode

​listIntegrations

​listInterfaces

​listPlugins

​Integrations

​create

​deleteShareableId

​get

​list

​listApiKeys

​requestVerification

​validateUpdate

​Knowledge Bases

​delete

​list

​Plugins

​list

​Tools

​getTableRow

​runVrl

​Workspaces

​breakDownUsageByBot

​checkHandleAvailability

​create

​delete

​get

​getAllQuotaCompletion

​getQuota

​list

​listPublic

​setPreference

​update

Account

get

getPreference

setPreference

update

Billing

chargeUnpaidInvoices

getUpcomingInvoice

listInvoices

listUsageHistory

Bots

create

listActionRuns

listIssues

update

Chat

createConversation

listConversations

sendMessage

updateWorkflow

Files

delete

listTags

listTagValues

Hub

getDereferencedPluginById

getIntegration

getIntegrationById

getInterface

getInterfaceById

getPlugin

getPluginById

getPluginCode

listIntegrations

listInterfaces

listPlugins

Integrations

create

deleteShareableId

get

list

listApiKeys

requestVerification

validateUpdate

Knowledge Bases

delete

list

Plugins

list

Tools

getTableRow

runVrl

Workspaces

breakDownUsageByBot

checkHandleAvailability

create

delete

get

getAllQuotaCompletion

getQuota

list

listPublic

setPreference

update