Public API v1

The reference of the read-only dictionary API, generated from the OpenAPI document the server publishes — the same contract the SDKs are built from.

Read-only dictionary API under /api/v1 (contract version 1): no authentication, every answer in a { data, meta } envelope, errors as { statusCode, message, error: true }, X-API-Version on every response. The /api/compat/freedictionaryapi/v1 routes use freedictionaryapi.com objects, language lists and plain-text errors. The /api/compat/dictionaryapi routes use dictionaryapi.dev v1/v2 arrays and errors, with additive vocabBloom provenance. Compatibility lookups ending in /datasets wrap the responses from all installed datasets in { data, meta }; each group has dataset terms, status and response. Successful GET answers carry ETag, Last-Modified and Cache-Control. Documentation: https://vocab-bloom-hub.com/en/docs/api.

Base URLhttps://<instance>/api/v1

Every instance serves the API under its own origin; the examples below use a placeholder.

Contract

OpenAPI 3 document, served by every instance at /api/v1/openapi.json; the committed file

Read on

How the API surfaces work · Node.js SDK · Python SDK

Endpoints

GET/api/v1/meta

API and dataset versions, data license and counts of the served dictionary

Parameters

No parameters.

Responses

200OK — PublicMetaV1ResT
429Rate limit of the public prefix exceeded (PUBLIC_API_RATE_LIMIT); retry after the window — PublicApiErrorT

Example

curl 'https://your-instance.example/api/v1/meta'

const res = await fetch('https://your-instance.example/api/v1/meta');
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const answer = await res.json();

import requests

res = requests.get("https://your-instance.example/api/v1/meta")
res.raise_for_status()
answer = res.json()

import (
	"encoding/json"
	"log"
	"net/http"
)

resp, err := http.Get("https://your-instance.example/api/v1/meta")
if err != nil {
	log.Fatal(err)
}
defer resp.Body.Close()

var answer map[string]any
if err := json.NewDecoder(resp.Body).Decode(&answer); err != nil {
	log.Fatal(err)
}

$ch = curl_init('https://your-instance.example/api/v1/meta');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
]);
$answer = json_decode(curl_exec($ch), true);
curl_close($ch);

// cargo add reqwest --features blocking,json
// cargo add serde_json
use reqwest::blocking::Client;
use serde_json::Value;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let answer: Value = client
        .get(r#"https://your-instance.example/api/v1/meta"#)
        .send()?
        .error_for_status()?
        .json()?;
    println!("{answer}");
    Ok(())
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://your-instance.example/api/v1/meta"))
            .GET()
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

require 'net/http'
require 'json'

uri = URI('https://your-instance.example/api/v1/meta')
request = Net::HTTP::Get.new(uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end
response.value
answer = JSON.parse(response.body)
puts JSON.pretty_generate(answer)

import { VocabBloomClient } from '@vocab-bloom-hub/client';

const client = new VocabBloomClient({ baseUrl: 'https://your-instance.example' });
const { data } = await client.meta();
console.log(data.available_languages, data.counts.entries);

from vocab_bloom_hub import VocabBloomClient

client = VocabBloomClient("https://your-instance.example")
meta = client.meta()
print(meta.data.available_languages, meta.data.counts.entries)

Try it in the playground

GET/api/v1/openapi.json

The OpenAPI 3 document of the public API (this contract)

Parameters

No parameters.

Responses

200OK — object
429Rate limit of the public prefix exceeded (PUBLIC_API_RATE_LIMIT); retry after the window — PublicApiErrorT
503Not available: a selected dataset could not be read, the OpenAPI document is not ready, or the suggestion queue is full — PublicApiErrorT

Example

curl 'https://your-instance.example/api/v1/openapi.json'

const res = await fetch('https://your-instance.example/api/v1/openapi.json');
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const answer = await res.json();

import requests

res = requests.get("https://your-instance.example/api/v1/openapi.json")
res.raise_for_status()
answer = res.json()

import (
	"encoding/json"
	"log"
	"net/http"
)

resp, err := http.Get("https://your-instance.example/api/v1/openapi.json")
if err != nil {
	log.Fatal(err)
}
defer resp.Body.Close()

var answer map[string]any
if err := json.NewDecoder(resp.Body).Decode(&answer); err != nil {
	log.Fatal(err)
}

$ch = curl_init('https://your-instance.example/api/v1/openapi.json');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
]);
$answer = json_decode(curl_exec($ch), true);
curl_close($ch);

// cargo add reqwest --features blocking,json
// cargo add serde_json
use reqwest::blocking::Client;
use serde_json::Value;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let answer: Value = client
        .get(r#"https://your-instance.example/api/v1/openapi.json"#)
        .send()?
        .error_for_status()?
        .json()?;
    println!("{answer}");
    Ok(())
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://your-instance.example/api/v1/openapi.json"))
            .GET()
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

require 'net/http'
require 'json'

uri = URI('https://your-instance.example/api/v1/openapi.json')
request = Net::HTTP::Get.new(uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end
response.value
answer = JSON.parse(response.body)
puts JSON.pretty_generate(answer)

import { VocabBloomClient } from '@vocab-bloom-hub/client';

const client = new VocabBloomClient({ baseUrl: 'https://your-instance.example' });
const document = await client.openapi();
const info = document.info;
if (info && typeof info === 'object' && 'version' in info) {
  console.log(info.version);
}

from vocab_bloom_hub import VocabBloomClient

client = VocabBloomClient("https://your-instance.example")
document = client.openapi()
print(document["info"]["version"])

GET/api/v1/search

Search dictionary entries (flat list, no meanings)

Tiers in relevance order: exact, phrasal, starts-with, phrases, ends-with, contains. When none matches, a trigram similarity tier answers typos (`meta.fuzzy: true`, `similarity` on every item; Postgres instances only). A term shorter than 3 characters searches the exact and prefix tiers only (`meta.short_term: true`). Cacheable: the answer carries `ETag`, `Last-Modified` and `Cache-Control` like every public GET.

Parameters

Name	In	Type	Required	Description
`search`	query	`string`	yes	The term to search for
`type`	query	`string` `wordgrammar_patternphrase`	no	Restrict the answer to one entry type
`limit`	query	`integer`	no	default: 10
`dataset`	query	`string`	no	Public dataset name; omitted = the active dataset. Unknown or closed targets return 404, never a fallback.

Responses

200OK — PublicSearchV1ResT
400Invalid input: an unknown field, a value outside the allowed set, or a foreign cursor — PublicApiErrorT
404Nothing matches — PublicApiErrorT
429Rate limit of the public prefix exceeded (PUBLIC_API_RATE_LIMIT); retry after the window — PublicApiErrorT
503Not available: a selected dataset could not be read, the OpenAPI document is not ready, or the suggestion queue is full — PublicApiErrorT

Example

curl 'https://your-instance.example/api/v1/search'

const res = await fetch('https://your-instance.example/api/v1/search');
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const answer = await res.json();

import requests

res = requests.get("https://your-instance.example/api/v1/search")
res.raise_for_status()
answer = res.json()

import (
	"encoding/json"
	"log"
	"net/http"
)

resp, err := http.Get("https://your-instance.example/api/v1/search")
if err != nil {
	log.Fatal(err)
}
defer resp.Body.Close()

var answer map[string]any
if err := json.NewDecoder(resp.Body).Decode(&answer); err != nil {
	log.Fatal(err)
}

$ch = curl_init('https://your-instance.example/api/v1/search');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
]);
$answer = json_decode(curl_exec($ch), true);
curl_close($ch);

// cargo add reqwest --features blocking,json
// cargo add serde_json
use reqwest::blocking::Client;
use serde_json::Value;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let answer: Value = client
        .get(r#"https://your-instance.example/api/v1/search"#)
        .send()?
        .error_for_status()?
        .json()?;
    println!("{answer}");
    Ok(())
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://your-instance.example/api/v1/search"))
            .GET()
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

require 'net/http'
require 'json'

uri = URI('https://your-instance.example/api/v1/search')
request = Net::HTTP::Get.new(uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end
response.value
answer = JSON.parse(response.body)
puts JSON.pretty_generate(answer)

import { VocabBloomClient } from '@vocab-bloom-hub/client';

const client = new VocabBloomClient({ baseUrl: 'https://your-instance.example' });
const { data, meta } = await client.search({ search: 'run' });
console.log(meta.fuzzy, data[0]?.word);

from vocab_bloom_hub import VocabBloomClient

client = VocabBloomClient("https://your-instance.example")
answer = client.search("run")
print(answer.meta.fuzzy, answer.data[0].word if answer.data else None)

Try it in the playground

GET/api/v1/search/detailed

Search dictionary entries with pagination, meanings and translations

The detailed search: the same term and tiers, paged, with meanings and translations joined on request; the fields travel in the query string (`translation_languages` as a repeated key). Cacheable like every public GET.

Parameters

Name	In	Type	Required	Description
`search`	query	`string`	yes	The term to search for
`type`	query	`string` `wordgrammar_patternphrase`	no	Restrict the answer to one entry type
`limit`	query	`integer`	no	default: 10
`page`	query	`integer`	no	default: 1
`with_meanings`	query	`boolean`	no	Join the meanings (with translations, synonyms, antonyms) of every item default: false
`with_translations`	query	`boolean`	no	Join the short translations of every item default: false
`translation_languages`	query	`string[]` `ruesfrdeptzhar`	no	Keep only these translation languages (a repeated key); omit the key for all of them
`dataset`	query	`string`	no	Public dataset name; omitted = the active dataset. Unknown or closed targets return 404, never a fallback.

Responses

200OK — PublicSearchDetailedV1ResT
400Invalid input: an unknown field, a value outside the allowed set, or a foreign cursor — PublicApiErrorT
404Nothing matches — PublicApiErrorT
429Rate limit of the public prefix exceeded (PUBLIC_API_RATE_LIMIT); retry after the window — PublicApiErrorT
503Not available: a selected dataset could not be read, the OpenAPI document is not ready, or the suggestion queue is full — PublicApiErrorT

Example

curl 'https://your-instance.example/api/v1/search/detailed'

const res = await fetch('https://your-instance.example/api/v1/search/detailed');
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const answer = await res.json();

import requests

res = requests.get("https://your-instance.example/api/v1/search/detailed")
res.raise_for_status()
answer = res.json()

import (
	"encoding/json"
	"log"
	"net/http"
)

resp, err := http.Get("https://your-instance.example/api/v1/search/detailed")
if err != nil {
	log.Fatal(err)
}
defer resp.Body.Close()

var answer map[string]any
if err := json.NewDecoder(resp.Body).Decode(&answer); err != nil {
	log.Fatal(err)
}

$ch = curl_init('https://your-instance.example/api/v1/search/detailed');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
]);
$answer = json_decode(curl_exec($ch), true);
curl_close($ch);

// cargo add reqwest --features blocking,json
// cargo add serde_json
use reqwest::blocking::Client;
use serde_json::Value;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let answer: Value = client
        .get(r#"https://your-instance.example/api/v1/search/detailed"#)
        .send()?
        .error_for_status()?
        .json()?;
    println!("{answer}");
    Ok(())
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://your-instance.example/api/v1/search/detailed"))
            .GET()
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

require 'net/http'
require 'json'

uri = URI('https://your-instance.example/api/v1/search/detailed')
request = Net::HTTP::Get.new(uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end
response.value
answer = JSON.parse(response.body)
puts JSON.pretty_generate(answer)

import { VocabBloomClient } from '@vocab-bloom-hub/client';

const client = new VocabBloomClient({ baseUrl: 'https://your-instance.example' });
const { data } = await client.searchDetailed({ search: 'run', with_meanings: true });
const first = data[0];
console.log(first?.part_of_speech, first?.meanings?.[0]?.title);

from vocab_bloom_hub import VocabBloomClient

client = VocabBloomClient("https://your-instance.example")
answer = client.search_detailed("run", with_meanings=True)
first = answer.data[0] if answer.data else None
print(
    first.part_of_speech.value if first else None,
    first.meanings[0].title if first and first.meanings else None,
)

Try it in the playground

GET/api/v1/words/{word}

All entries of a headword: parts of speech, forms, meanings, translations, links

Parameters

Name	In	Type	Required	Description
`word`	path	`string`	yes	Headword spelling, case-insensitive (spaces URL-encoded for phrases). An inflected form resolves to its base entry

Responses

200OK — PublicHeadwordV1ResT
400Invalid input: an unknown field, a value outside the allowed set, or a foreign cursor — PublicApiErrorT
404Nothing matches — PublicApiErrorT
429Rate limit of the public prefix exceeded (PUBLIC_API_RATE_LIMIT); retry after the window — PublicApiErrorT

Example

curl 'https://your-instance.example/api/v1/words/run'

const res = await fetch('https://your-instance.example/api/v1/words/run');
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const answer = await res.json();

import requests

res = requests.get("https://your-instance.example/api/v1/words/run")
res.raise_for_status()
answer = res.json()

import (
	"encoding/json"
	"log"
	"net/http"
)

resp, err := http.Get("https://your-instance.example/api/v1/words/run")
if err != nil {
	log.Fatal(err)
}
defer resp.Body.Close()

var answer map[string]any
if err := json.NewDecoder(resp.Body).Decode(&answer); err != nil {
	log.Fatal(err)
}

$ch = curl_init('https://your-instance.example/api/v1/words/run');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
]);
$answer = json_decode(curl_exec($ch), true);
curl_close($ch);

