API Documentation

Welcome to the official Shravani API documentation. This API allows developers and server administrators to programmatically interact with Shravani AI, manage configurations, and trigger custom workflows.

Base URL

https://shravani.xyz/api

Authentication

Currently, the dashboard uses Discord OAuth2 session cookies. For external integration, API Keys can be generated from the Shravani Developer Portal (Coming Soon). Include your API key in the header of your requests:

Authorization: Bearer YOUR_API_KEY

Core Endpoints

GET /api/user/guilds

Fetches a list of Discord servers where the authenticated user has "Manage Server" permissions. Used to populate the dashboard selection.

GET /api/guilds/[serverId]/settings

Retrieves the Shravani configuration for a specific server, including Welcome Messages, AI Monitors, and Role mappings.

POST /api/bots/deploy

Triggers the deployment of a custom Shravani instance to a server with personalized branding and personality parameters.

POST /api/chat

Streams a response from the Shravani AI model. Used internally for the dashboard testing console and Ops Chat.