APIs - altoiddealer/ad_discordbot GitHub Wiki

Overview

This system allows any API-compatible software to be executed via the Tags System and User Commands (upcoming feature).

APIs can also be configured to hook into the bot's core features:

  • Image Generation

  • Text Generation (coming soon)

  • TTS Generation

Previously limited to specific software integrations, this new approach opens the gates for any compatible API system through a flexible, YAML-based configuration. A separate configuration for "Workflows" allows extending Endpoint default behaviors (for example, running specific ComfyUI workflows with unique handling for each one).

Key Features:

  • Plug-in any HTTP/WebSocket API

  • Flexible multi-step response handling and workflows

  • Integrated with Tags System

  • Reusable presets to reduce config duplication

  • Generalized logic supporting progress tracking, base64 decoding, file saving, and more

Configuration

Click on any configuration topic for more information

Bot API Functions

Defines APIs/endpoints for the bot's "main functions" (bot commands, message responses, etc). Only one "main client" allowed for each: ImgGen / TextGen / TTSGen

All APIs

A list of ALL APIs/endpoints including ones being used for main functions, and non-main bot functions (via the Tags system / "user commands", etc)

You may define any number of APIs and their Endpoints, making them available to use for various bot functions

Presets

Any dictionary value in dict_api_settings.yaml can be updated via Presets to limit redundancy.

"Steps" lists can also be bundled up into presets and injected in-line into response_handling and workflows

Workflows

For executing custom logic beyond default Endpoint behaviors (ei: add additional post-processing from a 'post_txt2img' endpoint call). For non-main functions only (N/A to main functions)

Using Tags for API Calls and Workflows

  • Triggering APIs via Tags

  • Workflow Syntax and Logic