// cargo add reqwest --features blocking,json
// cargo add serde_json
use reqwest::blocking::Client;
use serde_json::Value;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let answer: Value = client
        .get(r#"https://your-instance.example/api/v1/words/run"#)
        .send()?
        .error_for_status()?
        .json()?;
    println!("{answer}");
    Ok(())
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://your-instance.example/api/v1/words/run"))
            .GET()
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

require 'net/http'
require 'json'

uri = URI('https://your-instance.example/api/v1/words/run')
request = Net::HTTP::Get.new(uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end
response.value
answer = JSON.parse(response.body)
puts JSON.pretty_generate(answer)

import { VocabBloomClient } from '@vocab-bloom-hub/client';

const client = new VocabBloomClient({ baseUrl: 'https://your-instance.example' });
const { data } = await client.word('run');
console.log(data[0]?.meanings?.[0]?.definition);

from vocab_bloom_hub import VocabBloomClient

client = VocabBloomClient("https://your-instance.example")
answer = client.word("run")
first = answer.data[0] if answer.data else None
print(first.meanings[0].definition if first and first.meanings else None)

Try it in the playground

GET/api/v1/words/{word}/meanings

The meanings of a headword across its entries

Parameters

Name	In	Type	Required	Description
`word`	path	`string`	yes	Headword spelling, case-insensitive (spaces URL-encoded for phrases). An inflected form resolves to its base entry

Responses

200OK — PublicHeadwordMeaningsV1ResT
400Invalid input: an unknown field, a value outside the allowed set, or a foreign cursor — PublicApiErrorT
404Nothing matches — PublicApiErrorT
429Rate limit of the public prefix exceeded (PUBLIC_API_RATE_LIMIT); retry after the window — PublicApiErrorT

Example

curl 'https://your-instance.example/api/v1/words/run/meanings'

const res = await fetch('https://your-instance.example/api/v1/words/run/meanings');
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const answer = await res.json();

import requests

res = requests.get("https://your-instance.example/api/v1/words/run/meanings")
res.raise_for_status()
answer = res.json()

import (
	"encoding/json"
	"log"
	"net/http"
)

resp, err := http.Get("https://your-instance.example/api/v1/words/run/meanings")
if err != nil {
	log.Fatal(err)
}
defer resp.Body.Close()

var answer map[string]any
if err := json.NewDecoder(resp.Body).Decode(&answer); err != nil {
	log.Fatal(err)
}

$ch = curl_init('https://your-instance.example/api/v1/words/run/meanings');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
]);
$answer = json_decode(curl_exec($ch), true);
curl_close($ch);

// cargo add reqwest --features blocking,json
// cargo add serde_json
use reqwest::blocking::Client;
use serde_json::Value;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let answer: Value = client
        .get(r#"https://your-instance.example/api/v1/words/run/meanings"#)
        .send()?
        .error_for_status()?
        .json()?;
    println!("{answer}");
    Ok(())
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://your-instance.example/api/v1/words/run/meanings"))
            .GET()
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

require 'net/http'
require 'json'

uri = URI('https://your-instance.example/api/v1/words/run/meanings')
request = Net::HTTP::Get.new(uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end
response.value
answer = JSON.parse(response.body)
puts JSON.pretty_generate(answer)

import { VocabBloomClient } from '@vocab-bloom-hub/client';

const client = new VocabBloomClient({ baseUrl: 'https://your-instance.example' });
const { data } = await client.meanings('run');
console.log(data[0]?.definition);

from vocab_bloom_hub import VocabBloomClient

client = VocabBloomClient("https://your-instance.example")
answer = client.meanings("run")
print(answer.data[0].definition if answer.data else None)

Try it in the playground

GET/api/v1/words/{word}/translations

The short and per-meaning translations of a headword

Parameters

Name	In	Type	Required	Description
`word`	path	`string`	yes	Headword spelling, case-insensitive (spaces URL-encoded for phrases). An inflected form resolves to its base entry
`language`	query	`string[]` `ruesfrdeptzhar`	no	Translation languages; no value means all of them

Responses

200OK — PublicHeadwordTranslationsV1ResT
400Invalid input: an unknown field, a value outside the allowed set, or a foreign cursor — PublicApiErrorT
404Nothing matches — PublicApiErrorT
429Rate limit of the public prefix exceeded (PUBLIC_API_RATE_LIMIT); retry after the window — PublicApiErrorT

Example

curl 'https://your-instance.example/api/v1/words/run/translations'

const res = await fetch('https://your-instance.example/api/v1/words/run/translations');
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const answer = await res.json();

import requests

res = requests.get("https://your-instance.example/api/v1/words/run/translations")
res.raise_for_status()
answer = res.json()

import (
	"encoding/json"
	"log"
	"net/http"
)

resp, err := http.Get("https://your-instance.example/api/v1/words/run/translations")
if err != nil {
	log.Fatal(err)
}
defer resp.Body.Close()

var answer map[string]any
if err := json.NewDecoder(resp.Body).Decode(&answer); err != nil {
	log.Fatal(err)
}

$ch = curl_init('https://your-instance.example/api/v1/words/run/translations');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
]);
$answer = json_decode(curl_exec($ch), true);
curl_close($ch);

// cargo add reqwest --features blocking,json
// cargo add serde_json
use reqwest::blocking::Client;
use serde_json::Value;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let answer: Value = client
        .get(r#"https://your-instance.example/api/v1/words/run/translations"#)
        .send()?
        .error_for_status()?
        .json()?;
    println!("{answer}");
    Ok(())
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://your-instance.example/api/v1/words/run/translations"))
            .GET()
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

require 'net/http'
require 'json'

uri = URI('https://your-instance.example/api/v1/words/run/translations')
request = Net::HTTP::Get.new(uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end
response.value
answer = JSON.parse(response.body)
puts JSON.pretty_generate(answer)

import { VocabBloomClient } from '@vocab-bloom-hub/client';

const client = new VocabBloomClient({ baseUrl: 'https://your-instance.example' });
const { data } = await client.translations('run');
const first = data.meaning_translations[0];
console.log(first?.title, first?.language);

from vocab_bloom_hub import VocabBloomClient

client = VocabBloomClient("https://your-instance.example")
answer = client.translations("run")
first = answer.data.meaning_translations[0] if answer.data.meaning_translations else None
print(first.title if first else None, first.language.value if first else None)

Try it in the playground

GET/api/v1/words/{word}/forms

The inflected forms of a headword across its entries

Parameters

Name	In	Type	Required	Description
`word`	path	`string`	yes	Headword spelling, case-insensitive (spaces URL-encoded for phrases). An inflected form resolves to its base entry

Responses

200OK — PublicHeadwordFormsV1ResT
400Invalid input: an unknown field, a value outside the allowed set, or a foreign cursor — PublicApiErrorT
404Nothing matches — PublicApiErrorT
429Rate limit of the public prefix exceeded (PUBLIC_API_RATE_LIMIT); retry after the window — PublicApiErrorT

Example

curl 'https://your-instance.example/api/v1/words/run/forms'

const res = await fetch('https://your-instance.example/api/v1/words/run/forms');
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const answer = await res.json();

import requests

res = requests.get("https://your-instance.example/api/v1/words/run/forms")
res.raise_for_status()
answer = res.json()

import (
	"encoding/json"
	"log"
	"net/http"
)

resp, err := http.Get("https://your-instance.example/api/v1/words/run/forms")
if err != nil {
	log.Fatal(err)
}
defer resp.Body.Close()

var answer map[string]any
if err := json.NewDecoder(resp.Body).Decode(&answer); err != nil {
	log.Fatal(err)
}

$ch = curl_init('https://your-instance.example/api/v1/words/run/forms');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
]);
$answer = json_decode(curl_exec($ch), true);
curl_close($ch);

// cargo add reqwest --features blocking,json
// cargo add serde_json
use reqwest::blocking::Client;
use serde_json::Value;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let answer: Value = client
        .get(r#"https://your-instance.example/api/v1/words/run/forms"#)
        .send()?
        .error_for_status()?
        .json()?;
    println!("{answer}");
    Ok(())
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://your-instance.example/api/v1/words/run/forms"))
            .GET()
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

require 'net/http'
require 'json'

uri = URI('https://your-instance.example/api/v1/words/run/forms')
request = Net::HTTP::Get.new(uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end
response.value
answer = JSON.parse(response.body)
puts JSON.pretty_generate(answer)

import { VocabBloomClient } from '@vocab-bloom-hub/client';

const client = new VocabBloomClient({ baseUrl: 'https://your-instance.example' });
const { data } = await client.forms('run');
for (const form of data) {
  console.log(form.word, form.form_of_word);
}

from vocab_bloom_hub import VocabBloomClient

client = VocabBloomClient("https://your-instance.example")
answer = client.forms("run")
for form in answer.data:
    print(form.word, form.form_of_word.value)

Try it in the playground

GET/api/v1/words/{word}/synonyms

The synonyms of a headword, per meaning

One item per linked headword and meaning; each names its `meaning_id`, `word_id` and `part_of_speech`.

Parameters

Name	In	Type	Required	Description
`word`	path	`string`	yes	Headword spelling, case-insensitive (spaces URL-encoded for phrases). An inflected form resolves to its base entry

Responses

200OK — PublicHeadwordLinksV1ResT
400Invalid input: an unknown field, a value outside the allowed set, or a foreign cursor — PublicApiErrorT
404Nothing matches — PublicApiErrorT
429Rate limit of the public prefix exceeded (PUBLIC_API_RATE_LIMIT); retry after the window — PublicApiErrorT

Example

curl 'https://your-instance.example/api/v1/words/run/synonyms'

const res = await fetch('https://your-instance.example/api/v1/words/run/synonyms');
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const answer = await res.json();

import requests

res = requests.get("https://your-instance.example/api/v1/words/run/synonyms")
res.raise_for_status()
answer = res.json()

import (
	"encoding/json"
	"log"
	"net/http"
)

resp, err := http.Get("https://your-instance.example/api/v1/words/run/synonyms")
if err != nil {
	log.Fatal(err)
}
defer resp.Body.Close()

var answer map[string]any
if err := json.NewDecoder(resp.Body).Decode(&answer); err != nil {
	log.Fatal(err)
}

$ch = curl_init('https://your-instance.example/api/v1/words/run/synonyms');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
]);
$answer = json_decode(curl_exec($ch), true);
curl_close($ch);

// cargo add reqwest --features blocking,json
// cargo add serde_json
use reqwest::blocking::Client;
use serde_json::Value;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let answer: Value = client
        .get(r#"https://your-instance.example/api/v1/words/run/synonyms"#)
        .send()?
        .error_for_status()?
        .json()?;
    println!("{answer}");
    Ok(())
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://your-instance.example/api/v1/words/run/synonyms"))
            .GET()
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

require 'net/http'
require 'json'

uri = URI('https://your-instance.example/api/v1/words/run/synonyms')
request = Net::HTTP::Get.new(uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end
response.value
answer = JSON.parse(response.body)
puts JSON.pretty_generate(answer)

import { VocabBloomClient } from '@vocab-bloom-hub/client';

const client = new VocabBloomClient({ baseUrl: 'https://your-instance.example' });
const { data } = await client.synonyms('run');
console.log(data.map((link) => link.word));

from vocab_bloom_hub import VocabBloomClient

client = VocabBloomClient("https://your-instance.example")
answer = client.synonyms("run")
print([link.word for link in answer.data])

Try it in the playground

GET/api/v1/words/{word}/antonyms

The antonyms of a headword, per meaning

One item per linked headword and meaning; each names its `meaning_id`, `word_id` and `part_of_speech`.

Parameters

Name	In	Type	Required	Description
`word`	path	`string`	yes	Headword spelling, case-insensitive (spaces URL-encoded for phrases). An inflected form resolves to its base entry

Responses

200OK — PublicHeadwordLinksV1ResT
400Invalid input: an unknown field, a value outside the allowed set, or a foreign cursor — PublicApiErrorT
404Nothing matches — PublicApiErrorT
429Rate limit of the public prefix exceeded (PUBLIC_API_RATE_LIMIT); retry after the window — PublicApiErrorT

Example

curl 'https://your-instance.example/api/v1/words/run/antonyms'

const res = await fetch('https://your-instance.example/api/v1/words/run/antonyms');
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const answer = await res.json();

import requests

res = requests.get("https://your-instance.example/api/v1/words/run/antonyms")
res.raise_for_status()
answer = res.json()

import (
	"encoding/json"
	"log"
	"net/http"
)

resp, err := http.Get("https://your-instance.example/api/v1/words/run/antonyms")
if err != nil {
	log.Fatal(err)
}
defer resp.Body.Close()

var answer map[string]any
if err := json.NewDecoder(resp.Body).Decode(&answer); err != nil {
	log.Fatal(err)
}

$ch = curl_init('https://your-instance.example/api/v1/words/run/antonyms');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
]);
$answer = json_decode(curl_exec($ch), true);
curl_close($ch);

// cargo add reqwest --features blocking,json
// cargo add serde_json
use reqwest::blocking::Client;
use serde_json::Value;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let answer: Value = client
        .get(r#"https://your-instance.example/api/v1/words/run/antonyms"#)
        .send()?
        .error_for_status()?
        .json()?;
    println!("{answer}");
    Ok(())
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://your-instance.example/api/v1/words/run/antonyms"))
            .GET()
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

require 'net/http'
require 'json'

uri = URI('https://your-instance.example/api/v1/words/run/antonyms')
request = Net::HTTP::Get.new(uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end
response.value
answer = JSON.parse(response.body)
puts JSON.pretty_generate(answer)

import { VocabBloomClient } from '@vocab-bloom-hub/client';

const client = new VocabBloomClient({ baseUrl: 'https://your-instance.example' });
const { data } = await client.antonyms('run');
console.log(data.map((link) => link.word));

from vocab_bloom_hub import VocabBloomClient

client = VocabBloomClient("https://your-instance.example")
answer = client.antonyms("run")
print([link.word for link in answer.data])

Try it in the playground

GET/api/v1/words/{word}/history

What was changed or added on the instance in the entries of a headword

The edits that still show in what is served, the latest first, with the values before and after: the entries of such a headword carry `modified: true`. Empty for a headword served as its source has it.

Parameters

Name	In	Type	Required	Description
`word`	path	`string`	yes	Headword spelling, case-insensitive (spaces URL-encoded for phrases). An inflected form resolves to its base entry

Responses

200OK — PublicHeadwordHistoryV1ResT
400Invalid input: an unknown field, a value outside the allowed set, or a foreign cursor — PublicApiErrorT
404Nothing matches — PublicApiErrorT
429Rate limit of the public prefix exceeded (PUBLIC_API_RATE_LIMIT); retry after the window — PublicApiErrorT

Example

curl 'https://your-instance.example/api/v1/words/run/history'

const res = await fetch('https://your-instance.example/api/v1/words/run/history');
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const answer = await res.json();

import requests

res = requests.get("https://your-instance.example/api/v1/words/run/history")
res.raise_for_status()
answer = res.json()

import (
	"encoding/json"
	"log"
	"net/http"
)

resp, err := http.Get("https://your-instance.example/api/v1/words/run/history")
if err != nil {
	log.Fatal(err)
}
defer resp.Body.Close()

var answer map[string]any
if err := json.NewDecoder(resp.Body).Decode(&answer); err != nil {
	log.Fatal(err)
}

$ch = curl_init('https://your-instance.example/api/v1/words/run/history');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
]);
$answer = json_decode(curl_exec($ch), true);
curl_close($ch);

