Spell Correction — MDDB API

SymSpell-based FTS spell suggestions, text cleanup, and per-collection custom dictionaries (requires MDDB_SPELL=true)

Spell correction suggestions #

POST /v1/spell-suggest

Returns per-token spell suggestions and a corrected version of the input text. Requires MDDB_SPELL=true.

Authorization: BearerAuth or APIKeyAuth or none

Request body #

Required.

Content type application/json: object

Property	Type	Description
`collection`	`string`	Optional — scope suggestions to collection dictionary
`text` (required)	`string`
`lang` (required)	`string`
`maxSuggestions`	`integer`	Default `5`.

{
  "collection": "string",
  "lang": "en",
  "maxSuggestions": 5,
  "text": "string"
}

Responses #

Status	Description	Body
`200`	Spell suggestions	`object` (application/json)
`503`	Spell index still loading — retry
`400`	The request is malformed (a body that is not JSON, a missing or invalid field, an unreadable body) or names a subsystem that is not initialized. The message says which.	`ErrorResponse` (application/json)
`401`	Auth is on (MDDB_AUTH_ENABLED=true) and the request carries no credentials, an invalid or expired JWT, or an unknown API key.	`ErrorResponse` (application/json)
`403`	The caller lacks the permission the route needs (SEC-019 access gate, auth on: read, write or admin on the collections the request names), or a write meets read-only mode (MDDB_MODE=read or the protocol's own mode).	`ErrorResponse` (application/json)
`413`	The body is over MDDB_MAX_BODY_BYTES (32 MiB by default).	`ErrorResponse` (application/json)
`429`	The client is over the API rate limit (MDDB_RATE_LIMIT_ENABLED=true, MDDB_RATE_LIMIT_REQUESTS per MDDB_RATE_LIMIT_WINDOW seconds). A call that embeds can also be refused by the collection's daily embedding budget, with a QuotaExceeded body.	`RateLimitError` (application/json)

400 example (application/json)

{
  "error": "missing collection"
}

401 example (application/json)

{
  "error": "missing authentication"
}

403 example (application/json)

{
  "error": "forbidden"
}

413 example (application/json)

{
  "error": "request body too large"
}

Apply spell corrections to text #

POST /v1/spell-cleanup

Applies the best corrections to each token and returns the cleaned text. Requires MDDB_SPELL=true.

Authorization: BearerAuth or APIKeyAuth or none

Request body #

Required.

Content type application/json: object

Property	Type	Description
`collection`	`string`
`text` (required)	`string`
`lang` (required)	`string`

{
  "collection": "string",
  "lang": "string",
  "text": "string"
}

Responses #

Status	Description	Body
`200`	Cleaned text	`object` (application/json)
`503`	Spell index still loading — retry
`400`	The request is malformed (a body that is not JSON, a missing or invalid field, an unreadable body) or names a subsystem that is not initialized. The message says which.	`ErrorResponse` (application/json)
`401`	Auth is on (MDDB_AUTH_ENABLED=true) and the request carries no credentials, an invalid or expired JWT, or an unknown API key.	`ErrorResponse` (application/json)
`403`	The caller lacks the permission the route needs (SEC-019 access gate, auth on: read, write or admin on the collections the request names), or a write meets read-only mode (MDDB_MODE=read or the protocol's own mode).	`ErrorResponse` (application/json)
`413`	The body is over MDDB_MAX_BODY_BYTES (32 MiB by default).	`ErrorResponse` (application/json)
`429`	The client is over the API rate limit (MDDB_RATE_LIMIT_ENABLED=true, MDDB_RATE_LIMIT_REQUESTS per MDDB_RATE_LIMIT_WINDOW seconds). A call that embeds can also be refused by the collection's daily embedding budget, with a QuotaExceeded body.	`RateLimitError` (application/json)

400 example (application/json)

{
  "error": "missing collection"
}

401 example (application/json)

{
  "error": "missing authentication"
}

403 example (application/json)

{
  "error": "forbidden"
}

413 example (application/json)

{
  "error": "request body too large"
}

List custom dictionary words #

GET /v1/spell-dictionary

Returns words in the custom dictionary for the given collection and language.

Authorization: BearerAuth or APIKeyAuth or none

Parameters #

Name	In	Type	Description
`collection`	query	`string`
`lang` (required)	query	`string`

Responses #

Status	Description	Body
`200`	Dictionary words	`object` (application/json)
`400`	The request is malformed (a body that is not JSON, a missing or invalid field, an unreadable body) or names a subsystem that is not initialized. The message says which.	`ErrorResponse` (application/json)
`401`	Auth is on (MDDB_AUTH_ENABLED=true) and the request carries no credentials, an invalid or expired JWT, or an unknown API key.	`ErrorResponse` (application/json)
`403`	The caller lacks the permission the route needs (SEC-019 access gate, auth on: read, write or admin on the collections the request names), or a write meets read-only mode (MDDB_MODE=read or the protocol's own mode).	`ErrorResponse` (application/json)
`429`	The client is over the API rate limit (MDDB_RATE_LIMIT_ENABLED=true, MDDB_RATE_LIMIT_REQUESTS per MDDB_RATE_LIMIT_WINDOW seconds). A call that embeds can also be refused by the collection's daily embedding budget, with a QuotaExceeded body.	`RateLimitError` (application/json)

400 example (application/json)

{
  "error": "missing collection"
}

401 example (application/json)

{
  "error": "missing authentication"
}

403 example (application/json)

{
  "error": "forbidden"
}

Add words to custom dictionary #

PUT /v1/spell-dictionary

Authorization: BearerAuth or APIKeyAuth or none

Request body #

Required.

Content type application/json: object

Property	Type	Description
`collection`	`string`
`lang` (required)	`string`
`words` (required)	`array of string`
`frequency`	`integer`	Boost frequency for added words Default `100`.

{
  "collection": "string",
  "frequency": 100,
  "lang": "string",
  "words": [
    "string"
  ]
}

Responses #

Status	Description	Body
`200`	Words added	`object` (application/json)
`400`	The request is malformed (a body that is not JSON, a missing or invalid field, an unreadable body) or names a subsystem that is not initialized. The message says which.	`ErrorResponse` (application/json)
`401`	Auth is on (MDDB_AUTH_ENABLED=true) and the request carries no credentials, an invalid or expired JWT, or an unknown API key.	`ErrorResponse` (application/json)
`403`	The caller lacks the permission the route needs (SEC-019 access gate, auth on: read, write or admin on the collections the request names), or a write meets read-only mode (MDDB_MODE=read or the protocol's own mode).	`ErrorResponse` (application/json)
`413`	The body is over MDDB_MAX_BODY_BYTES (32 MiB by default).	`ErrorResponse` (application/json)
`429`	The client is over the API rate limit (MDDB_RATE_LIMIT_ENABLED=true, MDDB_RATE_LIMIT_REQUESTS per MDDB_RATE_LIMIT_WINDOW seconds). A call that embeds can also be refused by the collection's daily embedding budget, with a QuotaExceeded body.	`RateLimitError` (application/json)

400 example (application/json)

{
  "error": "missing collection"
}

401 example (application/json)

{
  "error": "missing authentication"
}

403 example (application/json)

{
  "error": "forbidden"
}

413 example (application/json)

{
  "error": "request body too large"
}

Remove words from custom dictionary #

DELETE /v1/spell-dictionary

Authorization: BearerAuth or APIKeyAuth or none

Request body #

Required.

Content type application/json: object

Property	Type	Description
`collection`	`string`
`lang` (required)	`string`
`words` (required)	`array of string`

{
  "collection": "string",
  "lang": "string",
  "words": [
    "string"
  ]
}

Responses #

Status	Description	Body
`200`	Words removed	`object` (application/json)
`400`	The request is malformed (a body that is not JSON, a missing or invalid field, an unreadable body) or names a subsystem that is not initialized. The message says which.	`ErrorResponse` (application/json)
`401`	Auth is on (MDDB_AUTH_ENABLED=true) and the request carries no credentials, an invalid or expired JWT, or an unknown API key.	`ErrorResponse` (application/json)
`403`	The caller lacks the permission the route needs (SEC-019 access gate, auth on: read, write or admin on the collections the request names), or a write meets read-only mode (MDDB_MODE=read or the protocol's own mode).	`ErrorResponse` (application/json)
`413`	The body is over MDDB_MAX_BODY_BYTES (32 MiB by default).	`ErrorResponse` (application/json)
`429`	The client is over the API rate limit (MDDB_RATE_LIMIT_ENABLED=true, MDDB_RATE_LIMIT_REQUESTS per MDDB_RATE_LIMIT_WINDOW seconds). A call that embeds can also be refused by the collection's daily embedding budget, with a QuotaExceeded body.	`RateLimitError` (application/json)

400 example (application/json)

{
  "error": "missing collection"
}

401 example (application/json)

{
  "error": "missing authentication"
}

403 example (application/json)

{
  "error": "forbidden"
}

413 example (application/json)

{
  "error": "request body too large"
}