AI Bots - API Documentation
Full reference for all commands and bot types.
In all URLs below, replace XXX with your AI Apps Account ID, found in your account settings.
How Endpoints Work
Two ways to call each endpoint, read this first
App Command (API Call)
POST your request to
Mode / Webhook (Direct URL)
POST directly to the endpoint URL shown in each section. The fields go in the POST body as standard form fields (the same fields you would include in an HTML form POST). Use this method for provider webhooks, website forms, or any third-party system that sends form data. No API key is required, the account ID is part of the URL.
POST your request to
https://api.aiappsapi.com with your API key and account ID in the POST body. The fields described in each section below go inside the jsonData POST field as a JSON-encoded string. Use this method when your server is making the call and you have your API credentials available.Mode / Webhook (Direct URL)
POST directly to the endpoint URL shown in each section. The fields go in the POST body as standard form fields (the same fields you would include in an HTML form POST). Use this method for provider webhooks, website forms, or any third-party system that sends form data. No API key is required, the account ID is part of the URL.
AI Bots is available through App Commands only. There are no mode or webhook URLs for this app.
Run Bot
command: runbot
Runs one of your configured AI bots. Each bot has a type that determines which input field is required and what the response looks like. You configure your bots in the admin area where you set the type, AI model, custom rules, and other options. All responses are returned in the
message field. Works with your own API keys or platform keys.
POST App Command URL
https://api.aiappsapi.com app: aibots command: runbot
This command is only available as an App Command. It is not available as a direct mode or webhook URL.
Required Fields (all bot types)
| Field Name | Field Key | Notes |
|---|---|---|
| Bot ID | botID | The numeric index of the bot to run. Found in your admin area under AI Bots. |
Bot Types
Each bot has a type configured in your admin area. The type determines which additional field is required when calling the bot and what kind of response it returns. All responses are returned in the
message field.
| Bot Type | Required Field | Description |
|---|---|---|
general |
prompt | A general purpose AI call. Send any text prompt and get a full text response. Use the custom rules and extra prompt fields on the bot to pre-configure how the AI responds. |
linuxmonitor |
filecontent | Analyzes the output of Linux server diagnostic commands. Send the combined output of multiple commands, each preceded by the command that was run. Returns a one-line summary for each command in a format that is easy to scan quickly. |
websitemonitor |
url | Checks if a website is working. The system fetches the URL and analyzes the content. Returns up if the site loaded normally, or down if there is any problem such as errors, SSL issues, or the site being unreachable. |
logmonitor |
filecontent | Analyzes log file content from any server or application. Groups and counts repeated entries and highlights anything unusual. Returns a concise, readable summary instead of raw log data. |
botdetection |
browser | Checks a browser user-agent string to determine if the visitor is an automated bot or a real person. Returns yes if it looks like a bot, or no if it looks like a real person. |