// cargo add reqwest --features blocking,json
// cargo add serde_json
use reqwest::blocking::Client;
use serde_json::Value;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let answer: Value = client
        .get(r#"https://your-instance.example/api/v1/words/run/history"#)
        .send()?
        .error_for_status()?
        .json()?;
    println!("{answer}");
    Ok(())
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://your-instance.example/api/v1/words/run/history"))
            .GET()
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

require 'net/http'
require 'json'

uri = URI('https://your-instance.example/api/v1/words/run/history')
request = Net::HTTP::Get.new(uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end
response.value
answer = JSON.parse(response.body)
puts JSON.pretty_generate(answer)

Try it in the playground

GET/api/v1/words/{word}/datasets

A headword as every open dataset of the instance has it, grouped by dataset

One group per open dataset, never merged: the terms of the dataset (`license`, `attribution`, `license_text`, …) and the entries `GET /words/{word}` would answer if that dataset were the served one. The spelling is matched inside each dataset, so a group has its own `word` and `variants`; a dataset without the headword answers an empty `entries`, and the request fails with 404 when no dataset holds it. Entries taken from several groups are bound by the terms of each. One request against the rate limit.

Parameters

Name	In	Type	Required	Description
`word`	path	`string`	yes	Headword spelling, case-insensitive (spaces URL-encoded for phrases). An inflected form resolves to its base entry

Responses

200OK — PublicWordDatasetsV1ResT
400Invalid input: an unknown field, a value outside the allowed set, or a foreign cursor — PublicApiErrorT
404Nothing matches — PublicApiErrorT
429Rate limit of the public prefix exceeded (PUBLIC_API_RATE_LIMIT); retry after the window — PublicApiErrorT

Example

curl 'https://your-instance.example/api/v1/words/run/datasets'

const res = await fetch('https://your-instance.example/api/v1/words/run/datasets');
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const answer = await res.json();

import requests

res = requests.get("https://your-instance.example/api/v1/words/run/datasets")
res.raise_for_status()
answer = res.json()

import (
	"encoding/json"
	"log"
	"net/http"
)

resp, err := http.Get("https://your-instance.example/api/v1/words/run/datasets")
if err != nil {
	log.Fatal(err)
}
defer resp.Body.Close()

var answer map[string]any
if err := json.NewDecoder(resp.Body).Decode(&answer); err != nil {
	log.Fatal(err)
}

$ch = curl_init('https://your-instance.example/api/v1/words/run/datasets');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
]);
$answer = json_decode(curl_exec($ch), true);
curl_close($ch);

// cargo add reqwest --features blocking,json
// cargo add serde_json
use reqwest::blocking::Client;
use serde_json::Value;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let answer: Value = client
        .get(r#"https://your-instance.example/api/v1/words/run/datasets"#)
        .send()?
        .error_for_status()?
        .json()?;
    println!("{answer}");
    Ok(())
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://your-instance.example/api/v1/words/run/datasets"))
            .GET()
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

require 'net/http'
require 'json'

uri = URI('https://your-instance.example/api/v1/words/run/datasets')
request = Net::HTTP::Get.new(uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end
response.value
answer = JSON.parse(response.body)
puts JSON.pretty_generate(answer)

import { VocabBloomClient } from '@vocab-bloom-hub/client';

const client = new VocabBloomClient({ baseUrl: 'https://your-instance.example' });
const { data, meta } = await client.wordDatasets('run');
console.log(`${meta.found} of ${meta.datasets} datasets hold the word`);
for (const group of data) {
  // the entries of a group are used under the terms of that group
  console.log(group.dataset, group.license, group.attribution, group.entries.length);
}

from vocab_bloom_hub import VocabBloomClient

client = VocabBloomClient("https://your-instance.example")
answer = client.word_datasets("run")
print(f"{answer.meta.found} of {answer.meta.datasets} datasets hold the word")
for group in answer.data:
    # the entries of a group are used under the terms of that group
    print(group.dataset, group.license, group.attribution, len(group.entries))

Try it in the playground

GET/api/v1/words/{word}/datasets/{dataset}/history

What was changed or added on the instance in the entries of a headword, in one dataset

The answer of `GET /words/{word}/history` for a dataset named by its `dataset`: the edits behind `modified: true` of the entries of that group. 404 for a closed dataset or a dataset the instance does not hold.

Parameters

Name	In	Type	Required	Description
`word`	path	`string`	yes	Headword spelling, case-insensitive (spaces URL-encoded for phrases). An inflected form resolves to its base entry
`dataset`	path	`string`	yes	The name of a dataset of the instance, as `dataset` of a group of `GET /words/{word}/datasets` says it

Responses

200OK — PublicHeadwordHistoryV1ResT
400Invalid input: an unknown field, a value outside the allowed set, or a foreign cursor — PublicApiErrorT
404Nothing matches — PublicApiErrorT
429Rate limit of the public prefix exceeded (PUBLIC_API_RATE_LIMIT); retry after the window — PublicApiErrorT

Example

curl 'https://your-instance.example/api/v1/words/run/datasets/default/history'

const res = await fetch('https://your-instance.example/api/v1/words/run/datasets/default/history');
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const answer = await res.json();

import requests

res = requests.get("https://your-instance.example/api/v1/words/run/datasets/default/history")
res.raise_for_status()
answer = res.json()

import (
	"encoding/json"
	"log"
	"net/http"
)

resp, err := http.Get("https://your-instance.example/api/v1/words/run/datasets/default/history")
if err != nil {
	log.Fatal(err)
}
defer resp.Body.Close()

var answer map[string]any
if err := json.NewDecoder(resp.Body).Decode(&answer); err != nil {
	log.Fatal(err)
}

$ch = curl_init('https://your-instance.example/api/v1/words/run/datasets/default/history');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
]);
$answer = json_decode(curl_exec($ch), true);
curl_close($ch);

// cargo add reqwest --features blocking,json
// cargo add serde_json
use reqwest::blocking::Client;
use serde_json::Value;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let answer: Value = client
        .get(r#"https://your-instance.example/api/v1/words/run/datasets/default/history"#)
        .send()?
        .error_for_status()?
        .json()?;
    println!("{answer}");
    Ok(())
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://your-instance.example/api/v1/words/run/datasets/default/history"))
            .GET()
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

require 'net/http'
require 'json'

uri = URI('https://your-instance.example/api/v1/words/run/datasets/default/history')
request = Net::HTTP::Get.new(uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end
response.value
answer = JSON.parse(response.body)
puts JSON.pretty_generate(answer)

import { VocabBloomClient } from '@vocab-bloom-hub/client';

const client = new VocabBloomClient({ baseUrl: 'https://your-instance.example' });
const { data } = await client.datasetHistory('run', 'default');
for (const change of data) {
  console.log(change.created_at, change.entity, change.action, change.diff);
}

from vocab_bloom_hub import VocabBloomClient

client = VocabBloomClient("https://your-instance.example")
history = client.dataset_history("run", "default")
for change in history.data:
    print(change.created_at, change.entity.value, change.action.value, change.diff)

Try it in the playground

GET/api/v1/words/id/{id}

One dictionary entry by its numeric id

Parameters

Name	In	Type	Required	Description
`id`	path	`number`	yes

Responses

200OK — PublicWordV1ResT
400Invalid input: an unknown field, a value outside the allowed set, or a foreign cursor — PublicApiErrorT
404Nothing matches — PublicApiErrorT
429Rate limit of the public prefix exceeded (PUBLIC_API_RATE_LIMIT); retry after the window — PublicApiErrorT

Example

curl 'https://your-instance.example/api/v1/words/id/1'

const res = await fetch('https://your-instance.example/api/v1/words/id/1');
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const answer = await res.json();

import requests

res = requests.get("https://your-instance.example/api/v1/words/id/1")
res.raise_for_status()
answer = res.json()

import (
	"encoding/json"
	"log"
	"net/http"
)

resp, err := http.Get("https://your-instance.example/api/v1/words/id/1")
if err != nil {
	log.Fatal(err)
}
defer resp.Body.Close()

var answer map[string]any
if err := json.NewDecoder(resp.Body).Decode(&answer); err != nil {
	log.Fatal(err)
}

$ch = curl_init('https://your-instance.example/api/v1/words/id/1');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
]);
$answer = json_decode(curl_exec($ch), true);
curl_close($ch);

// cargo add reqwest --features blocking,json
// cargo add serde_json
use reqwest::blocking::Client;
use serde_json::Value;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let answer: Value = client
        .get(r#"https://your-instance.example/api/v1/words/id/1"#)
        .send()?
        .error_for_status()?
        .json()?;
    println!("{answer}");
    Ok(())
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://your-instance.example/api/v1/words/id/1"))
            .GET()
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

require 'net/http'
require 'json'

uri = URI('https://your-instance.example/api/v1/words/id/1')
request = Net::HTTP::Get.new(uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end
response.value
answer = JSON.parse(response.body)
puts JSON.pretty_generate(answer)

import { VocabBloomClient } from '@vocab-bloom-hub/client';

const client = new VocabBloomClient({ baseUrl: 'https://your-instance.example' });
const { data } = await client.wordById(1);
console.log(data.word, data.part_of_speech);

from vocab_bloom_hub import VocabBloomClient

client = VocabBloomClient("https://your-instance.example")
answer = client.word_by_id(1)
print(answer.data.word, answer.data.part_of_speech.value)

Try it in the playground

GET/api/v1/words

List dictionary entries by filters, cursor-paged and ordered by (word, id)

Every enum filter accepts a repeated key; values of one filter are OR-ed, filters are AND-ed. `search` keeps the headwords starting with the prefix (an autocomplete or an A–Z browser: cacheable, unlike the search). Pass `meta.next_cursor` back as `cursor` to read the next page.

Parameters

Name	In	Type	Required	Description
`search`	query	`string`	no	Headword prefix, case-insensitive (`ru` lists run, rung, runner, …)
`is_obsolete`	query	`boolean`	no	true: obsolete entries only, false: current ones only
`part_of_speech`	query	`string[]` `nounverbmodal_verbadjectiveadverbpronounnumeralnumeral_fractionaldeterminerinterjectionarticleprepositionconjunctionletterphrasegrammar_pattern`	no
`word_level`	query	`string[]` `A1A2B1B2C1C2`	no
`language_register`	query	`string[]` `formalinformalslang`	no
`category`	query	`string[]` `scientifictechnicalmedicallegalbusinessITartpoliticalsportculinary`	no	Words tagged with any of the categories
`area_variant`	query	`string[]` `commonbritishamericanaustralian`	no
`form_of_word`	query	`string[]` `base_formplural_formpossessive_singular_formpossessive_plural_formpast_simplepast_participlepresent_participlethird_person_singularcomparative_formsuperlative_formobjectpossessive_adjectivepossessive_pronounreflexiveordinalmultiplicative`	no	Defaults to base forms only default: ["base_form"]
`cursor`	query	`string`	no	The `meta.next_cursor` of the previous page; omit for the first page
`limit`	query	`integer`	no	default: 20
`with_meanings`	query	`boolean`	no	Join the meanings of every word default: false
`with_translations`	query	`boolean`	no	Join the short translations of every word default: false

Responses

200OK — PublicWordsV1ResT
400Invalid input: an unknown field, a value outside the allowed set, or a foreign cursor — PublicApiErrorT
429Rate limit of the public prefix exceeded (PUBLIC_API_RATE_LIMIT); retry after the window — PublicApiErrorT

Example

curl 'https://your-instance.example/api/v1/words'

const res = await fetch('https://your-instance.example/api/v1/words');
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const answer = await res.json();

import requests

res = requests.get("https://your-instance.example/api/v1/words")
res.raise_for_status()
answer = res.json()

import (
	"encoding/json"
	"log"
	"net/http"
)

resp, err := http.Get("https://your-instance.example/api/v1/words")
if err != nil {
	log.Fatal(err)
}
defer resp.Body.Close()

var answer map[string]any
if err := json.NewDecoder(resp.Body).Decode(&answer); err != nil {
	log.Fatal(err)
}

$ch = curl_init('https://your-instance.example/api/v1/words');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
]);
$answer = json_decode(curl_exec($ch), true);
curl_close($ch);

