cipher-md-api / API_DOCS.md
sh4lu-z's picture
refactor: migrate BioLogic engine to Visuals service and implement watermark scanner module
2438c65
|
Raw
History Blame Contribute Delete
4.22 kB
# 📚 Cipher-MD API Documentation
මෙම ලේඛනයේ දැක්වෙන්නේ `Cipher-MD API Bundle` එකේ ඇති සියලුම APIs භාවිතා කරන ආකාරය සහ ඒවාට යැවිය යුතු Parameters පිළිබඳ සම්පූර්ණ විස්තරයයි.
**Main Base URL:** `https://sh4lu-z-cipher-md-api.hf.space`
---
## 🟢 1. Visuals Engine
**Base URL:** `/visuals`
මෙම සර්වර් එකෙන් Images (Welcome, Watermark, Stickers) සහ Trading Charts ජෙනරේට් කිරීම සිදු කරයි.
### 1.1 Welcome Image Generator
* **Endpoint:** `POST /visuals/welcome`
* **Type:** `multipart/form-data`
* **Parameters (3):**
* `image` (File) - Profile Picture එක (අනිවාර්යයි)
* `title` (Text) - Group එකේ නම (Optional)
* `count` (Text) - Member අංකය (Optional)
* **Response:** PNG Image (`image/png`)
### 1.2 Add Watermark
* **Endpoint:** `POST /visuals/watermark`
* **Type:** `multipart/form-data`
* **Parameters (1):**
* `image` (File) - Watermark එක ගහන්න ඕන ෆොටෝ එක (අනිවාර්යයි)
* **Response:** PNG Image (`image/png`)
### 1.3 Candle Chart Generator
* **Endpoint:** `POST /visuals/chart/candle`
* **Type:** `application/json`
* **Parameters JSON:**
* `candles` (Array) - `[{open, high, low, close, volume}, ...]`
* `symbol` (Text) - Coin එකේ නම (උදා: BTC)
* `change` (Text) - වෙනස් වුණු ප්‍රතිශතය
* `currentPrice` (Text/Number) - දැනට තියෙන ගාණ
* **Response:** PNG Image (`image/png`)
*(මෙයට අමතරව `/chart/nft`, `/chart/arb`, `/chart/p2p`, `/chart/forex`, `/chart/gold`, `/chart/cse`, `/chart/fear` යන endpoints සඳහාද අදාළ JSON History Data යැවිය යුතුය.)*
---
## 🎵 2. Audio Server
**Base URL:** `/audio_server`
මෙම සර්වර් එකෙන් Audios වලට විවිධ DJ Effects (Bass, 8D, Nightcore) එකතු කිරීම සිදු කරයි.
### 2.1 Process Audio Effect
* **Endpoint:** `POST /audio_server/process`
* **Type:** `multipart/form-data`
* **Parameters (3):**
* `file` (File) - Audio File එක (MP3/WAV) (අනිවාර්යයි)
* `effect` (Text) - Effect එකේ නම. (උදා: `bass_studio`, `bass_edm`, `bass_car`, `8d_audio`, `vocal_boost`, `nightcore`, `slow_reverb`, `vaporwave`) (අනිවාර්යයි)
* `level` (Number) - Effect එකේ සැර (උදා: `10`)
* **Response:** MP3 Audio File (`audio/mpeg`)
---
## 🎬 3. Cipher Sticker API
**Base URL:** `/cipher_sticker`
මෙම සර්වර් එකෙන් Videos වලින් Animated Stickers සහ Sticker Packs සෑදීම සිදු කරයි (Size එක 1MB වලට අඩුවෙන්).
### 3.1 Make Single Sticker
* **Endpoint:** `POST /cipher_sticker/sticker`
* **Type:** `multipart/form-data`
* **Parameters (1):**
* `file` (File) - Video/GIF/Image එක (අනිවාර්යයි)
* **Response:** WebP Sticker (`image/webp`)
### 3.2 Make Sticker Pack (ZIP)
* **Endpoint:** `POST /cipher_sticker/pack`
* **Type:** `multipart/form-data`
* **Parameters (1):**
* `file` (File) - දිග Video එකක් (උපරිම විනාඩි 2) (අනිවාර්යයි)
* **Response:** ZIP File (`application/zip`) - කොටස් වලට කැඩූ Stickers ගොන්නක්.
---
## 🧮 4. Watermark Scanner
**Base URL:** `/scanner`
මෙම සර්වර් එකෙන් ෆොටෝ වල ඇති Watermark අයින් කිරීම/බැලීම සිදු කරයි.
### 4.1 Scan / Reveal Watermark
* **Endpoint:** `POST /scanner/scan`
* **Type:** `multipart/form-data`
* **Parameters (1):**
* `image` (File) - Watermark එක තියෙන ෆොටෝ එක (අනිවාර්යයි)
* **Response:** Image File (කලින් නොපෙනුණු Watermark එක මතු කළ ෆොටෝව)
---
*Created by Antigravity for Cipher-MD API Gateway.*