cipher-md-api / API_DOCS.md
sh4lu-z
Add visible and stealth video watermarking features
b4cc46f
|
Raw History Blame Contribute Delete
6.89 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` *(Legacy Alias: `/biologic`)*
මෙම සර්වර් එකෙන් Images (Welcome, Watermark, Stickers) සහ Trading Charts ජෙනරේට් කිරීම සිදු කරයි.
### 1.1 Welcome Image Generator
* **Endpoint:** `POST /visuals/welcome` *(හෝ `POST /biologic/welcome`)*
* **Type:** `multipart/form-data`
* **Parameters:**
* `image` (File) - Profile Picture එක (අනිවාර්යයි)
* `title` (Text) - Group එකේ නම (Optional)
* `count` (Text) - Member අංකය (Optional)
* `userName` (Text) - Member ගේ නම (Optional)
* `style` (Text/Number) - Style ID (1 - 10) (Optional - නොදුන්නොත් random)
* **Response:** PNG Image (`image/png`)
### 1.2 Add Watermark
* **Endpoint:** `POST /visuals/watermark` *(හෝ `POST /biologic/watermark`)*
* **Type:** `multipart/form-data`
* **Parameters (1):**
* `image` (File) - Watermark එක ගහන්න ඕන ෆොටෝ එක (අනිවාර්යයි)
* **Response:** PNG Image (`image/png`)
### 1.3 Add Advanced Stealth Watermark (Ghost Watermark)
* **Endpoint:** `POST /visuals/watermark/advanced` *(හෝ `POST /visuals/watermark/stealth`, `POST /scanner/advanced`)*
* **Type:** `multipart/form-data`
* **Parameters (1):**
* `image` (File) - Stealth watermark එක ගහන්න ඕන ෆොටෝ එක (අනිවාර්යයි)
* **විස්තරය:** ඇසට නොපෙනෙන 2% Opacity එකෙන් Zig-Zag "CIPHER-MD" රටාවක් සහ EXIF Camera Metadata එකතු කරයි. මෙම Watermark එක හඳුනාගත හැක්කේ `/scanner/scan` මඟින් පමණි.
* **Response:** Watermarked Image File (`image/jpeg` / `image/png`)
### 1.4 Add Video Visible Watermark
* **Endpoint:** `POST /visuals/watermark/video` *(හෝ `POST /visuals/watermark/video/visible`)*
* **Type:** `multipart/form-data`
* **Parameters:**
* `video` (File) - MP4/MKV video file (අනිවාර්යයි)
* `text` (Text) - Watermark text එක (Default: `CIPHER-MD`)
* `position` (Text) - `bottom_right`, `bottom_left`, `top_right`, `top_left`, `center` (Default: `bottom_right`)
* `watermark_image` (File) - Custom PNG logo overlay (Optional)
* **Response:** Watermarked Video File (`video/mp4`)
### 1.5 Add Video Stealth (Invisible) Watermark
* **Endpoint:** `POST /visuals/watermark/video/stealth` *(හෝ `POST /visuals/watermark/video/invisible`)*
* **Type:** `multipart/form-data`
* **Parameters:**
* `video` (File) - MP4/MKV video file (අනිවාර්යයි)
* `text` (Text) - Stealth watermark text (Default: `CIPHER-MD`)
* `method` (Text) - `hybrid` (visual 2% + metadata), `visual` (2% frame overlay), `metadata` (instant zero re-encode)
* **Response:** Stealth Protected Video File (`video/mp4`)
### 1.6 Scan Video Watermark
* **Endpoint:** `POST /scanner/scan/video` *(හෝ `POST /scan/video`)*
* **Type:** `multipart/form-data`
* **Parameters:**
* `video` (File) - Scan කරන්න ඕන video file එක (අනිවාර්යයි)
* **Response:** Revealed frame PNG (`image/png`) with `X-Stealth-Metadata` header
### 1.7 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 Engine
**Base URL:** `/audio` *(Legacy Alias: `/audio_server`)*
මෙම සර්වර් එකෙන් Audios වලට විවිධ DJ Effects (Bass, 8D, Nightcore) එකතු කිරීම සිදු කරයි.
### 2.1 Process Audio Effect
* **Endpoint:** `POST /audio/process` *(හෝ `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. Sticker API
**Base URL:** `/sticker` *(Legacy Aliases: `/cipher_sticker`, `/cipher`)*
මෙම සර්වර් එකෙන් Videos වලින් Animated Stickers සහ Sticker Packs සෑදීම සිදු කරයි (Size එක 1MB වලට අඩුවෙන්).
### 3.1 Make Single Sticker
* **Endpoint:** `POST /sticker` *(Legacy Aliases: `POST /sticker/sticker`, `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 /sticker/pack` *(හෝ `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` *(Legacy Aliases: `/scan`, `/math`)*
මෙම සර්වර් එකෙන් ෆොටෝ වල ඇති Watermark අයින් කිරීම/බැලීම සිදු කරයි.
### 4.1 Scan / Reveal Watermark
* **Endpoint:** `POST /scanner/scan` *(හෝ `POST /scan/scan`, `POST /math/scan`)*
* **Type:** `multipart/form-data`
* **Parameters (1):**
* `image` (File) - Watermark එක තියෙන ෆොටෝ එක (අනිවාර්යයි)
* **Response:** Image File (කලින් නොපෙනුණු Watermark එක මතු කළ ෆොටෝව)
---
*Created by Antigravity for Cipher-MD API Gateway.*