// cargo add reqwest --features blocking,json
// cargo add serde_json
use reqwest::blocking::Client;
use serde_json::Value;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let answer: Value = client
        .get(r#"https://your-instance.example/api/v1/words"#)
        .send()?
        .error_for_status()?
        .json()?;
    println!("{answer}");
    Ok(())
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://your-instance.example/api/v1/words"))
            .GET()
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

require 'net/http'
require 'json'

uri = URI('https://your-instance.example/api/v1/words')
request = Net::HTTP::Get.new(uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end
response.value
answer = JSON.parse(response.body)
puts JSON.pretty_generate(answer)

import { VocabBloomClient } from '@vocab-bloom-hub/client';

const client = new VocabBloomClient({ baseUrl: 'https://your-instance.example' });
const { data } = await client.words({ word_level: ['A1'] });
console.log(data.slice(0, 5).map((entry) => entry.word));

// To read every matching entry across all pages:
// for await (const entry of client.iterateWords({ word_level: ['A1'] })) {
//   console.log(entry.word);
// }

from vocab_bloom_hub import VocabBloomClient

client = VocabBloomClient("https://your-instance.example")
answer = client.words(word_level=["A1"])
print([entry.word for entry in answer.data[:5]])

# To read every matching entry across all pages:
# for entry in client.iter_words(word_level=["A1"]):
#     print(entry.word)

Try it in the playground

GET/api/v1/random

A random dictionary entry matching the filters (base forms unless form_of_word is given)

Parameters

Name	In	Type	Required	Description
`search`	query	`string`	no	Headword prefix, case-insensitive (`ru` lists run, rung, runner, …)
`is_obsolete`	query	`boolean`	no	true: obsolete entries only, false: current ones only
`part_of_speech`	query	`string[]` `nounverbmodal_verbadjectiveadverbpronounnumeralnumeral_fractionaldeterminerinterjectionarticleprepositionconjunctionletterphrasegrammar_pattern`	no
`word_level`	query	`string[]` `A1A2B1B2C1C2`	no
`language_register`	query	`string[]` `formalinformalslang`	no
`category`	query	`string[]` `scientifictechnicalmedicallegalbusinessITartpoliticalsportculinary`	no	Words tagged with any of the categories
`area_variant`	query	`string[]` `commonbritishamericanaustralian`	no
`form_of_word`	query	`string[]` `base_formplural_formpossessive_singular_formpossessive_plural_formpast_simplepast_participlepresent_participlethird_person_singularcomparative_formsuperlative_formobjectpossessive_adjectivepossessive_pronounreflexiveordinalmultiplicative`	no	Defaults to base forms only default: ["base_form"]

Responses

200OK — PublicWordV1ResT
400Invalid input: an unknown field, a value outside the allowed set, or a foreign cursor — PublicApiErrorT
404Nothing matches — PublicApiErrorT
429Rate limit of the public prefix exceeded (PUBLIC_API_RATE_LIMIT); retry after the window — PublicApiErrorT

Example

curl 'https://your-instance.example/api/v1/random'

const res = await fetch('https://your-instance.example/api/v1/random');
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const answer = await res.json();

import requests

res = requests.get("https://your-instance.example/api/v1/random")
res.raise_for_status()
answer = res.json()

import (
	"encoding/json"
	"log"
	"net/http"
)

resp, err := http.Get("https://your-instance.example/api/v1/random")
if err != nil {
	log.Fatal(err)
}
defer resp.Body.Close()

var answer map[string]any
if err := json.NewDecoder(resp.Body).Decode(&answer); err != nil {
	log.Fatal(err)
}

$ch = curl_init('https://your-instance.example/api/v1/random');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
]);
$answer = json_decode(curl_exec($ch), true);
curl_close($ch);

// cargo add reqwest --features blocking,json
// cargo add serde_json
use reqwest::blocking::Client;
use serde_json::Value;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let answer: Value = client
        .get(r#"https://your-instance.example/api/v1/random"#)
        .send()?
        .error_for_status()?
        .json()?;
    println!("{answer}");
    Ok(())
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://your-instance.example/api/v1/random"))
            .GET()
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

require 'net/http'
require 'json'

uri = URI('https://your-instance.example/api/v1/random')
request = Net::HTTP::Get.new(uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end
response.value
answer = JSON.parse(response.body)
puts JSON.pretty_generate(answer)

import { VocabBloomClient } from '@vocab-bloom-hub/client';

const client = new VocabBloomClient({ baseUrl: 'https://your-instance.example' });
const { data } = await client.random();
console.log(data.word);

from vocab_bloom_hub import VocabBloomClient

client = VocabBloomClient("https://your-instance.example")
answer = client.random()
print(answer.data.word)

Try it in the playground

GET/api/v1/search/semantic/status

Whether the instance enables semantic search

Reflects only SEMANTIC_SEARCH_ENABLED. Performs no inference and does not promise model/vector availability. Never cached.

Parameters

No parameters.

Responses

200OK — PublicSemanticStatusV1ResT
429Rate limit of the public prefix exceeded (PUBLIC_API_RATE_LIMIT); retry after the window — PublicApiErrorT

Example

curl 'https://your-instance.example/api/v1/search/semantic/status'

const res = await fetch('https://your-instance.example/api/v1/search/semantic/status');
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const answer = await res.json();

import requests

res = requests.get("https://your-instance.example/api/v1/search/semantic/status")
res.raise_for_status()
answer = res.json()

import (
	"encoding/json"
	"log"
	"net/http"
)

resp, err := http.Get("https://your-instance.example/api/v1/search/semantic/status")
if err != nil {
	log.Fatal(err)
}
defer resp.Body.Close()

var answer map[string]any
if err := json.NewDecoder(resp.Body).Decode(&answer); err != nil {
	log.Fatal(err)
}

$ch = curl_init('https://your-instance.example/api/v1/search/semantic/status');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
]);
$answer = json_decode(curl_exec($ch), true);
curl_close($ch);

// cargo add reqwest --features blocking,json
// cargo add serde_json
use reqwest::blocking::Client;
use serde_json::Value;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let answer: Value = client
        .get(r#"https://your-instance.example/api/v1/search/semantic/status"#)
        .send()?
        .error_for_status()?
        .json()?;
    println!("{answer}");
    Ok(())
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://your-instance.example/api/v1/search/semantic/status"))
            .GET()
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

require 'net/http'
require 'json'

uri = URI('https://your-instance.example/api/v1/search/semantic/status')
request = Net::HTTP::Get.new(uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end
response.value
answer = JSON.parse(response.body)
puts JSON.pretty_generate(answer)

import { VocabBloomClient } from '@vocab-bloom-hub/client';

const client = new VocabBloomClient({ baseUrl: 'https://your-instance.example' });
const { data } = await client.semanticStatus();
console.log(data.enabled);

from vocab_bloom_hub import VocabBloomClient

client = VocabBloomClient("https://your-instance.example")
answer = client.semantic_status()
print(answer.data.enabled)

Try it in the playground

GET/api/v1/search/semantic

Find existing meanings from a description

Separate from spelling search; no lexical fallback. Requires SEMANTIC_SEARCH_ENABLED, PostgreSQL/pgvector, imported current vectors and a matching Ollama model. Disabled = 404 semantic_search_disabled; missing infrastructure, busy service or incompatible model = 503. Returns up to 20 meanings, ordered by cosine similarity then meaning ID. Scores are not confidence probabilities; no calibrated no-answer threshold. No pagination or cross-dataset ranking. Uses the shared public rate budget. Responses are no-store.

Parameters

Name	In	Type	Required	Description
`query`	query	`string`	yes	A description of the intended meaning, in English or another language supported by the model.
`dataset`	query	`string`	no	One public dataset; omitted = active dataset. Closed/unknown targets return 404.
`limit`	query	`integer`	no	default: 10

Responses

200OK — PublicSemanticSearchV1ResT
400Invalid input: an unknown field, a value outside the allowed set, or a foreign cursor — PublicApiErrorT
404Nothing matches — PublicApiErrorT
429Rate limit of the public prefix exceeded (PUBLIC_API_RATE_LIMIT); retry after the window — PublicApiErrorT
503Not available: a selected dataset could not be read, the OpenAPI document is not ready, or the suggestion queue is full — PublicApiErrorT

Example

curl 'https://your-instance.example/api/v1/search/semantic'

const res = await fetch('https://your-instance.example/api/v1/search/semantic');
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const answer = await res.json();

import requests

res = requests.get("https://your-instance.example/api/v1/search/semantic")
res.raise_for_status()
answer = res.json()

import (
	"encoding/json"
	"log"
	"net/http"
)

resp, err := http.Get("https://your-instance.example/api/v1/search/semantic")
if err != nil {
	log.Fatal(err)
}
defer resp.Body.Close()

var answer map[string]any
if err := json.NewDecoder(resp.Body).Decode(&answer); err != nil {
	log.Fatal(err)
}

$ch = curl_init('https://your-instance.example/api/v1/search/semantic');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
]);
$answer = json_decode(curl_exec($ch), true);
curl_close($ch);

// cargo add reqwest --features blocking,json
// cargo add serde_json
use reqwest::blocking::Client;
use serde_json::Value;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let answer: Value = client
        .get(r#"https://your-instance.example/api/v1/search/semantic"#)
        .send()?
        .error_for_status()?
        .json()?;
    println!("{answer}");
    Ok(())
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://your-instance.example/api/v1/search/semantic"))
            .GET()
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

require 'net/http'
require 'json'

uri = URI('https://your-instance.example/api/v1/search/semantic')
request = Net::HTTP::Get.new(uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end
response.value
answer = JSON.parse(response.body)
puts JSON.pretty_generate(answer)

import { VocabBloomClient } from '@vocab-bloom-hub/client';

const client = new VocabBloomClient({ baseUrl: 'https://your-instance.example' });
const { data } = await client.searchSemantic({ query: 'A scientist who studies birds' });
console.log(data[0]?.word.word, data[0]?.meaning.definition);

from vocab_bloom_hub import VocabBloomClient

client = VocabBloomClient("https://your-instance.example")
answer = client.search_semantic("A scientist who studies birds")
print(answer.data[0].meaning.definition if answer.data else None)

Try it in the playground

GET/api/compat/dictionaryapi/v2/entries/{language}/{word}/datasets

dictionaryapi.dev v2 responses from every open dataset

One group per installed dataset with its terms, status and response in the adapter format. Missing words have status 404 and the adapter error in response. The outer request returns 200 even when no dataset matches. English only; the usual headword and inflection rules apply in each dataset. No query parameters. Does not activate any dataset. One public rate-limit unit; cached across all datasets.

Parameters

Name	In	Type	Required	Description
`language`	path	`string` `enen_USen_GB`	yes
`word`	path	`string`	yes	Headword spelling, case-insensitive (spaces URL-encoded for phrases). An inflected form resolves to its base entry

Responses

200OK — DictionaryApiV2DatasetsResT
400Invalid input: an unknown field, a value outside the allowed set, or a foreign cursor — DictionaryApiErrorT
404Nothing matches — DictionaryApiErrorT
429Rate limit of the public prefix exceeded (PUBLIC_API_RATE_LIMIT); retry after the window — DictionaryApiErrorT

Example

curl 'https://your-instance.example/api/compat/dictionaryapi/v2/entries/en/run/datasets'

const res = await fetch('https://your-instance.example/api/compat/dictionaryapi/v2/entries/en/run/datasets');
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const answer = await res.json();

import requests

res = requests.get("https://your-instance.example/api/compat/dictionaryapi/v2/entries/en/run/datasets")
res.raise_for_status()
answer = res.json()

import (
	"encoding/json"
	"log"
	"net/http"
)

resp, err := http.Get("https://your-instance.example/api/compat/dictionaryapi/v2/entries/en/run/datasets")
if err != nil {
	log.Fatal(err)
}
defer resp.Body.Close()

var answer map[string]any
if err := json.NewDecoder(resp.Body).Decode(&answer); err != nil {
	log.Fatal(err)
}

$ch = curl_init('https://your-instance.example/api/compat/dictionaryapi/v2/entries/en/run/datasets');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
]);
$answer = json_decode(curl_exec($ch), true);
curl_close($ch);

// cargo add reqwest --features blocking,json
// cargo add serde_json
use reqwest::blocking::Client;
use serde_json::Value;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let answer: Value = client
        .get(r#"https://your-instance.example/api/compat/dictionaryapi/v2/entries/en/run/datasets"#)
        .send()?
        .error_for_status()?
        .json()?;
    println!("{answer}");
    Ok(())
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://your-instance.example/api/compat/dictionaryapi/v2/entries/en/run/datasets"))
            .GET()
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

require 'net/http'
require 'json'

uri = URI('https://your-instance.example/api/compat/dictionaryapi/v2/entries/en/run/datasets')
request = Net::HTTP::Get.new(uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end
response.value
answer = JSON.parse(response.body)
puts JSON.pretty_generate(answer)

Try it in the playground

GET/api/compat/dictionaryapi/v1/entries/{language}/{word}/datasets

dictionaryapi.dev v1 responses from every open dataset

Parameters

Name	In	Type	Required	Description
`language`	path	`string` `enen_USen_GB`	yes
`word`	path	`string`	yes	Headword spelling, case-insensitive (spaces URL-encoded for phrases). An inflected form resolves to its base entry

Responses

200OK — DictionaryApiV1DatasetsResT
400Invalid input: an unknown field, a value outside the allowed set, or a foreign cursor — DictionaryApiErrorT
404Nothing matches — DictionaryApiErrorT
429Rate limit of the public prefix exceeded (PUBLIC_API_RATE_LIMIT); retry after the window — DictionaryApiErrorT

Example

curl 'https://your-instance.example/api/compat/dictionaryapi/v1/entries/en/run/datasets'

const res = await fetch('https://your-instance.example/api/compat/dictionaryapi/v1/entries/en/run/datasets');
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const answer = await res.json();

import requests

res = requests.get("https://your-instance.example/api/compat/dictionaryapi/v1/entries/en/run/datasets")
res.raise_for_status()
answer = res.json()

import (
	"encoding/json"
	"log"
	"net/http"
)

resp, err := http.Get("https://your-instance.example/api/compat/dictionaryapi/v1/entries/en/run/datasets")
if err != nil {
	log.Fatal(err)
}
defer resp.Body.Close()

var answer map[string]any
if err := json.NewDecoder(resp.Body).Decode(&answer); err != nil {
	log.Fatal(err)
}

$ch = curl_init('https://your-instance.example/api/compat/dictionaryapi/v1/entries/en/run/datasets');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
]);
$answer = json_decode(curl_exec($ch), true);
curl_close($ch);

