Diction AGENTS.md

Diction Gateway -- Agent Reference

Machine-legible reference for the Diction self-hosted gateway. Covers routes, wire formats, environment variables, capabilities, and what the gateway can and cannot do.

Overview

The gateway is a Go HTTP service that sits between the Diction iOS app and one or more OpenAI-compatible speech-to-text backends. It handles:

• WebSocket streaming for low-latency transcription
• HTTP transcription fallback
• Optional LLM post-processing (transcript cleanup, voice editing, suggestions)
• Optional trial token auth (Diction One -- not for self-hosters)

WARNING: TEXT_ROUTES_OPEN=false (default). /v1/text/* routes return 403 until you explicitly set TEXT_ROUTES_OPEN=true or AUTH_ENABLED=true. This is a deliberate speed bump -- not a security control. Set it before calling those routes.

Routes

GET /health

Health check. Returns 200 when the gateway is up.

Response: 200 OK
Body: "ok"

GET /v1/models

Lists configured speech backends (OpenAI-compatible + Diction legacy grouping). Also includes a top-level capabilities object describing what this gateway instance can do (additive -- never removes data[] or providers[]).

Response: 200 OK
Content-Type: application/json

{
  "object": "list",
  "data": [
    { "id": "nvidia/parakeet-tdt-0.6b-v3", "object": "model", "created": 0, "owned_by": "nvidia" }
  ],
  "providers": [
    {
      "id": "parakeet",
      "name": "NVIDIA Parakeet",
      "models": [{ "id": "parakeet-v3", "name": "Parakeet v3", "description": "...", "available": true }]
    }
  ],
  "capabilities": {
    "llm": true,
    "text_process": true,
    "text_suggest": true
  }
}

capabilities object:

Field	Type	Meaning
llm	bool	LLM_BASE_URL + LLM_MODEL are set and LLM is active
text_process	bool	/v1/text/process is open (llm=true AND TEXT_ROUTES_OPEN=true, or auth=true)
text_suggest	bool	/v1/text/suggest is open (same condition as text_process)
text_summarize	bool	/v1/text/summarize is open (same condition as text_process)
formatting	bool	the formatting context key is honoured on cleanup (llm=true)