Skip to content
OpenBot
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Menu
Choose a manual
User manual
User manual
Your first task
Sign in and your account
Choose and manage Bots
Talk to a Bot
Answer a request
Share Bots
Work with files
Connect and use Apps
Find an App
Use a Bot in chat services
Use voice in Live mode
Give long work to a Bot
Run work at a set time
Rules and Grants
Review Bot memory
Let a Bot use a Computer
Let a Bot use secrets
Understand Code Mode
Administrator manual
Administrator manual
Organizations
Organization
Permissions
SSO and domains
Models
Usage and budgets
Set up Channels
Computer providers
Secret providers
Platform and servers
Deploy
Configuration
Platform
Set up sign-in
File storage
Live models
Set up Code Mode
App Index settings
Pair a machine
Error logs
Developer manual
Developer manual
Clients and API
Quick start
Client
Authentication
Bots
Chats
Requests
Share Bots
Files
Apps
App Index
Channels
Live mode
Delegation
Triggers
Rules and Grants
Memory
Computers
Vaults
Code Mode
App publishers
App Protocol
Protocol test
Developer tools
Project contributors
Contributing
End-to-end checks
Packages
Execution design
Run from code
Model backends
Add a Live backend
Add an error logger
Publish and check the project
API reference
API reference
Overview
Account
Overview
account.session
Sign-in
Overview
signIn.signIn
Organizations
Overview
organizations.listOrganizations
organizations.createOrganization
organizations.leaveOrganization
organizations.listMyInvitations
organizations.acceptInvitation
organizations.declineInvitation
User tokens
Overview
userTokens.listTokens
userTokens.createToken
userTokens.revokeToken
userTokens.verifyToken
Organization
Overview
organization.getOrganization
organization.updateOrganization
organization.listMembers
organization.getMember
organization.removeMember
organization.updateMember
organization.listInvitations
organization.createInvitation
organization.revokeInvitation
organization.listResources
organization.getSettings
organization.updateSettings
organization.listRoles
organization.createRole
organization.getRole
organization.deleteRole
organization.updateRole
organization.listAuditLogs
Model providers
Overview
modelProviders.startProviderAuthorization
modelProviders.completeProviderAuthorization
modelProviders.disconnectProviderOAuth
modelProviders.getProviderAvailableModels
modelProviders.getModelCatalog
modelProviders.listModels
modelProviders.createModel
modelProviders.getModel
modelProviders.deleteModel
modelProviders.updateModel
modelProviders.listModelProviders
modelProviders.createModelProvider
modelProviders.getModelProvider
modelProviders.deleteModelProvider
modelProviders.updateModelProvider
modelProviders.listModelPrices
modelProviders.setModelPrice
SSO
Overview
sso.listDomains
sso.addDomain
sso.verifyDomain
sso.removeDomain
sso.listSsoConnections
sso.createSsoConnection
sso.getSsoConnection
sso.deleteSsoConnection
sso.updateSsoConnection
Usage
Overview
usage.getUsage
usage.listUsageEvents
usage.getCredits
Budgets
Overview
budgets.listBudgets
budgets.createBudget
budgets.getBudget
budgets.deleteBudget
budgets.updateBudget
Platform
Overview
platform.startPlatformProviderAuthorization
platform.completePlatformProviderAuthorization
platform.disconnectPlatformProviderOAuth
platform.getPlatformProviderAvailableModels
platform.getPlatformSettings
platform.updatePlatformSettings
platform.listPlatformOrganizations
platform.updatePlatformOrganization
platform.listPlatformAdmins
platform.addPlatformAdmin
platform.removePlatformAdmin
platform.listPlatformModels
platform.createPlatformModel
platform.getPlatformModel
platform.deletePlatformModel
platform.updatePlatformModel
platform.listPlatformModelProviders
platform.createPlatformModelProvider
platform.getPlatformModelProvider
platform.deletePlatformModelProvider
platform.updatePlatformModelProvider
platform.listPlatformModelPrices
platform.setPlatformModelPrice
platform.getPlatformOrganizationCredits
platform.updatePlatformOrganizationCredits
platform.grantPlatformOrganizationCredits
Bots
Overview
bots.listBots
bots.createBot
bots.getBot
bots.updateBot
bots.botMemory
bots.updateBotMemory
bots.botMemoryLog
bots.purgeBotMemory
bots.memoryBot
bots.updateMemoryBot
bots.listRules
bots.createRule
bots.updateRule
bots.listGrants
bots.createGrant
bots.revokeGrant
bots.listBotMembers
bots.removeBotMember
bots.listBotInvitations
bots.createBotInvitation
bots.botInvitationSecret
bots.revokeBotInvitation
Chats
Overview
chats.sendBotMessage
chats.sendMessage
chats.listChats
chats.getChat
chats.deleteChat
chats.updateChat
chats.chatModels
chats.chatItems
chats.chatTurns
chats.getTurn
chats.turnItems
chats.interruptChat
chats.chatTodos
chats.updateChatTodos
chats.chatDelegations
chats.chatConfessions
chats.chatEnrichments
Executions
Overview
executions.get
executions.events
executions.observe
executions.cancel
executions.decide
Live
Overview
live.createLiveChat
live.connectLive
Files
Overview
files.listFiles
files.uploadFile
files.createUpload
files.completeUpload
files.getFile
files.deleteFile
files.getFileContent
Delegations
Overview
delegations.getDelegation
delegations.cancelDelegation
Bot invitations
Overview
botInvitations.acceptBotInvitation
Triggers
Overview
triggers.listTriggers
triggers.createTrigger
triggers.getTrigger
triggers.deleteTrigger
triggers.updateTrigger
triggers.setTriggerWebhook
triggers.removeTriggerWebhook
Trigger webhooks
Overview
triggerHooks.fireTrigger
Channels
Overview
channels.listChannels
channels.createChannel
channels.getChannel
channels.deleteChannel
channels.updateChannel
channels.setChannelSecret
channels.listChannelIdentities
channels.deleteChannelIdentity
Channel links
Overview
channelLinks.getChannelLink
channelLinks.acceptChannelLink
channelLinks.listMyChannelIdentities
channelLinks.deleteMyChannelIdentity
Channel webhooks
Overview
channelHooks.receiveChannelEvent
Computer providers
Overview
computerProviders.listComputerProviders
computerProviders.createComputerProvider
computerProviders.getComputerProvider
computerProviders.deleteComputerProvider
computerProviders.updateComputerProvider
Computers
Overview
computers.listComputers
computers.createComputer
computers.getComputer
computers.deleteComputer
computers.updateComputer
computers.listComputerBots
computers.grantComputer
computers.revokeComputer
computers.listComputerUsage
computers.pauseComputer
computers.resumeComputer
computers.setConnectorToken
computers.exec
computers.writeStdin
computers.resizeSession
computers.closeSession
computers.readFile
computers.writeFile
computers.removeFile
computers.listFiles
computers.openPort
computers.takeScreenshot
computers.useDesktop
computers.streamDesktop
computers.getComputerPairing
computers.approveComputerPairing
computers.denyComputerPairing
Computer connectors
Overview
computerHooks.startPairing
computerHooks.pollPairing
computerHooks.connectComputer
Secret providers
Overview
secretProviders.listSecretProviders
secretProviders.createSecretProvider
secretProviders.getSecretProvider
secretProviders.deleteSecretProvider
secretProviders.updateSecretProvider
Vaults
Overview
vaults.listVaults
vaults.createVault
vaults.getVault
vaults.deleteVault
vaults.updateVault
vaults.listVaultItems
vaults.createVaultItem
vaults.getVaultItem
vaults.deleteVaultItem
vaults.updateVaultItem
vaults.listVaultBots
vaults.grantVault
vaults.revokeVault
Your settings
Overview
memberSettings.getMemberSettings
memberSettings.updateMemberSettings
Requests
Overview
requests.listRequests
requests.getRequest
requests.resolveRequest
App discovery
Overview
apps.discoverApp
Connections
Overview
connections.getConnectionExecution
connections.createManualConnection
connections.updateManualConnection
connections.verifyConnection
connections.refreshConnectionAuthorization
connections.revalidateConnection
connections.listConnections
connections.createConnection
connections.prepareConnection
connections.getConnectionDraft
connections.getConnection
connections.updateConnection
connections.deleteConnection
App authorization
Overview
appAuthorization.getAppAuthorizationAction
appAuthorization.beginAppAuthorization
appAuthorization.revokeAppAuthorization
appAuthorization.getAppAuthorization
appAuthorization.completeAppAuthorization
App authorization callbacks
Overview
appAuthorizationPublic.appClientMetadata
appAuthorizationPublic.appAuthorizationCallback
Tool calls
Overview
toolCalls.list
toolCalls.get
App operations
Overview
appOperations.get
appOperations.list
appOperations.respond
Code runs
Overview
codeRuns.get
codeRuns.list
App views
Overview
appViews.open
appViews.get
appViews.close
appViews.read
appViews.act
appViews.confirmContext
appViews.interaction
appViews.message
App transfer and reset
Overview
appExperience.export
appExperience.import
appExperience.reset
appExperience.getReset
App Index
Overview
appIndex.listSources
appIndex.searchApps
appIndex.getApp
Developer tools
Overview
developer.personalReports
developer.notifications
developer.readNotification
developer.subscriptions
developer.subscribe
developer.indexingRequests
developer.requestIndexing
developer.indexingRequest
developer.tests
developer.createTest
developer.test
developer.deleteTest
developer.configureTest
developer.runTest
developer.cancelTest
developer.cleanupTest
developer.authorizeTest
developer.completeTestAuthorization
developer.overview
developer.startClaim
developer.getClaim
developer.verifyClaim
developer.revokeClaim
developer.getProof
developer.verifyProof
developer.relinquish
developer.members
developer.invite
developer.invitation
developer.acceptInvitation
developer.revokeInvitation
developer.changeMember
developer.removeMember
developer.reports
developer.saveInspection
developer.report
developer.deleteReport
developer.compare
Public developer tools
Overview
developerPublic.authorizationCallback
developerPublic.inspect
Service and health
Overview
health.getService
health.getHealth
GitHub
Select theme
Dark
Light
Auto
Overview
App operations
Section titled “App operations”
Run App operations and read their results.
Operations
Section titled “Operations”
GET
/v1/app-operations/{id}
GET
/v1/chats/{chatId}/app-operations
POST
/v1/app-operations/{id}/inputs