// cargo add reqwest --features blocking,json
// cargo add serde_json
use reqwest::blocking::Client;
use serde_json::Value;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let answer: Value = client
        .get(r#"https://your-instance.example/api/compat/dictionaryapi/v1/entries/en/run/datasets"#)
        .send()?
        .error_for_status()?
        .json()?;
    println!("{answer}");
    Ok(())
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://your-instance.example/api/compat/dictionaryapi/v1/entries/en/run/datasets"))
            .GET()
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

require 'net/http'
require 'json'

uri = URI('https://your-instance.example/api/compat/dictionaryapi/v1/entries/en/run/datasets')
request = Net::HTTP::Get.new(uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end
response.value
answer = JSON.parse(response.body)
puts JSON.pretty_generate(answer)

Try it in the playground

GET/api/compat/freedictionaryapi/v1/entries/{language}/{word}/datasets

freedictionaryapi.com responses from every open dataset

One group per installed dataset with its terms, status 200 and the adapter object in response. Exact spelling; en and all read English. Missing words and other languages have empty response.entries. The outer request returns 200 even when no dataset matches. Does not activate any dataset. One public rate-limit unit; cached across all datasets. Empty source links point here rather than active-only /meta.

Parameters

Name	In	Type	Required	Description
`language`	path	`string`	yes	en or all; other values return empty entries
`word`	path	`string`	yes	Exact case-sensitive spelling, encoded as one URL segment
`pretty`	query	`boolean`	no	Indent the whole response with two spaces; default false.
`translations`	query	`boolean`	no	Include supported translations; default false. Only true/false, first occurrence wins.

Responses

200OK — FreeDictionaryDatasetsResT
400Invalid input: an unknown field, a value outside the allowed set, or a foreign cursor
429Rate limit of the public prefix exceeded (PUBLIC_API_RATE_LIMIT); retry after the window

Example

curl 'https://your-instance.example/api/compat/freedictionaryapi/v1/entries/example/run/datasets'

const res = await fetch('https://your-instance.example/api/compat/freedictionaryapi/v1/entries/example/run/datasets');
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const answer = await res.json();

import requests

res = requests.get("https://your-instance.example/api/compat/freedictionaryapi/v1/entries/example/run/datasets")
res.raise_for_status()
answer = res.json()

import (
	"encoding/json"
	"log"
	"net/http"
)

resp, err := http.Get("https://your-instance.example/api/compat/freedictionaryapi/v1/entries/example/run/datasets")
if err != nil {
	log.Fatal(err)
}
defer resp.Body.Close()

var answer map[string]any
if err := json.NewDecoder(resp.Body).Decode(&answer); err != nil {
	log.Fatal(err)
}

$ch = curl_init('https://your-instance.example/api/compat/freedictionaryapi/v1/entries/example/run/datasets');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
]);
$answer = json_decode(curl_exec($ch), true);
curl_close($ch);

// cargo add reqwest --features blocking,json
// cargo add serde_json
use reqwest::blocking::Client;
use serde_json::Value;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let answer: Value = client
        .get(r#"https://your-instance.example/api/compat/freedictionaryapi/v1/entries/example/run/datasets"#)
        .send()?
        .error_for_status()?
        .json()?;
    println!("{answer}");
    Ok(())
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://your-instance.example/api/compat/freedictionaryapi/v1/entries/example/run/datasets"))
            .GET()
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

require 'net/http'
require 'json'

uri = URI('https://your-instance.example/api/compat/freedictionaryapi/v1/entries/example/run/datasets')
request = Net::HTTP::Get.new(uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end
response.value
answer = JSON.parse(response.body)
puts JSON.pretty_generate(answer)

Try it in the playground

GET/api/compat/dictionaryapi/v2/entries/{language}/{word}

dictionaryapi.dev v2 lookup in the active dataset

Array response, with lossless provenance in vocabBloom. English only; native headword and inflection resolution. No dataset query parameter.

Parameters

Name	In	Type	Required	Description
`language`	path	`string` `enen_USen_GB`	yes
`word`	path	`string`	yes	Headword spelling, case-insensitive (spaces URL-encoded for phrases). An inflected form resolves to its base entry

Responses

200OK — DictionaryApiV2ResT
400Invalid input: an unknown field, a value outside the allowed set, or a foreign cursor — DictionaryApiErrorT
404Nothing matches — DictionaryApiErrorT
429Rate limit of the public prefix exceeded (PUBLIC_API_RATE_LIMIT); retry after the window — DictionaryApiErrorT

Example

curl 'https://your-instance.example/api/compat/dictionaryapi/v2/entries/en/run'

const res = await fetch('https://your-instance.example/api/compat/dictionaryapi/v2/entries/en/run');
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const answer = await res.json();

import requests

res = requests.get("https://your-instance.example/api/compat/dictionaryapi/v2/entries/en/run")
res.raise_for_status()
answer = res.json()

import (
	"encoding/json"
	"log"
	"net/http"
)

resp, err := http.Get("https://your-instance.example/api/compat/dictionaryapi/v2/entries/en/run")
if err != nil {
	log.Fatal(err)
}
defer resp.Body.Close()

var answer map[string]any
if err := json.NewDecoder(resp.Body).Decode(&answer); err != nil {
	log.Fatal(err)
}

$ch = curl_init('https://your-instance.example/api/compat/dictionaryapi/v2/entries/en/run');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
]);
$answer = json_decode(curl_exec($ch), true);
curl_close($ch);

// cargo add reqwest --features blocking,json
// cargo add serde_json
use reqwest::blocking::Client;
use serde_json::Value;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let answer: Value = client
        .get(r#"https://your-instance.example/api/compat/dictionaryapi/v2/entries/en/run"#)
        .send()?
        .error_for_status()?
        .json()?;
    println!("{answer}");
    Ok(())
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://your-instance.example/api/compat/dictionaryapi/v2/entries/en/run"))
            .GET()
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

require 'net/http'
require 'json'

uri = URI('https://your-instance.example/api/compat/dictionaryapi/v2/entries/en/run')
request = Net::HTTP::Get.new(uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end
response.value
answer = JSON.parse(response.body)
puts JSON.pretty_generate(answer)

Try it in the playground

GET/api/compat/dictionaryapi/v1/entries/{language}/{word}

dictionaryapi.dev legacy v1 lookup in the active dataset

Same entries and terms as v2, with a meaning object keyed by part of speech instead of meanings. English only.

Parameters

Name	In	Type	Required	Description
`language`	path	`string` `enen_USen_GB`	yes
`word`	path	`string`	yes	Headword spelling, case-insensitive (spaces URL-encoded for phrases). An inflected form resolves to its base entry

Responses

200OK — DictionaryApiV1ResT
400Invalid input: an unknown field, a value outside the allowed set, or a foreign cursor — DictionaryApiErrorT
404Nothing matches — DictionaryApiErrorT
429Rate limit of the public prefix exceeded (PUBLIC_API_RATE_LIMIT); retry after the window — DictionaryApiErrorT

Example

curl 'https://your-instance.example/api/compat/dictionaryapi/v1/entries/en/run'

const res = await fetch('https://your-instance.example/api/compat/dictionaryapi/v1/entries/en/run');
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const answer = await res.json();

import requests

res = requests.get("https://your-instance.example/api/compat/dictionaryapi/v1/entries/en/run")
res.raise_for_status()
answer = res.json()

import (
	"encoding/json"
	"log"
	"net/http"
)

resp, err := http.Get("https://your-instance.example/api/compat/dictionaryapi/v1/entries/en/run")
if err != nil {
	log.Fatal(err)
}
defer resp.Body.Close()

var answer map[string]any
if err := json.NewDecoder(resp.Body).Decode(&answer); err != nil {
	log.Fatal(err)
}

$ch = curl_init('https://your-instance.example/api/compat/dictionaryapi/v1/entries/en/run');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
]);
$answer = json_decode(curl_exec($ch), true);
curl_close($ch);

// cargo add reqwest --features blocking,json
// cargo add serde_json
use reqwest::blocking::Client;
use serde_json::Value;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let answer: Value = client
        .get(r#"https://your-instance.example/api/compat/dictionaryapi/v1/entries/en/run"#)
        .send()?
        .error_for_status()?
        .json()?;
    println!("{answer}");
    Ok(())
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://your-instance.example/api/compat/dictionaryapi/v1/entries/en/run"))
            .GET()
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

require 'net/http'
require 'json'

uri = URI('https://your-instance.example/api/compat/dictionaryapi/v1/entries/en/run')
request = Net::HTTP::Get.new(uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end
response.value
answer = JSON.parse(response.body)
puts JSON.pretty_generate(answer)

Try it in the playground

GET/api/compat/freedictionaryapi/v1/entries/{language}/{word}

freedictionaryapi.com lookup in the active dataset

Exact spelling. en and all read the English database; other languages and missing spellings return empty entries. Full terms in vocabBloom.

Parameters

Name	In	Type	Required	Description
`language`	path	`string`	yes	en or all; other values return empty entries
`word`	path	`string`	yes	Exact case-sensitive spelling, encoded as one URL segment
`pretty`	query	`boolean`	no	Indent JSON with two spaces; default false.
`translations`	query	`boolean`	no	Include supported translations; default false. Only true/false, first occurrence wins.

Responses

200OK — FreeDictionaryEntriesResT
400Invalid input: an unknown field, a value outside the allowed set, or a foreign cursor
429Rate limit of the public prefix exceeded (PUBLIC_API_RATE_LIMIT); retry after the window

Example

curl 'https://your-instance.example/api/compat/freedictionaryapi/v1/entries/example/run'

const res = await fetch('https://your-instance.example/api/compat/freedictionaryapi/v1/entries/example/run');
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const answer = await res.json();

import requests

res = requests.get("https://your-instance.example/api/compat/freedictionaryapi/v1/entries/example/run")
res.raise_for_status()
answer = res.json()

import (
	"encoding/json"
	"log"
	"net/http"
)

resp, err := http.Get("https://your-instance.example/api/compat/freedictionaryapi/v1/entries/example/run")
if err != nil {
	log.Fatal(err)
}
defer resp.Body.Close()

var answer map[string]any
if err := json.NewDecoder(resp.Body).Decode(&answer); err != nil {
	log.Fatal(err)
}

$ch = curl_init('https://your-instance.example/api/compat/freedictionaryapi/v1/entries/example/run');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
]);
$answer = json_decode(curl_exec($ch), true);
curl_close($ch);

// cargo add reqwest --features blocking,json
// cargo add serde_json
use reqwest::blocking::Client;
use serde_json::Value;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let answer: Value = client
        .get(r#"https://your-instance.example/api/compat/freedictionaryapi/v1/entries/example/run"#)
        .send()?
        .error_for_status()?
        .json()?;
    println!("{answer}");
    Ok(())
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://your-instance.example/api/compat/freedictionaryapi/v1/entries/example/run"))
            .GET()
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

require 'net/http'
require 'json'

uri = URI('https://your-instance.example/api/compat/freedictionaryapi/v1/entries/example/run')
request = Net::HTTP::Get.new(uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end
response.value
answer = JSON.parse(response.body)
puts JSON.pretty_generate(answer)

Try it in the playground

GET/api/compat/freedictionaryapi/v1/languages

Available headword languages and readable spelling counts

English only. Counts include phrases, inflections and alternative-only entry rows in the active dataset, once per readable spelling; unlinked placeholders are excluded.

Parameters

Name	In	Type	Required	Description
`pretty`	query	`boolean`	no	Indent JSON with two spaces; default false.

Responses

200OK — FreeDictionaryLanguagesResT
400Invalid input: an unknown field, a value outside the allowed set, or a foreign cursor
429Rate limit of the public prefix exceeded (PUBLIC_API_RATE_LIMIT); retry after the window

Example

curl 'https://your-instance.example/api/compat/freedictionaryapi/v1/languages'

const res = await fetch('https://your-instance.example/api/compat/freedictionaryapi/v1/languages');
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const answer = await res.json();

import requests

res = requests.get("https://your-instance.example/api/compat/freedictionaryapi/v1/languages")
res.raise_for_status()
answer = res.json()

import (
	"encoding/json"
	"log"
	"net/http"
)

resp, err := http.Get("https://your-instance.example/api/compat/freedictionaryapi/v1/languages")
if err != nil {
	log.Fatal(err)
}
defer resp.Body.Close()

var answer map[string]any
if err := json.NewDecoder(resp.Body).Decode(&answer); err != nil {
	log.Fatal(err)
}

$ch = curl_init('https://your-instance.example/api/compat/freedictionaryapi/v1/languages');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
]);
$answer = json_decode(curl_exec($ch), true);
curl_close($ch);

