Skip to main content

Glossaries API

Create and manage custom glossaries for improved terminology recognition.

Overview​

Glossaries help improve transcription accuracy for:

  • Industry-specific terms
  • Product names
  • Company names
  • Acronyms
  • Technical jargon
  • Proper nouns

Quick Start​

Create Glossary​

curl -X POST https://api.scriptix.io/api/v3/glossaries \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Medical Terminology",
    "language": "en"
  }'

Add Terms​

curl -X POST https://api.scriptix.io/api/v3/glossaries/123/entries \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entries": [
      {"phrase": "myocardial infarction"},
      {"phrase": "electrocardiogram", "sounds_like": "e k g"}
    ]
  }'

Use in Transcription​

curl -X POST https://api.scriptix.io/api/v3/stt \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "language=en" \
  -F "glossary_id=123" \
  -F "audio_file=@medical.mp3"

Glossary Object​

{
  "id": 123,
  "name": "Medical Terminology",
  "language": "en",
  "entries_count": 50,
  "created_at": "2025-01-17T10:00:00Z",
  "updated_at": "2025-01-17T15:30:00Z"
}

Entry Object​

{
  "id": 456,
  "phrase": "myocardial infarction",
  "sounds_like": "my o car dial in farction",
  "case_sensitive": false
}

Features​

  • Phrase matching: Exact phrase recognition
  • Sounds-like: Phonetic alternatives
  • Case sensitivity: Optional case matching
  • Bulk import: Upload CSV files
  • Multi-language: Support for all languages

API Endpoints​

MethodEndpointDescription
POST/api/v3/glossariesCreate glossary
GET/api/v3/glossariesList glossaries
GET/api/v3/glossaries/{id}Get glossary
PATCH/api/v3/glossaries/{id}Update glossary
DELETE/api/v3/glossaries/{id}Delete glossary
POST/api/v3/glossaries/{id}/entriesAdd entries
GET/api/v3/glossaries/{id}/entriesList entries
DELETE/api/v3/glossaries/{id}/entries/{entry_id}Delete entry

Best Practices​

1. Use Specific Phrases​

// ✅ Specific
{"phrase": "Scriptix API"}

// ❌ Too general
{"phrase": "API"}

2. Add Sounds-Like for Acronyms​

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

3. Organize by Domain​

Create separate glossaries for different domains:

  • Medical Glossary
  • Legal Glossary
  • Company Names Glossary

Next Steps​