Skip to content

BotCity Documentation

Complete API

Sign up for Free

Portuguese
Español
English

Initializing search

Home
Getting Started
Products
Guides & Tutorials
Support
What's new?

BotCity Documentation

Home
Getting Started
Getting Started
- BotCity
- Create an Account
- Prerequisites
- Hardware and Infrastructure Requirements
  Hardware and Infrastructure Requirements
  - Hardware Requirements
  - Machine Size Guiding
- BotCity Studio SDK
- Developing Your First Bot
  Developing Your First Bot
- Orchestrating Your Automation
- Glossary
Products
Products
- Administration
  Administration
  - Organization
    
    Organization
    
    Preferences
    
    Users and Groups
    
    Repositories
    
    Account and Plans
    
    Audit
  - Security Center
    
    Security Center
    
    IP Allowlist
    
    SSO
- Orchestrator
  Orchestrator
  - Workspaces
  - Features
    Features
    
    Operational Center
    
    Operational Center
    
    Live Operation
    
    Automations
    
    Efficiency
    
    Capacity
    
    Schedule
    
    Datapool
    
    Datapool
    
    Getting Started
    
    Manage Items
    
    Tasks
    
    New Task
    
    Easy Deploy
    
    Alerts
    
    Errors
    
    Execution Log
    
    Result Files
    
    Runners
    
    Automations
    
    Bots
    
    Schedules
    
    Credentials
    
    Dev. Environment
  - Maestro SDK
    
    Maestro SDK
    
    Setup
    
    Tasks
    
    Logs
    
    Alerts
    
    Result Files
    
    Credentials
    
    Datapool
    
    Errors
    
    Full API
    Full API
    
    Python
    
    Java
  - Orchestrator API
    Orchestrator API
    
    Examples using Postman
    
    Full API
- BotCity Insights
  BotCity Insights
  - Dashboard
  - Data Input
  - Reporting Data
    Reporting Data
    
    Getting Started
    
    I already use BotCity
    
    Data Reprocessing
  - Runners Data
  - Reports
  - Integrations
    Integrations
    
    Power BI
    
    Other platforms via API
    
    Complete API
  - User Roles
- Integration Hub
  Integration Hub