// cargo add reqwest --features blocking,json
// cargo add serde_json
use reqwest::blocking::Client;
use serde_json::Value;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let answer: Value = client
        .get(r#"https://your-instance.example/api/compat/freedictionaryapi/v1/languages"#)
        .send()?
        .error_for_status()?
        .json()?;
    println!("{answer}");
    Ok(())
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://your-instance.example/api/compat/freedictionaryapi/v1/languages"))
            .GET()
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

require 'net/http'
require 'json'

uri = URI('https://your-instance.example/api/compat/freedictionaryapi/v1/languages')
request = Net::HTTP::Get.new(uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end
response.value
answer = JSON.parse(response.body)
puts JSON.pretty_generate(answer)

Try it in the playground

GET/api/v1/search/datasets

Search up to five public datasets, in separate groups

Repeat datasets for each target (1–5 unique names). Groups follow installation order. The detailed search filters, limit (1–20) and page (1–20) apply independently to every group. Relevance scores are local to each dataset. Empty matches have status ok and an empty data array; failed readers have status unavailable and no results/pagination. Unknown or closed targets reject the entire request with 404. Partial failures return 200 with meta.partial and Cache-Control: no-store. Each selected dataset costs one unit of the shared public rate budget, including failed reads. Selected searches revalidate their ETag on every use.

Parameters

Name	In	Type	Required	Description
`search`	query	`string`	yes	The term to search for
`type`	query	`string` `wordgrammar_patternphrase`	no	Restrict the answer to one entry type
`limit`	query	`integer`	no	default: 10
`page`	query	`integer`	no	default: 1
`with_meanings`	query	`boolean`	no	Join the meanings (with translations, synonyms, antonyms) of every item default: false
`with_translations`	query	`boolean`	no	Join the short translations of every item default: false
`translation_languages`	query	`string[]` `ruesfrdeptzhar`	no	Keep only these translation languages (a repeated key); omit the key for all of them
`datasets`	query	`string[]`	yes	Public dataset names as repeated keys. Groups follow installation order. Each selected dataset costs one unit of the shared public rate budget.

Responses

200OK — PublicSearchDatasetsV1ResT
400Invalid input: an unknown field, a value outside the allowed set, or a foreign cursor — PublicApiErrorT
404Nothing matches — PublicApiErrorT
429Rate limit of the public prefix exceeded (PUBLIC_API_RATE_LIMIT); retry after the window — PublicApiErrorT

Example

curl 'https://your-instance.example/api/v1/search/datasets?search=run&datasets=default'

const res = await fetch('https://your-instance.example/api/v1/search/datasets?search=run&datasets=default');
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const answer = await res.json();

import requests

res = requests.get("https://your-instance.example/api/v1/search/datasets?search=run&datasets=default")
res.raise_for_status()
answer = res.json()

import (
	"encoding/json"
	"log"
	"net/http"
)

resp, err := http.Get("https://your-instance.example/api/v1/search/datasets?search=run&datasets=default")
if err != nil {
	log.Fatal(err)
}
defer resp.Body.Close()

var answer map[string]any
if err := json.NewDecoder(resp.Body).Decode(&answer); err != nil {
	log.Fatal(err)
}

$ch = curl_init('https://your-instance.example/api/v1/search/datasets?search=run&datasets=default');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
]);
$answer = json_decode(curl_exec($ch), true);
curl_close($ch);

// cargo add reqwest --features blocking,json
// cargo add serde_json
use reqwest::blocking::Client;
use serde_json::Value;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let answer: Value = client
        .get(r#"https://your-instance.example/api/v1/search/datasets?search=run&datasets=default"#)
        .send()?
        .error_for_status()?
        .json()?;
    println!("{answer}");
    Ok(())
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://your-instance.example/api/v1/search/datasets?search=run&datasets=default"))
            .GET()
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

require 'net/http'
require 'json'

uri = URI('https://your-instance.example/api/v1/search/datasets?search=run&datasets=default')
request = Net::HTTP::Get.new(uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end
response.value
answer = JSON.parse(response.body)
puts JSON.pretty_generate(answer)

import { VocabBloomClient } from '@vocab-bloom-hub/client';

const client = new VocabBloomClient({ baseUrl: 'https://your-instance.example' });
const { data } = await client.searchDatasets({ search: 'run', datasets: ['default'] });
for (const group of data) {
  if (group.status === 'ok') console.log(group.dataset, group.data, group.meta.has_more);
  else console.log(group.dataset, group.error);
}

from vocab_bloom_hub import VocabBloomClient

client = VocabBloomClient("https://your-instance.example")
from vocab_bloom_hub import SearchDatasetResult
answer = client.search_datasets("run", ["default"])
for group in answer.data:
    if isinstance(group, SearchDatasetResult):
        print(group.dataset, group.data, group.meta.has_more)
    else:
        print(group.dataset, group.error)

Try it in the playground

GET/api/v1/datasets

Publicly readable datasets and their terms, in installation order

Parameters

No parameters.

Responses

200OK — PublicDatasetsV1ResT
429Rate limit of the public prefix exceeded (PUBLIC_API_RATE_LIMIT); retry after the window — PublicApiErrorT

Example

curl 'https://your-instance.example/api/v1/datasets'

const res = await fetch('https://your-instance.example/api/v1/datasets');
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const answer = await res.json();

import requests

res = requests.get("https://your-instance.example/api/v1/datasets")
res.raise_for_status()
answer = res.json()

import (
	"encoding/json"
	"log"
	"net/http"
)

resp, err := http.Get("https://your-instance.example/api/v1/datasets")
if err != nil {
	log.Fatal(err)
}
defer resp.Body.Close()

var answer map[string]any
if err := json.NewDecoder(resp.Body).Decode(&answer); err != nil {
	log.Fatal(err)
}

$ch = curl_init('https://your-instance.example/api/v1/datasets');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
]);
$answer = json_decode(curl_exec($ch), true);
curl_close($ch);

// cargo add reqwest --features blocking,json
// cargo add serde_json
use reqwest::blocking::Client;
use serde_json::Value;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let answer: Value = client
        .get(r#"https://your-instance.example/api/v1/datasets"#)
        .send()?
        .error_for_status()?
        .json()?;
    println!("{answer}");
    Ok(())
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://your-instance.example/api/v1/datasets"))
            .GET()
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

require 'net/http'
require 'json'

uri = URI('https://your-instance.example/api/v1/datasets')
request = Net::HTTP::Get.new(uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end
response.value
answer = JSON.parse(response.body)
puts JSON.pretty_generate(answer)

import { VocabBloomClient } from '@vocab-bloom-hub/client';

const client = new VocabBloomClient({ baseUrl: 'https://your-instance.example' });
const { data } = await client.datasets();
console.log(data.map(dataset => dataset.dataset));

from vocab_bloom_hub import VocabBloomClient

client = VocabBloomClient("https://your-instance.example")
answer = client.datasets()
print([dataset.dataset for dataset in answer.data])

Try it in the playground

POST/api/v1/words/batch

Up to 50 headwords in one request

Every spelling is matched like `GET /words/{word}`; the answer keeps the request order, collapses duplicates, and lists the spellings without an entry under `meta.not_found` instead of failing. One request against the rate limit, whatever the size of the batch.

Request body · `WordsBatchV1ReqDTO`

Name	Type	Required	Description
`words`	`string[]`	yes	Headword spellings, 50 at most, each matched like GET /words/{word} (case-insensitively; an inflected form resolves to its base entry)

Responses

200OK — PublicWordsBatchV1ResT
400Invalid input: an unknown field, a value outside the allowed set, or a foreign cursor — PublicApiErrorT
429Rate limit of the public prefix exceeded (PUBLIC_API_RATE_LIMIT); retry after the window — PublicApiErrorT

Example

curl -X POST 'https://your-instance.example/api/v1/words/batch' \
  -H 'Content-Type: application/json' \
  -d '{"words":["run","walk","nonexistentword"]}'

const res = await fetch('https://your-instance.example/api/v1/words/batch', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    words: ['run', 'walk', 'nonexistentword']
  }),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const answer = await res.json();

import requests

res = requests.post("https://your-instance.example/api/v1/words/batch", json={
  "words": ["run", "walk", "nonexistentword"]
})
res.raise_for_status()
answer = res.json()

import (
	"encoding/json"
	"log"
	"net/http"
	"strings"
)

resp, err := http.Post("https://your-instance.example/api/v1/words/batch", "application/json", strings.NewReader(`{"words":["run","walk","nonexistentword"]}`))
if err != nil {
	log.Fatal(err)
}
defer resp.Body.Close()

var answer map[string]any
if err := json.NewDecoder(resp.Body).Decode(&answer); err != nil {
	log.Fatal(err)
}

$ch = curl_init('https://your-instance.example/api/v1/words/batch');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
    CURLOPT_POSTFIELDS => json_encode([
      'words' => ['run', 'walk', 'nonexistentword']
    ]),
]);
$answer = json_decode(curl_exec($ch), true);
curl_close($ch);

// cargo add reqwest --features blocking,json
// cargo add serde_json
use reqwest::blocking::Client;
use serde_json::Value;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let body: Value = serde_json::from_str(r#"{"words":["run","walk","nonexistentword"]}"#)?;
    let answer: Value = client
        .post(r#"https://your-instance.example/api/v1/words/batch"#)
        .json(&body)
        .send()?
        .error_for_status()?
        .json()?;
    println!("{answer}");
    Ok(())
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://your-instance.example/api/v1/words/batch"))
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString("{\"words\":[\"run\",\"walk\",\"nonexistentword\"]}"))
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

require 'net/http'
require 'json'

uri = URI('https://your-instance.example/api/v1/words/batch')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = JSON.generate({
  'words' => ['run', 'walk', 'nonexistentword']
})
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end
response.value
answer = JSON.parse(response.body)
puts JSON.pretty_generate(answer)

import { VocabBloomClient } from '@vocab-bloom-hub/client';

const client = new VocabBloomClient({ baseUrl: 'https://your-instance.example' });
const { data, meta } = await client.wordsBatch(['run', 'walk', 'nonexistentword']);
console.log(data.map((item) => item.word), meta.not_found);

from vocab_bloom_hub import VocabBloomClient

client = VocabBloomClient("https://your-instance.example")
answer = client.words_batch(["run", "walk", "nonexistentword"])
print([item.word for item in answer.data], answer.meta.not_found)

Try it in the playground

POST/api/v1/suggestions

Report a mistake in the dictionary data

Files a report for the instance admin to review: what is wrong with a headword (optionally one specific entry of it) and, ideally, what would be right. The headword must exist in the selected publicly open dataset. Pass dataset to target a viewed dataset; omitted means the active dataset. All IDs must belong to that dataset and headword. Closed, unknown or removed targets answer 404 without fallback. Rate limits are shared across datasets; a full target queue answers 503.

Request body · `CreateSuggestionV1ReqDTO`

Name	Type	Required	Description
`dataset`	`string`	no	Installed, publicly open dataset containing the headword and all supplied IDs. Omit to use the active dataset.
`headword`	`string`	yes	The headword the report is about; must exist in the dictionary
`word_id`	`object`	no	Id of the entry (part of speech) the report points at, from the word answers
`kind`	`string` `reportedit`	no	default: "report"
`message`	`object`	no	What is wrong and, ideally, what would be right. Required for a report; an optional comment on an edit
`edits`	`SuggestionEditV1DTO[]`	no	Edit flow: every touched target of the word form with its proposed values
`author_name`	`object`	no	The name the sender wants to be credited by (issue #531). Kept only together with `author_consent: true`: once the correction is applied the name is shown next to it and travels with the copies of the data
`author_consent`	`object`	no	The sender agrees that `author_name` is shown and exported; required when a name is given

Responses

201OK — PublicSuggestionCreatedV1ResT
400Invalid input: an unknown field, a value outside the allowed set, or a foreign cursor — PublicApiErrorT
404Nothing matches — PublicApiErrorT
429Rate limit of the public prefix exceeded (PUBLIC_API_RATE_LIMIT); retry after the window — PublicApiErrorT
503Not available: a selected dataset could not be read, the OpenAPI document is not ready, or the suggestion queue is full — PublicApiErrorT

Example

curl -X POST 'https://your-instance.example/api/v1/suggestions' \
  -H 'Content-Type: application/json' \
  -d '{"headword":"run","message":"Please check the definition of this word."}'

const res = await fetch('https://your-instance.example/api/v1/suggestions', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    headword: 'run',
    message: 'Please check the definition of this word.'
  }),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const answer = await res.json();

import requests

res = requests.post("https://your-instance.example/api/v1/suggestions", json={
  "headword": "run",
  "message": "Please check the definition of this word."
})
res.raise_for_status()
answer = res.json()

import (
	"encoding/json"
	"log"
	"net/http"
	"strings"
)

resp, err := http.Post("https://your-instance.example/api/v1/suggestions", "application/json", strings.NewReader(`{"headword":"run","message":"Please check the definition of this word."}`))
if err != nil {
	log.Fatal(err)
}
defer resp.Body.Close()

var answer map[string]any
if err := json.NewDecoder(resp.Body).Decode(&answer); err != nil {
	log.Fatal(err)
}

$ch = curl_init('https://your-instance.example/api/v1/suggestions');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
    CURLOPT_POSTFIELDS => json_encode([
      'headword' => 'run',
      'message' => 'Please check the definition of this word.'
    ]),
]);
$answer = json_decode(curl_exec($ch), true);
curl_close($ch);

