BotCity icon

BotCity

BotCity orchestrator API

Overview

This node integrates with the BotCity Orchestrator API to start a bot execution task. It allows users to trigger a specific bot (identified by name or ID) with customizable parameters, priority, and test mode settings. This is useful in automation workflows where you want to programmatically launch bots for tasks such as data processing, testing, or other automated operations managed by BotCity.

Practical examples:

  • Starting a bot that processes incoming customer support tickets.
  • Launching a test run of a bot to verify new automation logic before production.
  • Running a high-priority bot task during peak business hours.

Properties

Name Meaning
Name or ID The name or unique identifier of the bot to start. Choose from a list or specify dynamically via expression.
Priority Numeric priority level to assign to the task when running it. Higher values may indicate higher priority.
Test Task Boolean flag indicating whether this is a test task. Enables running the bot in test mode if true.
Params A collection of key-value pairs representing input parameters for the bot. Each parameter can be selected from a list or specified by ID, with an associated string value. Multiple parameters can be provided.

Output

The node outputs JSON data representing the response from the BotCity Orchestrator API after attempting to start the bot execution. This typically includes details about the started task such as its ID, status, and any relevant metadata returned by the orchestrator.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the BotCity Orchestrator API.
  • The base URL for the API must be configured in the credentials.
  • The node depends on dynamic loading methods to fetch available bots and their parameters (getBots and getBotParams), which are used to populate dropdown options in the UI.

Troubleshooting

  • Common issues:
    • Invalid or missing API credentials will cause authentication failures.
    • Specifying a bot name or ID that does not exist or is unavailable will result in errors.
    • Incorrect parameter names or types may cause the orchestrator to reject the request.
  • Error messages:
    • Authentication errors: Verify that the API key and base URL are correctly set in the credentials.
    • "Bot not found" or similar: Check that the bot name/ID is correct and accessible.
    • Parameter validation errors: Ensure all required parameters are provided and correctly formatted.

Links and References

Discussion