Support Log in

20. Glossary API

Developer Guide
Prefer video? Watch the Lang Forge tutorials 9 short guides covering every feature Watch

Free feature. REST endpoints for managing translation glossary terms. Automatic glossary application during AI translation requires PRO (since AI translation itself is PRO), but glossary CRUD and CSV import/export are available on Free.

GET /langforge/v1/glossary

List glossary terms with optional filtering by language pair and search.

Permission: edit_posts Request:
bash
curl -s "https://example.com/wp-json/langforge/v1/glossary?from=en&to=ru&search=brand" 
  -u "admin:XXXX XXXX XXXX XXXX XXXX XXXX"
Parameters:
ParameterTypeRequiredDescription
fromstringNoFilter by source lang
tostringNoFilter by target lang
searchstringNoSearch term in source/translated text
Response (200):
json
[
    {
        "id": 1,
        "source_term": "Forge Suite",
        "translated_term": "",
        "source_lang": "en",
        "target_lang": "ru",
        "description": "Product brand name",
        "do_not_translate": 1,
        "case_sensitive": 1
    },
    {
        "id": 2,
        "source_term": "Dashboard",
        "translated_term": "Панель управления",
        "source_lang": "en",
        "target_lang": "ru",
        "description": "",
        "do_not_translate": 0,
        "case_sensitive": 0
    }
]

POST /langforge/v1/glossary

Create a new glossary entry.

Permission: manage_options Request:
bash
curl -s -X POST "https://example.com/wp-json/langforge/v1/glossary" 
  -u "admin:XXXX XXXX XXXX XXXX XXXX XXXX" 
  -H "Content-Type: application/json" 
  -d '{
    "source_term": "Shopping Cart",
    "translated_term": "Корзина",
    "source_lang": "en",
    "target_lang": "ru",
    "description": "E-commerce cart",
    "do_not_translate": false,
    "case_sensitive": false
  }'
Parameters:
ParameterTypeRequiredDescription
source_termstringYesThe term in the source language
translated_termstringNoThe translation (empty if do_not_translate)
source_langstringYesSource language code
target_langstringYesTarget language code
descriptionstringNoOptional description or context
do_not_translatebooleanNoMark as “do not translate” (brand names)
case_sensitivebooleanNoWhether matching should be case-sensitive
Response (200):
json
{
    "success": true,
    "id": 3
}

POST /langforge/v1/glossary/check

Check text for glossary terms that should be applied during translation.

Permission: edit_posts Request:
bash
curl -s -X POST "https://example.com/wp-json/langforge/v1/glossary/check" 
  -u "admin:XXXX XXXX XXXX XXXX XXXX XXXX" 
  -H "Content-Type: application/json" 
  -d '{
    "text": "Add items to your Shopping Cart and proceed to checkout.",
    "from": "en",
    "to": "ru"
  }'
Response (200):
json
{
    "terms_found": [
        {
            "term": "Shopping Cart",
            "translation": "Корзина",
            "position": 22,
            "do_not_translate": false
        }
    ]
}

POST /langforge/v1/glossary/import

Import glossary terms from a CSV file.

Permission: manage_options Request:
bash
curl -s -X POST "https://example.com/wp-json/langforge/v1/glossary/import" 
  -u "admin:XXXX XXXX XXXX XXXX XXXX XXXX" 
  -F "[email protected]"
Response (200):
json
{
    "success": true,
    "imported": 45,
    "skipped": 3,
    "errors": []
}

Forge AI Assistant Online

Hi! I'm the Lang Forge AI assistant. Ask me anything about the plugin — setup, features, troubleshooting, or development.

Just now
Powered by Forge AI · Browse docs