### GET /api/v1/app Source: https://github.com/3dproger/axelchat/blob/main/docs.md Retrieves information about the AxelChat version. ```APIDOC ## GET /api/v1/app ### Description Retrieves information about the AxelChat version. ### Method GET ### Endpoint http://127.0.0.1:8356/api/v1/app ### Parameters None documented. ### Request Example GET http://127.0.0.1:8356/api/v1/app ### Response No response body is documented. ``` -------------------------------- ### GET /api/v1/set-visibility Source: https://github.com/3dproger/axelchat/blob/main/docs.md Sets the visibility of the main AxelChat window. Use the 'main' query parameter to hide or show the window. ```APIDOC ## GET /api/v1/set-visibility ### Description Sets the visibility of the main AxelChat window. Use the 'main' query parameter to hide or show the window. ### Method GET ### Endpoint http://127.0.0.1:8356/api/v1/set-visibility ### Parameters #### Query Parameters - **main** (integer) - Required - Set to 0 to hide the main window, 1 to show it. ### Request Example GET http://127.0.0.1:8356/api/v1/set-visibility?main=0 ### Response No response body is documented. ``` -------------------------------- ### GET /api/v1/selected-messages Source: https://github.com/3dproger/axelchat/blob/main/docs.md Retrieves a list of selected messages. ```APIDOC ## GET /api/v1/selected-messages ### Description Retrieves a list of selected messages. ### Method GET ### Endpoint http://127.0.0.1:8356/api/v1/selected-messages ### Parameters None documented. ### Request Example GET http://127.0.0.1:8356/api/v1/selected-messages ### Response No response body is documented. ``` -------------------------------- ### GET /api/v1/state Source: https://github.com/3dproger/axelchat/blob/main/docs.md Retrieves information about the status of connected platforms, including viewer counts and more. ```APIDOC ## GET /api/v1/state ### Description Retrieves information about the status of connected platforms, including viewer counts and more. ### Method GET ### Endpoint http://127.0.0.1:8356/api/v1/state ### Parameters None documented. ### Request Example GET http://127.0.0.1:8356/api/v1/state ### Response No response body is documented. ``` -------------------------------- ### GET /api/v1/chat/clear Source: https://github.com/3dproger/axelchat/blob/main/docs.md Clears the chat. Available since version 0.40.5. ```APIDOC ## GET /api/v1/chat/clear ### Description Clears the chat. Available since version 0.40.5. ### Method GET ### Endpoint http://127.0.0.1:8356/api/v1/chat/clear ### Parameters None documented. ### Request Example GET http://127.0.0.1:8356/api/v1/chat/clear ### Response No response body is documented. ``` -------------------------------- ### GET /api/v1/messages Source: https://github.com/3dproger/axelchat/blob/main/docs.md Retrieves a list of the last messages. Use the 'count' query parameter to specify the number of messages to return. ```APIDOC ## GET /api/v1/messages ### Description Retrieves a list of the last messages. Use the 'count' query parameter to specify the number of messages to return. ### Method GET ### Endpoint http://127.0.0.1:8356/api/v1/messages ### Parameters #### Query Parameters - **count** (integer) - Optional - Number of messages to retrieve. Example: 100. ### Request Example GET http://127.0.0.1:8356/api/v1/messages?count=100 ### Response No response body is documented. ``` -------------------------------- ### HELLO (Server to Client, before 0.47.6) Source: https://github.com/3dproger/axelchat/blob/main/docs.md Legacy format of the HELLO message sent by AxelChat before version 0.47.6. Contains the client UUID and services information. ```APIDOC ## HELLO (Server to Client, before 0.47.6) ### Description Legacy format of the HELLO message sent by AxelChat before version 0.47.6. Contains the client UUID and services information. ### Message Type HELLO ### Data Fields - **data.app_name** (string) - Application name (e.g., "AxelChat") - **data.app_version** (string) - Application version - **data.client_uuid** (string) - Client UUID assigned by AxelChat - **data.services** (array) - List of services; contains the client ID assigned by AxelChat ### Message Example ```json { "data": { "app_name": "AxelChat", "app_version": "0.37.3", "client_uuid": "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}", "services": [] }, "type": "HELLO" } ``` ``` -------------------------------- ### HELLO (Server to Client, since 0.47.6) Source: https://github.com/3dproger/axelchat/blob/main/docs.md Sent by AxelChat after connection to provide information about the application and the connected client. Contains the client ID in the services field. ```APIDOC ## HELLO (Server to Client, since 0.47.6) ### Description Sent by AxelChat after connection to provide information about the application and the connected client. Contains the client ID in the services field. ### Message Type HELLO ### Data Fields - **data.app.locale** (string) - Application locale - **data.app.name** (string) - Application name (e.g., "AxelChat") - **data.app.version** (string) - Application version - **data.client.address** (string) - Client address - **data.client.executablePath** (string) - Path to executable - **data.client.executableVersion** (string) - Executable version - **data.client.local** (boolean) - Whether client is local - **data.client.pid** (integer) - Process ID - **data.client.port** (integer) - Port number - **data.services** (array) - List of services; contains the client ID assigned by AxelChat ### Message Example ```json { "data": { "app": { "locale": "en-US", "name": "AxelChat", "version": "0.47.6" }, "client": { "address": "127.0.0.1", "executablePath": "", "executableVersion": "", "local": true, "pid": 12345, "port": 54321 }, "services": [] }, "type": "HELLO" } ``` ``` -------------------------------- ### HELLO (Client to Server, DEPRECATED) Source: https://github.com/3dproger/axelchat/blob/main/docs.md Deprecated since 0.47.6. Immediately after connecting, the client should send this message to provide AxelChat with information about the client. If not sent within a few seconds, the connection is terminated. ```APIDOC ## HELLO (Client to Server, DEPRECATED) ### Description Deprecated since 0.47.6. Immediately after connecting, the client should send this message to provide AxelChat with information about the client. If not sent within a few seconds, the connection is terminated. ### Message Type HELLO ### Data Fields - **data.client.name** (string) - Required - Name of your client - **data.client.version** (string) - Required - Your client version - **data.client.type** (string) - Required - Must be "MAIN_WEBSOCKETCLIENT" - **data.info.name** (string) - Required - Additional client name - **data.info.type** (string) - Required - Must be "GENERIC" ### Message Example ```json { "data": { "client": { "name": "", "version": "", "type": "MAIN_WEBSOCKETCLIENT" }, "info": { "name": "", "type": "GENERIC" } }, "type": "HELLO" } ``` ``` -------------------------------- ### Receive HELLO message from AxelChat (since 0.47.6) Source: https://github.com/3dproger/axelchat/blob/main/docs.md AxelChat sends this message after a client connects. It contains app information, client details (address, executable path, PID, port), and a services array. The services field displays the client ID assigned by AxelChat. ```JSON { "data": { "app": { "locale": "en-US", "name": "AxelChat", "version": "0.47.6" }, "client": { "address": "127.0.0.1", "executablePath": "", "executableVersion": "", "local": true, "pid": 12345, "port": 54321 }, "services": [...] }, "type": "HELLO" } ``` -------------------------------- ### Receive HELLO message from AxelChat (before 0.47.6) Source: https://github.com/3dproger/axelchat/blob/main/docs.md Older format of the HELLO message sent by AxelChat before version 0.47.6. Contains app name/version, client UUID, and services array. The services field stores information about currently supported services. ```JSON { "data": { "app_name": "AxelChat", "app_version": "0.37.3", "client_uuid": "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}", "services": [...] }, "type": "HELLO" } ``` -------------------------------- ### Send HELLO message with client info (deprecated since 0.47.6) Source: https://github.com/3dproger/axelchat/blob/main/docs.md Immediately after connecting, send this JSON message to provide AxelChat with client information. If not sent within a few seconds or if another message is sent, the connection is automatically terminated. Deprecated since 0.47.6. ```JSON { "data": { "client": { "name": "", "version": "" "type": "MAIN_WEBSOCKETCLIENT", }, "info": { "name": "", "type": "GENERIC" } }, "type": "HELLO" } ``` -------------------------------- ### SERVER_ALIVE (since 0.47.6) Source: https://github.com/3dproger/axelchat/blob/main/docs.md Sent by the server to indicate it is active. If this message is not received for an extended period, the server may have shut down, frozen, or the connection may be severed. ```APIDOC ## SERVER_ALIVE (since 0.47.6) ### Description Sent by the server to indicate it is active. If this message is not received for an extended period, the server may have shut down, frozen, or the connection may be severed. ### Message Type SERVER_ALIVE ### Data Fields - **data** (null) - Always null ### Message Example ```json { "data": null, "type": "SERVER_ALIVE" } ``` ``` -------------------------------- ### Receive STATES_CHANGED message with service statuses Source: https://github.com/3dproger/axelchat/blob/main/docs.md Provides information about the status of services, including connection state, enabled flag, type ID, icon path, viewer counts, and follower counts. Also includes a total viewer count. ```JSON { "data": { "services": [ { "connection_state": "connecting", "enabled": true, "type_id": "youtube", "icon": "/resources?path=qrc:/resources/images/youtube-icon.svg", "viewers": 11, "viewersCounterEnabled": true, "followers": -1 }, { "connection_state": "not_connected", "enabled": false, "type_id": "twitch", "icon": "/resources?path=qrc:/resources/images/twitch-icon.svg", "viewers": 13, "viewersCounterEnabled": true, "followers": 123 } ], "viewers": 24 }, "type": "STATES_CHANGED" } ``` -------------------------------- ### POST /api/v1/receive-events Source: https://github.com/3dproger/axelchat/blob/main/docs.md Allows adding new messages to AxelChat and modifying or deleting existing ones. This endpoint can be used for sending test events or integrating with third-party programs. The request body must contain an array of event objects (or a single object since version 0.48.1). ```APIDOC ## POST /api/v1/receive-events ### Description Allows adding new messages to AxelChat and modifying or deleting existing ones. This endpoint can be used for sending test events or integrating with third-party programs. The request body must contain an array of event objects (or a single object since version 0.48.1). ### Method POST ### Endpoint http://127.0.0.1:8356/api/v1/receive-events ### Parameters #### Request Body - **events** (array of objects) - Required - Array of event objects. Each object represents an event, such as a message event. Fields are optional unless noted. - **id** (string) - Optional - Event ID. If not specified, AxelChat generates it automatically. - **authorId** (string) - Optional - Message author ID. If not specified, AxelChat generates it automatically. - **serviceId** (string) - Optional - Text ID of the platform from which the event was received. If unknown, you can create your own ID. - **serviceBadge** (string) - Optional - URL to the platform's icon. Recommended if using a custom serviceId. - **edited** (boolean) - Optional - If true, the message will overwrite an existing message with the same ID. - **markedAsDeleted** (boolean) - Optional - If true, the message will be deleted (since version 0.47.6). - **reply** (object) - Optional - Reply information. Fields are optional but recommended (since version 0.47.6). ### Request Example POST http://127.0.0.1:8356/api/v1/receive-events Content-Type: application/json [ { "id": "custom-id", "authorId": "author-123", "serviceId": "custom-platform", "serviceBadge": "https://example.com/icon.png", "edited": false, "markedAsDeleted": false, "reply": {} } ] ### Response If successfully processed, returns information about how the event was handled, including IDs of messages that were added, updated, or deleted. ``` -------------------------------- ### Receive SERVER_ALIVE message (since 0.47.6) Source: https://github.com/3dproger/axelchat/blob/main/docs.md The server sends this message to indicate it is active. If it is not received for an extended period, the server may have shut down, frozen, or the connection may be severed. ```JSON { "data": null, "type": "SERVER_ALIVE" } ``` -------------------------------- ### STATES_CHANGED Source: https://github.com/3dproger/axelchat/blob/main/docs.md Sent by the server to provide information about the status of services, including connection state, enabled status, viewers, and followers. ```APIDOC ## STATES_CHANGED ### Description Sent by the server to provide information about the status of services, including connection state, enabled status, viewers, and followers. ### Message Type STATES_CHANGED ### Data Fields - **data.services** (array) - List of service statuses - **connection_state** (string) - Connection state (e.g., "connecting", "not_connected") - **enabled** (boolean) - Whether the service is enabled - **type_id** (string) - Service type identifier (e.g., "youtube", "twitch") - **icon** (string) - Icon path - **viewers** (integer) - Number of viewers - **viewersCounterEnabled** (boolean) - Whether viewers counter is enabled - **followers** (integer) - Number of followers - **data.viewers** (integer) - Total viewers across services ### Message Example ```json { "data": { "services": [ { "connection_state": "connecting", "enabled": true, "type_id": "youtube", "icon": "/resources?path=qrc:/resources/images/youtube-icon.svg", "viewers": 11, "viewersCounterEnabled": true, "followers": -1 }, { "connection_state": "not_connected", "enabled": false, "type_id": "twitch", "icon": "/resources?path=qrc:/resources/images/twitch-icon.svg", "viewers": 13, "viewersCounterEnabled": true, "followers": 123 } ], "viewers": 24 }, "type": "STATES_CHANGED" } ``` ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.