Skip to main content

Manage Glossary Entries

Add, list, and delete glossary entries.

Add Entries​

Endpoint​

POST /api/v3/glossaries/{id}/entries

Request​

{
  "entries": [
    {
      "phrase": "myocardial infarction",
      "sounds_like": "my o car dial in farction"
    },
    {
      "phrase": "Scriptix",
      "case_sensitive": true
    }
  ]
}

Response​

{
  "added": 2,
  "entries": [
    {
      "id": 456,
      "phrase": "myocardial infarction",
      "sounds_like": "my o car dial in farction"
    }
  ]
}

List Entries​

Endpoint​

GET /api/v3/glossaries/{id}/entries

Response​

{
  "count": 50,
  "result": [
    {
      "id": 456,
      "phrase": "myocardial infarction",
      "sounds_like": "my o car dial in farction",
      "case_sensitive": false
    }
  ]
}

Delete Entry​

Endpoint​

DELETE /api/v3/glossaries/{id}/entries/{entry_id}

Response​

Status: 204 No Content

Examples​

Add Entries​

response = requests.post(
    'https://api.scriptix.io/api/v3/glossaries/123/entries',
    headers={'Authorization': 'Bearer YOUR_API_KEY'},
    json={
        'entries': [
            {'phrase': 'myocardial infarction'},
            {'phrase': 'API', 'sounds_like': 'A P I'}
        ]
    }
)

result = response.json()
print(f"Added {result['added']} entries")

Bulk Import from CSV​

import csv

entries = []
with open('terms.csv', 'r') as f:
    reader = csv.DictReader(f)
    for row in reader:
        entries.append({
            'phrase': row['phrase'],
            'sounds_like': row.get('sounds_like', '')
        })

response = requests.post(
    'https://api.scriptix.io/api/v3/glossaries/123/entries',
    headers={'Authorization': 'Bearer YOUR_API_KEY'},
    json={'entries': entries}
)

Entry Fields​

FieldTypeRequiredDescription
phrasestringYesTerm or phrase (1-100 chars)
sounds_likestringNoPhonetic spelling
case_sensitivebooleanNoMatch case exactly (default: false)

Best Practices​

Sounds-Like Usage​

// Acronyms
{"phrase": "API", "sounds_like": "A P I"}
{"phrase": "CEO", "sounds_like": "C E O"}

// Product names
{"phrase": "Scriptix", "sounds_like": "skrip tix"}

// Technical terms
{"phrase": "PostgreSQL", "sounds_like": "post gres Q L"}