Create AGENTS.md

AGENTS.md

@@ -0,0 +1,66 @@
+# AGENTS.md — LibreTranslate Kabyle Space
+
+## Overview
+This Hugging Face Space hosts a LibreTranslate instance for **Kabyle (kab)** language translation.
+It provides a self-hosted translation API with experimental Kabyle language models.
+
+## Space Details
+- **URL**: https://huggingface.co/spaces/boffire/libreTranslate_kabyle
+- **Runtime**: Docker Space (LibreTranslate)
+- **Languages**: Kabyle (kab) ↔ English
+
+## API Endpoints
+
+The LibreTranslate API is exposed at the Space's runtime URL:
+```
+https://boffire-libretranslate-kabyle.hf.space
+```
+
+### Key Endpoints
+
+| Endpoint | Method | Description |
+|----------|--------|-------------|
+| `/translate` | POST | Translate text between languages |
+| `/detect` | POST | Detect the language of given text |
+| `/languages` | GET | List supported languages |
+| `/suggest` | POST | Submit a translation suggestion |
+
+### Authentication
+- **Public access**: The API is publicly accessible when the Space is running
+- **HF Token**: For private Spaces or higher rate limits, pass `Authorization: Bearer $HF_TOKEN`
+
+### Example: Translate Text
+```bash
+curl -X POST https://boffire-libretranslate-kabyle.hf.space/translate \
+  -H "Content-Type: application/json" \
+  -d '{
+    "q": "Azul, amek i tettiliḍ?",
+    "source": "kab",
+    "target": "en"
+  }'
+```
+
+### Example: Detect Language
+```bash
+curl -X POST https://boffire-libretranslate-kabyle.hf.space/detect \
+  -H "Content-Type: application/json" \
+  -d '{
+    "q": "Azul, amek i tettiliḍ?"
+  }'
+```
+
+### Example: List Languages
+```bash
+curl https://boffire-libretranslate-kabyle.hf.space/languages
+```
+
+## Translation Models
+The space runs experimental Kabyle models:
+- Default is : kab
+- Model: `Kabyle (OS)` — trained with OpenSubtitles backtranslation data
+- Experimental variants: `kab_comp`, `kab_comp2`, `kab_all`, `kab_kab`
+
+## Important Notes
+- The Space may go to sleep after inactivity (cold start ~30s)
+- Suggestions are stored in the dataset `boffire/libretranslate-en-kab-suggestions`
+- Language codes use `kab` for standard Kabyle