// cargo add reqwest --features blocking,json
// cargo add serde_json
use reqwest::blocking::Client;
use serde_json::Value;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let body: Value = serde_json::from_str(r#"{"headword":"run","message":"Please check the definition of this word."}"#)?;
    let answer: Value = client
        .post(r#"https://your-instance.example/api/v1/suggestions"#)
        .json(&body)
        .send()?
        .error_for_status()?
        .json()?;
    println!("{answer}");
    Ok(())
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://your-instance.example/api/v1/suggestions"))
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString("{\"headword\":\"run\",\"message\":\"Please check the definition of this word.\"}"))
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

require 'net/http'
require 'json'

uri = URI('https://your-instance.example/api/v1/suggestions')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = JSON.generate({
  'headword' => 'run',
  'message' => 'Please check the definition of this word.'
})
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end
response.value
answer = JSON.parse(response.body)
puts JSON.pretty_generate(answer)

import { VocabBloomClient } from '@vocab-bloom-hub/client';

const client = new VocabBloomClient({ baseUrl: 'https://your-instance.example' });
const { data } = await client.suggest({
  headword: 'run',
  message: 'Please check the definition of this word.'
});
console.log(data.id, data.status);

from vocab_bloom_hub import VocabBloomClient

client = VocabBloomClient("https://your-instance.example")
answer = client.suggest(**{
  "headword": "run",
  "message": "Please check the definition of this word."
})
print(answer.data.id, answer.data.status)

Try it in the playground

Schemas

SuggestionEditV1DTO

Name	Type	Required	Description
`target_type`	`string` `wordmeaningmeaning_translationshort_translation`	yes
`target_id`	`number`	yes	Id of the targeted row, from the word answers
`changes`	`object`	yes	The proposed field values, e.g. { "definition": "…" }. The accepted fields depend on target_type; unknown fields, empty values and values equal to the current ones are rejected

CreateSuggestionV1ReqDTO

Name	Type	Required	Description
`dataset`	`string`	no	Installed, publicly open dataset containing the headword and all supplied IDs. Omit to use the active dataset.
`headword`	`string`	yes	The headword the report is about; must exist in the dictionary
`word_id`	`object`	no	Id of the entry (part of speech) the report points at, from the word answers
`kind`	`string` `reportedit`	no	default: "report"
`message`	`object`	no	What is wrong and, ideally, what would be right. Required for a report; an optional comment on an edit
`edits`	`SuggestionEditV1DTO[]`	no	Edit flow: every touched target of the word form with its proposed values
`author_name`	`object`	no	The name the sender wants to be credited by (issue #531). Kept only together with `author_consent: true`: once the correction is applied the name is shown next to it and travels with the copies of the data
`author_consent`	`object`	no	The sender agrees that `author_name` is shown and exported; required when a name is given

WordsBatchV1ReqDTO

Name	Type	Required	Description
`words`	`string[]`	yes	Headword spellings, 50 at most, each matched like GET /words/{word} (case-insensitively; an inflected form resolves to its base entry)

PublicSearchV1MetaT

Name	Type	Required	Description
`dataset`	`string`	no	Present only for an explicitly selected dataset.
`count`	`integer`	yes
`fuzzy`	`boolean`	yes
`short_term`	`boolean`	yes

PublicSearchV1ResT

Name	Type	Required	Description
`data`	`PublicSearchWordV1T[]`	yes
`meta`	`PublicSearchV1MetaT`	yes

PublicSearchWordV1T

Name	Type	Required	Description
`alternatives`	`string[]`	no	Alternative spellings of this headword, shared by all its parts of speech.
`origins`	`OriginT[]`	no
`contributions`	`OriginT[]`	no	Terms of the datasets whose edits still contribute to this word.
`licenses`	`WordLicenseT[]`	no
`id`	`integer`	yes
`word`	`string`	yes
`part_of_speech`	`EnPartOfSpeechE`	yes
`form_of_word`	`EnWordFormsE`	yes
`is_obsolete`	`boolean`	yes
`is_abbreviation`	`boolean`	yes
`word_level`	`WordLevelE \| null`	yes
`area_variant`	`EnAreaVariantsE \| null`	yes
`categories`	`CategoryE[]`	yes
`language_register`	`LanguageRegisterE \| null`	yes
`description`	`string \| null`	yes
`transcription`	`string \| null`	yes
`pronunciations`	`PronunciationT[]`	no	Ordered pronunciations, with legacy transcription and base-form fallback.
`pattern`	`string[] \| null`	yes
`noun___irregular_plural`	`boolean \| null`	yes
`noun___uncountable`	`boolean \| null`	yes
`noun___is_proper`	`boolean \| null`	yes
`noun___always_plural`	`boolean \| null`	yes
`verb___is_irregular`	`boolean \| null`	yes
`verb___transitivity`	`EnVerbTransitivityE \| null`	yes
`verb___is_phrasal`	`boolean \| null`	yes
`verb___phrasal_object_pattern`	`EnPhrasalObjectPatternE \| null`	yes
`base_phrasal`	`string \| null`	yes
`forms`	`PublicWordV1FormT[]`	yes
`similarity`	`number`	no
`source`	`string`	no
`modified`	`boolean`	no

OriginT

Name	Type	Required	Description
`id`	`string`	yes
`name`	`string`	yes
`version`	`string \| null`	yes
`url`	`string`	no
`record_url`	`string`	no
`licenses`	`OriginLicenseT[]`	yes
`license_relation`	`string` `allany`	yes	All obligations apply, or the source explicitly offers a choice.
`attribution`	`string`	yes
`notices`	`string[]`	yes
`scope`	`string` `worddataset`	yes	Dataset means that distribution between individual words is unknown.
`method`	`string` `datasetmanual`	yes
`recorded_at`	`string \| null`	yes
`acquisitions`	`OriginAcquisitionT[]`	no	Copy/fork events belonging to this source snapshot; absent before any acquisition.
`inherited`	`boolean`	yes	Automatically inherited terms cannot be removed by ordinary editing.

OriginLicenseT

A durable statement of terms, not a pointer to a mutable dataset registry.

Name	Type	Required	Description
`spdx`	`string`	no
`name`	`string`	yes
`url`	`string`	yes
`text`	`string`	no	Required for custom licenses; preserved verbatim when supplied.

OriginAcquisitionT

An acquisition of a source snapshot, without repeating its license terms.

Name	Type	Required	Description
`id`	`string`	yes
`method`	`string` `copyfork`	yes
`recorded_at`	`string \| null`	yes
`revision`	`string`	no
`via`	`object`	no	The intermediate dataset the material passed through; this adds no license obligations.

WordLicenseT

One license can occur more than once; origin_id refers to origins or contributions.

Name	Type	Required	Description
`origin_id`	`string`	yes
`spdx`	`string`	no
`name`	`string`	yes
`url`	`string`	yes
`text`	`string`	no	Required for custom licenses; preserved verbatim when supplied.

EnPartOfSpeechE

One of: noun, verb, modal_verb, adjective, adverb, pronoun, numeral, numeral_fractional, determiner, interjection, article, preposition, conjunction, letter, phrase, grammar_pattern

EnWordFormsE

One of: base_form, plural_form, possessive_singular_form, possessive_plural_form, past_simple, past_participle, present_participle, third_person_singular, comparative_form, superlative_form, object, possessive_adjective, possessive_pronoun, reflexive, ordinal, multiplicative

WordLevelE

One of: A1, A2, B1, B2, C1, C2

EnAreaVariantsE

One of: common, british, american, australian

CategoryE

One of: scientific, technical, medical, legal, business, IT, art, political, sport, culinary

LanguageRegisterE

One of: formal, informal, slang

PronunciationT

Portable pronunciation; database IDs never travel in datasets or public responses.

Name	Type	Required	Description
`audio`	`PronunciationAudioT[]`	no	Recordings carry their own terms, independent of the word's text.
`type`	`string` `ipaenpr`	yes
`text`	`string \| null`	yes
`area_variant`	`EnAreaVariantsE`	yes
`sort_order`	`integer`	yes

PronunciationAudioT

External recordings only; missing license metadata is an empty list, never the text license.

Name	Type	Required
`url`	`string`	yes
`source_url`	`string \| null`	no
`attribution`	`string \| null`	no
`licenses`	`OriginLicenseT[]`	yes
`sort_order`	`integer`	yes

EnVerbTransitivityE

One of: transitive, intransitive, both

EnPhrasalObjectPatternE

One of: no_object, inseparable, separable, separable_pronoun_only

PublicWordV1FormT

Name	Type	Required	Description
`alternatives`	`string[]`	no
`id`	`integer`	yes
`word`	`string`	yes
`form_of_word`	`EnWordFormsE`	yes
`area_variant`	`EnAreaVariantsE`	yes
`transcription`	`string \| null`	yes
`pronunciations`	`PronunciationT[]`	no	Ordered pronunciations, with legacy transcription and base-form fallback.

PublicSearchDetailedV1MetaT

Name	Type	Required	Description
`dataset`	`string`	no	Present only for an explicitly selected dataset.
`page`	`integer`	yes
`limit`	`integer`	yes
`has_more`	`boolean`	yes
`fuzzy`	`boolean`	yes
`short_term`	`boolean`	yes

PublicSearchDetailedV1ResT

Name	Type	Required	Description
`data`	`PublicWordV1T[]`	yes
`meta`	`PublicSearchDetailedV1MetaT`	yes

PublicWordV1T

Name	Type	Required	Description
`etymologies`	`object[]`	no
`meanings`	`PublicWordV1MeaningT[]`	yes
`short_translations`	`PublicWordV1ShortTranslationT[]`	yes
`phrasal_variants`	`string[]`	no
`alternatives`	`string[]`	no	Alternative spellings of this headword, shared by all its parts of speech.
`origins`	`OriginT[]`	no
`contributions`	`OriginT[]`	no	Terms of the datasets whose edits still contribute to this word.
`licenses`	`WordLicenseT[]`	no
`id`	`integer`	yes
`word`	`string`	yes
`part_of_speech`	`EnPartOfSpeechE`	yes
`form_of_word`	`EnWordFormsE`	yes
`is_obsolete`	`boolean`	yes
`is_abbreviation`	`boolean`	yes
`word_level`	`WordLevelE \| null`	yes
`area_variant`	`EnAreaVariantsE \| null`	yes
`categories`	`CategoryE[]`	yes
`language_register`	`LanguageRegisterE \| null`	yes
`description`	`string \| null`	yes
`transcription`	`string \| null`	yes
`pronunciations`	`PronunciationT[]`	no	Ordered pronunciations, with legacy transcription and base-form fallback.
`pattern`	`string[] \| null`	yes
`noun___irregular_plural`	`boolean \| null`	yes
`noun___uncountable`	`boolean \| null`	yes
`noun___is_proper`	`boolean \| null`	yes
`noun___always_plural`	`boolean \| null`	yes
`verb___is_irregular`	`boolean \| null`	yes
`verb___transitivity`	`EnVerbTransitivityE \| null`	yes
`verb___is_phrasal`	`boolean \| null`	yes
`verb___phrasal_object_pattern`	`EnPhrasalObjectPatternE \| null`	yes
`base_phrasal`	`string \| null`	yes
`forms`	`PublicWordV1FormT[]`	yes
`similarity`	`number`	no
`source`	`string`	no
`modified`	`boolean`	no

PublicWordV1MeaningT

Name	Type	Required	Description
`etymology_number`	`integer \| null`	no	Local number of the owning word etymology; null when unknown.
`id`	`integer`	yes
`sort_order`	`integer`	yes
`title`	`string`	yes
`definition`	`string`	yes
`is_obsolete`	`boolean`	yes
`examples`	`string[]`	yes
`quotes`	`MeaningQuoteT[]`	no
`categories`	`CategoryE[]`	yes
`meaning_level`	`WordLevelE \| null`	yes
`area_variant`	`EnAreaVariantsE`	yes
`language_register`	`LanguageRegisterE \| null`	yes
`translations`	`PublicWordV1MeaningTranslationT[]`	yes
`synonyms`	`string[]`	yes
`antonyms`	`string[]`	yes

MeaningQuoteT

A sourced quotation, in authored array order. Missing attribution is explicit.

Name	Type	Required
`text`	`string`	yes
`reference`	`string \| null`	yes
`source_url`	`string \| null`	no

PublicWordV1MeaningTranslationT

Name	Type	Required
`id`	`integer`	yes
`language`	`AvailableTranslationLanguagesE`	yes
`title`	`string`	yes
`definition`	`string`	yes
`variants_of_words`	`string[]`	yes

AvailableTranslationLanguagesE

One of: ru, es, fr, de, pt, zh, ar

PublicWordV1ShortTranslationT

Name	Type	Required
`id`	`integer`	yes
`language`	`AvailableTranslationLanguagesE`	yes
`description`	`string`	yes
`variants_of_words`	`string[]`	yes

PublicWordV1ResT

Name	Type	Required	Description
`data`	`PublicWordV1T`	yes

PublicHeadwordV1MetaT

Name	Type	Required
`word`	`string`	yes
`count`	`integer`	yes
`variants`	`string[]`	no

PublicHeadwordV1ResT

Name	Type	Required	Description
`data`	`PublicWordV1T[]`	yes
`meta`	`PublicHeadwordV1MetaT`	yes

PublicMeaningV1T

Name	Type	Required	Description
`origins`	`OriginT[]`	no
`contributions`	`OriginT[]`	no
`licenses`	`WordLicenseT[]`	no
`word_id`	`integer`	yes
`part_of_speech`	`EnPartOfSpeechE`	yes
`source`	`string`	no
`modified`	`boolean`	no
`etymology_number`	`integer \| null`	no	Local number of the owning word etymology; null when unknown.
`id`	`integer`	yes
`sort_order`	`integer`	yes
`title`	`string`	yes
`definition`	`string`	yes
`is_obsolete`	`boolean`	yes
`examples`	`string[]`	yes
`quotes`	`MeaningQuoteT[]`	no
`categories`	`CategoryE[]`	yes
`meaning_level`	`WordLevelE \| null`	yes
`area_variant`	`EnAreaVariantsE`	yes
`language_register`	`LanguageRegisterE \| null`	yes
`translations`	`PublicWordV1MeaningTranslationT[]`	yes
`synonyms`	`string[]`	yes
`antonyms`	`string[]`	yes

PublicHeadwordMeaningsV1ResT

Name	Type	Required	Description
`data`	`PublicMeaningV1T[]`	yes
`meta`	`PublicHeadwordV1MetaT`	yes

PublicWordFormV1T

Name	Type	Required	Description
`origins`	`OriginT[]`	no
`contributions`	`OriginT[]`	no
`licenses`	`WordLicenseT[]`	no
`word_id`	`integer`	yes
`part_of_speech`	`EnPartOfSpeechE`	yes
`source`	`string`	no
`modified`	`boolean`	no
`alternatives`	`string[]`	no
`id`	`integer`	yes
`word`	`string`	yes
`form_of_word`	`EnWordFormsE`	yes
`area_variant`	`EnAreaVariantsE`	yes
`transcription`	`string \| null`	yes
`pronunciations`	`PronunciationT[]`	no	Ordered pronunciations, with legacy transcription and base-form fallback.

PublicHeadwordFormsV1ResT

Name	Type	Required	Description
`data`	`PublicWordFormV1T[]`	yes
`meta`	`PublicHeadwordV1MetaT`	yes

PublicShortTranslationV1T

Name	Type	Required
`origins`	`OriginT[]`	no
`contributions`	`OriginT[]`	no
`licenses`	`WordLicenseT[]`	no
`word_id`	`integer`	yes
`part_of_speech`	`EnPartOfSpeechE`	yes
`source`	`string`	no
`modified`	`boolean`	no
`id`	`integer`	yes
`language`	`AvailableTranslationLanguagesE`	yes
`description`	`string`	yes
`variants_of_words`	`string[]`	yes

PublicMeaningTranslationV1T

Name	Type	Required
`meaning_id`	`integer`	yes
`origins`	`OriginT[]`	no
`contributions`	`OriginT[]`	no
`licenses`	`WordLicenseT[]`	no
`word_id`	`integer`	yes
`part_of_speech`	`EnPartOfSpeechE`	yes
`source`	`string`	no
`modified`	`boolean`	no
`id`	`integer`	yes
`language`	`AvailableTranslationLanguagesE`	yes
`title`	`string`	yes
`definition`	`string`	yes
`variants_of_words`	`string[]`	yes

PublicWordLinkV1T

Name	Type	Required
`meaning_id`	`integer`	yes
`word`	`string`	yes
`origins`	`OriginT[]`	no
`contributions`	`OriginT[]`	no
`licenses`	`WordLicenseT[]`	no
`word_id`	`integer`	yes
`part_of_speech`	`EnPartOfSpeechE`	yes
`source`	`string`	no
`modified`	`boolean`	no

PublicHeadwordLinksV1ResT

Name	Type	Required	Description
`data`	`PublicWordLinkV1T[]`	yes
`meta`	`PublicHeadwordV1MetaT`	yes

PublicChangeV1T

Name	Type	Required	Description
`inherited_from`	`OriginT \| null`	no
`contribution`	`OriginT \| null`	no	Terms captured when this edit was made, independent of later dataset changes.
`reason`	`string \| null`	no
`created_at`	`string`	yes
`word`	`string`	yes
`part_of_speech`	`string \| null`	yes
`entity`	`ChangeEntityE`	yes
`action`	`ChangeActionE`	yes
`record`	`ChangeRecordT \| null`	yes
`diff`	`ChangeDiffT`	yes
`origin`	`ChangeOriginE`	yes
`author`	`string \| null`	yes
`source`	`string`	no

ChangeEntityE

What was edited

One of: word, word_form, meaning, meaning_translation, short_translation

ChangeActionE

One of: create, update, delete

ChangeRecordT

The record of an entry an edit is about, by what it says rather than by its id: ids change when a dataset is updated and differ between instances. Null for the word itself — the headword and the part of speech name it.

Name	Type	Required	Description

ChangeFormRecordT

Name	Type	Required	Description
`word`	`string`	yes
`form_of_word`	`string`	yes

ChangeMeaningRecordT

Name	Type	Required	Description
`title`	`string`	yes
`sort_order`	`integer`	yes

ChangeTranslationRecordT

Name	Type	Required
`meaning`	`ChangeMeaningRecordT`	yes
`language`	`string`	yes
`title`	`string`	yes

ChangeShortTranslationRecordT

Name	Type	Required	Description
`language`	`string`	yes
`description`	`string`	yes

ChangeDiffT

The values an edit changed: `{ field: { before, after } }`; a creation has no `before`, a deletion no `after`

Name	Type	Required	Description

ChangeOriginE

Where an edit came from

One of: admin, suggestion, revert

PublicHeadwordHistoryV1MetaT

Name	Type	Required
`word`	`string`	yes
`count`	`integer`	yes
`variants`	`string[]`	no

PublicHeadwordHistoryV1ResT

Name	Type	Required	Description
`data`	`PublicChangeV1T[]`	yes
`meta`	`PublicHeadwordHistoryV1MetaT`	yes

PublicDatasetTermsV1T

Name	Type	Required
`origins`	`OriginT[]`	no
`licenses`	`WordLicenseT[]`	no
`description`	`string \| null`	no
`dataset`	`string`	yes
`title`	`string`	no
`active`	`boolean`	yes
`source`	`string`	yes
`dataset_version`	`string \| null`	yes
`license`	`string`	yes
`license_url`	`string`	yes
`attribution`	`string`	yes
`attribution_url`	`string \| null`	yes
`notice`	`string`	yes
`license_text`	`string`	yes

PublicWordDatasetV1T

Name	Type	Required
`word`	`string`	yes
`variants`	`string[]`	yes
`count`	`integer`	yes
`entries`	`PublicWordV1T[]`	yes
`origins`	`OriginT[]`	no
`licenses`	`WordLicenseT[]`	no
`description`	`string \| null`	no
`dataset`	`string`	yes
`title`	`string`	no
`active`	`boolean`	yes
`source`	`string`	yes
`dataset_version`	`string \| null`	yes
`license`	`string`	yes
`license_url`	`string`	yes
`attribution`	`string`	yes
`attribution_url`	`string \| null`	yes
`notice`	`string`	yes
`license_text`	`string`	yes

PublicWordDatasetsV1MetaT

Name	Type	Required
`word`	`string`	yes
`datasets`	`integer`	yes
`found`	`integer`	yes

PublicWordDatasetsV1ResT

Name	Type	Required	Description
`data`	`PublicWordDatasetV1T[]`	yes
`meta`	`PublicWordDatasetsV1MetaT`	yes

PublicHeadwordTranslationsV1T

Name	Type	Required	Description
`short_translations`	`PublicShortTranslationV1T[]`	yes
`meaning_translations`	`PublicMeaningTranslationV1T[]`	yes

PublicHeadwordTranslationsV1ResT

Name	Type	Required	Description
`meta`	`PublicHeadwordV1MetaT`	yes
`data`	`PublicHeadwordTranslationsV1T`	yes

PublicWordsBatchItemV1T

Name	Type	Required
`word`	`string`	yes
`count`	`integer`	yes
`entries`	`PublicWordV1T[]`	yes

PublicWordsBatchV1MetaT

Name	Type	Required	Description
`count`	`integer`	yes
`not_found`	`string[]`	yes

PublicWordsBatchV1ResT

Name	Type	Required	Description
`data`	`PublicWordsBatchItemV1T[]`	yes
`meta`	`PublicWordsBatchV1MetaT`	yes

PublicWordsV1MetaT

Name	Type	Required
`limit`	`integer`	yes
`has_more`	`boolean`	yes
`next_cursor`	`string \| null`	yes

PublicWordsV1ResT

Name	Type	Required	Description
`data`	`PublicWordV1T[]`	yes
`meta`	`PublicWordsV1MetaT`	yes

PublicDatasetCountsV1T

Name	Type	Required
`entries`	`integer`	yes
`words`	`integer`	yes
`phrases`	`integer`	yes
`grammar_patterns`	`integer`	yes
`word_forms`	`integer`	yes
`meanings`	`integer`	yes
`meaning_translations`	`integer`	yes
`short_translations`	`integer`	yes

PublicMetaV1T

Name	Type	Required
`origins`	`OriginT[]`	no
`licenses`	`WordLicenseT[]`	no
`description`	`string \| null`	no
`api_version`	`string`	yes
`app_version`	`string`	yes
`dataset_version`	`string \| null`	yes
`license`	`string`	yes
`license_url`	`string`	yes
`attribution`	`string`	yes
`notice`	`string`	yes
`dataset`	`string`	no
`title`	`string`	no
`source`	`string`	no
`attribution_url`	`string \| null`	no
`license_text`	`string`	no
`modified_entries`	`integer`	no
`counts`	`PublicDatasetCountsV1T`	yes
`available_languages`	`PublicAvailableLanguagesV1T`	yes

PublicAvailableLanguagesV1T

Name	Type	Required	Description
`source`	`string[]`	yes
`translations`	`AvailableTranslationLanguagesE[]`	yes

PublicMetaV1ResT

Name	Type	Required	Description
`data`	`PublicMetaV1T`	yes

PublicSuggestionCreatedV1T

Name	Type	Required	Description
`id`	`integer`	yes
`status`	`string`	yes

PublicSuggestionCreatedV1ResT

Name	Type	Required	Description
`data`	`PublicSuggestionCreatedV1T`	yes

PublicApiErrorT

Name	Type	Required
`statusCode`	`number`	yes
`message`	`string`	yes
`error`	`boolean`	yes

DictionaryApiV1DatasetsResT

Name	Type	Required	Description
`data`	`object[]`	yes
`meta`	`object`	yes	found counts datasets with entries, including for adapters whose misses are HTTP 200.

DictionaryApiV1ResT

Name	Type	Required	Description

DictionaryApiDefinitionT

Name	Type	Required
`definition`	`string`	yes
`example`	`string`	no
`synonyms`	`string[]`	yes
`antonyms`	`string[]`	yes

DictionaryApiPhoneticT

Name	Type	Required	Description
`text`	`string`	no
`audio`	`string`	yes
`sourceUrl`	`string`	no
`license`	`DictionaryApiLicenseT`	no
`vocabBloom`	`object`	no	Lossless recording terms; the upstream singular license cannot express all of these.

DictionaryApiLicenseT

Name	Type	Required	Description
`name`	`string`	yes
`url`	`string`	yes

DictionaryApiErrorT

Name	Type	Required
`title`	`string`	yes
`message`	`string`	yes
`resolution`	`string`	yes

DictionaryApiV2DatasetsResT

Name	Type	Required	Description
`data`	`object[]`	yes
`meta`	`object`	yes	found counts datasets with entries, including for adapters whose misses are HTTP 200.

DictionaryApiV2ResT

Name	Type	Required	Description

DictionaryApiMeaningT

Name	Type	Required
`partOfSpeech`	`string`	yes
`definitions`	`DictionaryApiDefinitionT[]`	yes
`synonyms`	`string[]`	yes
`antonyms`	`string[]`	yes

FreeDictionaryDatasetsResT

Name	Type	Required	Description
`data`	`object[]`	yes
`meta`	`object`	yes	found counts datasets with entries, including for adapters whose misses are HTTP 200.

FreeDictionaryEntriesResT

Name	Type	Required	Description
`word`	`string`	yes
`entries`	`FreeDictionaryEntryT[]`	yes
`source`	`object`	yes
`vocabBloom`	`PublicDatasetTermsV1T`	yes	Terms of the dataset read. Word-specific origins are retained on each entry.

FreeDictionaryEntryT

Name	Type	Required	Description
`language`	`FreeDictionaryLanguageT`	yes
`partOfSpeech`	`string`	yes
`pronunciations`	`object[]`	yes
`forms`	`object[]`	yes
`senses`	`FreeDictionarySenseT[]`	yes
`synonyms`	`string[]`	yes
`antonyms`	`string[]`	yes
`vocabBloom`	`object`	yes	Native entry identity and lossless terms; additive to the upstream format.

FreeDictionaryLanguageT

Name	Type	Required	Description
`code`	`string`	yes
`name`	`string`	yes

FreeDictionarySenseT

Name	Type	Required
`definition`	`string`	yes
`tags`	`string[]`	yes
`examples`	`string[]`	yes
`quotes`	`object[]`	yes
`synonyms`	`string[]`	yes
`antonyms`	`string[]`	yes
`translations`	`object[]`	no
`subsenses`	`FreeDictionarySenseT[]`	yes

FreeDictionaryErrorT

Upstream parameter errors are plain text, not the native error envelope.

Name	Type	Required	Description

FreeDictionaryLanguagesResT

Name	Type	Required	Description

PublicDatasetsV1ResT

Public selector inventory, in installation order; no dictionary connections or counts.

Name	Type	Required	Description
`data`	`PublicDatasetTermsV1T[]`	yes
`meta`	`object`	yes

PublicSearchDatasetResultV1T

Name	Type	Required
`status`	`string` `ok`	yes
`data`	`PublicWordV1T[]`	yes
`meta`	`PublicSearchDetailedV1MetaT`	yes
`origins`	`OriginT[]`	no
`licenses`	`WordLicenseT[]`	no
`description`	`string \| null`	no
`dataset`	`string`	yes
`title`	`string`	no
`active`	`boolean`	yes
`source`	`string`	yes
`dataset_version`	`string \| null`	yes
`license`	`string`	yes
`license_url`	`string`	yes
`attribution`	`string`	yes
`attribution_url`	`string \| null`	yes
`notice`	`string`	yes
`license_text`	`string`	yes

PublicSearchDatasetUnavailableV1T

A failed reader has no result list or paging metadata; it is not an empty match.

Name	Type	Required
`status`	`string` `unavailable`	yes
`error`	`string` `dataset_unavailable`	yes
`origins`	`OriginT[]`	no
`licenses`	`WordLicenseT[]`	no
`description`	`string \| null`	no
`dataset`	`string`	yes
`title`	`string`	no
`active`	`boolean`	yes
`source`	`string`	yes
`dataset_version`	`string \| null`	yes
`license`	`string`	yes
`license_url`	`string`	yes
`attribution`	`string`	yes
`attribution_url`	`string \| null`	yes
`notice`	`string`	yes
`license_text`	`string`	yes

PublicSearchDatasetV1T

Name	Type	Required	Description

PublicSearchDatasetsV1ResT

Name	Type	Required	Description
`data`	`PublicSearchDatasetV1T[]`	yes
`meta`	`object`	yes

PublicSemanticMatchV1T

A matching existing sense, with cosine similarity (not a confidence probability).

Name	Type	Required	Description
`word`	`PublicSearchWordV1T`	yes
`meaning`	`object`	yes
`score`	`number`	yes	Cosine similarity from -1 to 1; no calibrated no-answer threshold.

PublicSemanticSearchV1ResT

Name	Type	Required	Description
`data`	`PublicSemanticMatchV1T[]`	yes
`meta`	`object`	yes

PublicSemanticStatusV1ResT

Name	Type	Required	Description
`data`	`object`	yes