- Developer Tools
  Developer Tools
  - Code accelerators
    
    Code accelerators
    
    BeaPro Framework
    
    BeaPro Framework
    
    Installation & Setup
    
    Framework Components
    
    BotCity Python Pro skill
    
    Phoenix: UiPath to Python
    
    Phoenix: UiPath to Python
    
    Claude migration
    
    Gemini migration
  - Frameworks
    
    Frameworks
    
    Desktop Automation
    
    Desktop Automation
    
    Display
    
    Computer Vision
    
    Keyboard
    
    Mouse
    
    Clipboard
    
    System
    
    Browser
    
    Waits
    
    Windows Applications
    
    Full API
    Full API
    
    Python
    
    Java
    
    Web Automation
    
    Web Automation
    
    Configuration
    
    Navigation
    
    Alerts
    
    Frames
    
    Display
    
    Computer Vision
    
    DOM
    
    Keyboard
    
    Mouse
    
    Clipboard
    
    Forms
    
    Waits
    
    Parsers
    
    Miscellaneous Functions
    
    Full API
    Full API
    
    Python
    
    Java
  - Plugins
    
    Plugins
    
    Amazon AWS
    
    Amazon AWS
    
    S3
    
    S3
    
    Full API
    Full API
    
    Python
    
    Java
    
    Secrets Manager
    
    Secrets Manager
    
    Full API
    Full API
    
    Python
    
    Java
    
    SQS
    
    SQS
    
    Full API
    Full API
    
    Python
    
    Java
    
    Lambda
    
    Lambda
    
    Full API
    Full API
    
    Python
    
    Java
    
    Textract
    
    Textract
    
    Full API
    Full API
    
    Python
    
    Java
    
    Google
    
    Google
    
    Creating Google Credentials
    
    Gmail
    
    Gmail
    
    Full API
    Full API
    
    Python
    
    Java
    
    Calendar
    
    Calendar
    
    Full API
    Full API
    
    Python
    
    Java
    
    Google Cloud Vision
    
    Google Cloud Vision
    
    Creating a Credential for Google Cloud Vision
    
    Full API
    Full API
    
    Python
    
    Java
    
    Google Drive
    
    Google Drive
    
    Full API
    Full API
    
    Python
    
    Java
    
    Google Sheets
    
    Google Sheets
    
    Full API
    Full API
    
    Python
    
    Java
    
    HashiCorp
    
    HashiCorp
    
    Vault
    
    Vault
    
    Full API
    Full API
    
    Python
    
    Java
    
    Microsoft Office
    
    Microsoft Office
    
    Excel
    
    Excel
    
    Full API
    Full API
    
    Python
    
    Java
    
    Microsoft 365
    
    Microsoft 365
    
    Creating Microsoft 365 Credentials
    
    Credentials
    
    Credentials
    
    Full API
    Full API
    
    Python
    
    Java
    
    OneDrive
    
    OneDrive
    
    Full API
    Full API
    
    Python
    
    Java
    
    Sharepoint
    
    Sharepoint
    
    Full API
    Full API
    
    Python
    
    Java
    
    Excel
    
    Excel
    
    Full API
    Full API
    
    Python
    
    Java
    
    Outlook
    
    Outlook
    
    Using email attributes and filters
    
    Full API
    Full API
    
    Python
    
    Java
    
    Captcha
    
    Captcha
    
    Full API
    Full API
    
    Python
    
    Java
    
    CSV
    
    CSV
    
    Full API
    Full API
    
    Python
    
    Java
    
    Discord
    
    Discord
    
    Full API
    Full API
    
    Python
    
    Java
    
    Email
    
    Email
    
    Sign in with App Passwords
    
    Using email attributes and filters
    
    Full API
    Full API
    
    Python
    
    Java
    
    File Handling
    
    File Handling
    
    Full API
    Full API
    
    Python
    
    Java
    
    FTP/SFTP
    
    FTP/SFTP
    
    Full API
    Full API
    
    Python
    
    Java
    
    HTTP (Requests)
    
    HTTP (Requests)
    
    Full API
    Full API
    
    Python
    
    Java
    
    Recorder
    
    Recorder
    
    Full API
    Full API
    
    Python
    
    Java
    
    Slack
    
    Slack
    
    API Token
    
    Full API
    Full API
    
    Python
    
    Java
    
    Telegram
    
    Telegram
    
    Full API
    Full API
    
    Python
    
    Java
    
    Twilio
    
    Twilio
    
    SMS
    
    SMS
    
    Full API
    Full API
    
    Python
    
    Java
    
    WhatsApp
    
    WhatsApp
    
    Full API
    Full API
    
    Python
    
    Java
    
    WhatsApp
    
    WhatsApp
    
    Account Setup
    
    Full API
    Full API
    
    Python
    
    Java
  - Recommended Packages
  - Studio
    
    Studio
    
    Managing Projects
    
    Computer Vision
    
    Customizing your BotCity Studio
    
    Runtime Environment
  - Studio for Visual Studio Code
  - Runner
    
    Runner
    
    Runner Setup
    
    Observability
    
    Start and Keep the Runner Session Active
  - Session Manager
    
    Session Manager
    
    Getting Started
    
    Commands
    Commands
    
    host
    host
    
    host add
    
    host edit
    
    host remove
    
    runner
    runner
    
    runner attach
    
    runner edit
    
    runner release
    
    config interval
    config interval
    
    host
    
    task
    
    list
    
    run
    
    version
    
    Troubleshooting
  - CLI
    
    CLI
    
    Commands
    Commands
    
    bot
    bot
    
    bot deploy
    
    bot update
    
    bot release
    
    bot list
    
    machine
    machine
    
    machine new
    
    machine status
    
    machine remove
    
    machine log
    
    machine screen
    
    task
    task
    
    task create
    
    task restart
    
    task finish
    
    task cancel
    
    activity
    activity
    
    activity set
    
    log
    log
    
    log create
    
    log delete
    
    log download
    
    log read
    
    export
    export
    
    export taskReport
    
    workspace
    workspace
    
    workspace set
    
    login
  - Containers
    
    Containers
  - CI/CD Integration
    
    CI/CD Integration
- Academy
  Academy
Guides & Tutorials
Guides & Tutorials
- Tutorials
  Tutorials
  - Python Automations
    Python Automations
    
    Using Python
    
    Python "Hello Web Bot"
    
    Automating Windows Applications with BotCity Inspector
    
    Automating Web Pages with BotCity Inspector
    
    Legacy Project Templates
    Legacy Project Templates
    
    Python "Hello Bot"
    
    Python "Hello Web Bot"
  - Java Automations
    Java Automations
    
    Using Java
    
    Java "Hello Web Bot"
  - Javascript Automations
    Javascript Automations
    
    Using Javascript
    
    Javascript "Hello Web Bot"
  - Orchestrating Your Automation
  - Custom Automations
    
    Custom Automations
    
    Python Custom Bot
    
    Java Custom Bot
- How-To
  How-To
Support
Support
- Tickets
- Community
- FAQ
What's new?
What's new?
- 2026
  2026
  - September
  - August
  - July
  - May
  - April
  - March
- 2025
  2025
  - November
  - October
  - September
  - May
  - January
- 2024
  2024
  - December
  - September
  - August
  - July
  - June
  - April

Home
Products
BotCity Insights
Integrations

Complete API¶

Was this page helpful?

Thanks for your feedback!

Thanks for your feedback! Help us improve this page by using our feedback form.

Other platforms via API

Copyright © 2024 BotCity

Made with Material for MkDocs