SDK: bots

The bots area has 6 methods on the client. Each takes one object of path, query and body arguments and an optional CallOptions, and returns a promise of the response body. A refused call rejects with OverlaneApiError (see the SDK index).

botsCreate

Register a bot; the signing secret is shown once

• Request: POST on /v1/tenants/{tenantId}/bots
• Needs an approval for agents: class bots

botsCreate(args: { tenantId: string; body: RegisterBotRequest }, options?: CallOptions): Promise<BotCreated>

botsList

List registered bots

• Request: GET on /v1/tenants/{tenantId}/bots

botsList(args: { tenantId: string }, options?: CallOptions): Promise<Record<string, unknown>>

botsRedeliver

Send a bot’s pending events again, in order

• Request: POST on /v1/tenants/{tenantId}/bots/{botId}/redeliver

botsRedeliver(args: { tenantId: string; botId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<Record<string, unknown>>

botsRevoke

Revoke a bot

• Request: DELETE on /v1/tenants/{tenantId}/bots/{botId}
• Needs an approval for agents: class bots

botsRevoke(args: { tenantId: string; botId: string }, options?: CallOptions): Promise<Record<string, unknown>>

botsRotate

Rotate a bot’s signing secret; shown once

• Request: POST on /v1/tenants/{tenantId}/bots/{botId}/rotate-key
• Needs an approval for agents: class bots

botsRotate(args: { tenantId: string; botId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<Record<string, unknown>>

botsUsersMap

Link a bot’s user to a team member, so the project assistant answers them with that member’s role (policy class)

• Request: POST on /v1/tenants/{tenantId}/bots/{botId}/users

botsUsersMap(args: { tenantId: string; botId: string; body: MapBotUserRequest }, options?: CallOptions): Promise<Record<string, unknown>>