API pública v1

A referência da API somente leitura do dicionário, gerada a partir do documento OpenAPI publicado pelo servidor — o mesmo contrato a partir do qual os SDKs são construídos.

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.

URL basehttps://<instance>/api/v1

Cada instância serve a API na sua própria origem; os exemplos abaixo usam um marcador.

Contrato

Documento OpenAPI 3, servido por cada instância em /api/v1/openapi.json; o arquivo versionado

Endpoints

GET/api/v1/meta

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

Parâmetros

Sem parâmetros.

Respostas

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

Exemplo

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)

Testar no playground

GET/api/v1/openapi.json

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

Parâmetros

Sem parâmetros.

Respostas

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

Exemplo

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.

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
`search`	query	`string`	sim	The term to search for
`type`	query	`string` `wordgrammar_patternphrase`	não	Restrict the answer to one entry type
`limit`	query	`integer`	não	padrão: 10
`dataset`	query	`string`	não	Public dataset name; omitted = the active dataset. Unknown or closed targets return 404, never a fallback.

Respostas

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

Exemplo

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)

Testar no 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.

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
`search`	query	`string`	sim	The term to search for
`type`	query	`string` `wordgrammar_patternphrase`	não	Restrict the answer to one entry type
`limit`	query	`integer`	não	padrão: 10
`page`	query	`integer`	não	padrão: 1
`with_meanings`	query	`boolean`	não	Join the meanings (with translations, synonyms, antonyms) of every item padrão: false
`with_translations`	query	`boolean`	não	Join the short translations of every item padrão: false
`translation_languages`	query	`string[]` `ruesfrdeptzhar`	não	Keep only these translation languages (a repeated key); omit the key for all of them
`dataset`	query	`string`	não	Public dataset name; omitted = the active dataset. Unknown or closed targets return 404, never a fallback.

Respostas

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

Exemplo

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,
)

Testar no playground

GET/api/v1/words/{word}

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

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
`word`	path	`string`	sim	Headword spelling, case-insensitive (spaces URL-encoded for phrases). An inflected form resolves to its base entry

Respostas

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

Exemplo

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)

Testar no playground

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

The meanings of a headword across its entries

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
`word`	path	`string`	sim	Headword spelling, case-insensitive (spaces URL-encoded for phrases). An inflected form resolves to its base entry

Respostas

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

Exemplo

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)

Testar no playground

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

The short and per-meaning translations of a headword

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
`word`	path	`string`	sim	Headword spelling, case-insensitive (spaces URL-encoded for phrases). An inflected form resolves to its base entry
`language`	query	`string[]` `ruesfrdeptzhar`	não	Translation languages; no value means all of them

Respostas

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

Exemplo

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)

Testar no playground

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

The inflected forms of a headword across its entries

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
`word`	path	`string`	sim	Headword spelling, case-insensitive (spaces URL-encoded for phrases). An inflected form resolves to its base entry

Respostas

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

Exemplo

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)

Testar no 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`.

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
`word`	path	`string`	sim	Headword spelling, case-insensitive (spaces URL-encoded for phrases). An inflected form resolves to its base entry

Respostas

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

Exemplo

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])

Testar no 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`.

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
`word`	path	`string`	sim	Headword spelling, case-insensitive (spaces URL-encoded for phrases). An inflected form resolves to its base entry

Respostas

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

Exemplo

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])

Testar no 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.

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
`word`	path	`string`	sim	Headword spelling, case-insensitive (spaces URL-encoded for phrases). An inflected form resolves to its base entry

Respostas

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

Exemplo

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)

Testar no 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.

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
`word`	path	`string`	sim	Headword spelling, case-insensitive (spaces URL-encoded for phrases). An inflected form resolves to its base entry

Respostas

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

Exemplo

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))

Testar no 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.

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
`word`	path	`string`	sim	Headword spelling, case-insensitive (spaces URL-encoded for phrases). An inflected form resolves to its base entry
`dataset`	path	`string`	sim	The name of a dataset of the instance, as `dataset` of a group of `GET /words/{word}/datasets` says it

Respostas

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

Exemplo

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)

Testar no playground

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

One dictionary entry by its numeric id

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
`id`	path	`number`	sim

Respostas

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

Exemplo

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)

Testar no 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.

Parâmetros

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

Respostas

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

Exemplo

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)

Testar no playground

GET/api/v1/random

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

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
`search`	query	`string`	não	Headword prefix, case-insensitive (`ru` lists run, rung, runner, …)
`is_obsolete`	query	`boolean`	não	true: obsolete entries only, false: current ones only
`part_of_speech`	query	`string[]` `nounverbmodal_verbadjectiveadverbpronounnumeralnumeral_fractionaldeterminerinterjectionarticleprepositionconjunctionletterphrasegrammar_pattern`	não
`word_level`	query	`string[]` `A1A2B1B2C1C2`	não
`language_register`	query	`string[]` `formalinformalslang`	não
`category`	query	`string[]` `scientifictechnicalmedicallegalbusinessITartpoliticalsportculinary`	não	Words tagged with any of the categories
`area_variant`	query	`string[]` `commonbritishamericanaustralian`	não
`form_of_word`	query	`string[]` `base_formplural_formpossessive_singular_formpossessive_plural_formpast_simplepast_participlepresent_participlethird_person_singularcomparative_formsuperlative_formobjectpossessive_adjectivepossessive_pronounreflexiveordinalmultiplicative`	não	Defaults to base forms only padrão: ["base_form"]

Respostas

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

Exemplo

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)

Testar no 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.

Parâmetros

Sem parâmetros.

Respostas

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

Exemplo

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)

Testar no 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.

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
`query`	query	`string`	sim	A description of the intended meaning, in English or another language supported by the model.
`dataset`	query	`string`	não	One public dataset; omitted = active dataset. Closed/unknown targets return 404.
`limit`	query	`integer`	não	padrão: 10

Respostas

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

Exemplo

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)

Testar no 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.

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
`language`	path	`string` `enen_USen_GB`	sim
`word`	path	`string`	sim	Headword spelling, case-insensitive (spaces URL-encoded for phrases). An inflected form resolves to its base entry

Respostas

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

Exemplo

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)

Testar no playground

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

dictionaryapi.dev v1 responses from every open dataset

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
`language`	path	`string` `enen_USen_GB`	sim
`word`	path	`string`	sim	Headword spelling, case-insensitive (spaces URL-encoded for phrases). An inflected form resolves to its base entry

Respostas

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

Exemplo

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)

Testar no 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.

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
`language`	path	`string`	sim	en or all; other values return empty entries
`word`	path	`string`	sim	Exact case-sensitive spelling, encoded as one URL segment
`pretty`	query	`boolean`	não	Indent the whole response with two spaces; default false.
`translations`	query	`boolean`	não	Include supported translations; default false. Only true/false, first occurrence wins.

Respostas

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

Exemplo

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)

Testar no 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.

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
`language`	path	`string` `enen_USen_GB`	sim
`word`	path	`string`	sim	Headword spelling, case-insensitive (spaces URL-encoded for phrases). An inflected form resolves to its base entry

Respostas

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

Exemplo

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)

Testar no 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.

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
`language`	path	`string` `enen_USen_GB`	sim
`word`	path	`string`	sim	Headword spelling, case-insensitive (spaces URL-encoded for phrases). An inflected form resolves to its base entry

Respostas

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

Exemplo

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)

Testar no 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.

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
`language`	path	`string`	sim	en or all; other values return empty entries
`word`	path	`string`	sim	Exact case-sensitive spelling, encoded as one URL segment
`pretty`	query	`boolean`	não	Indent JSON with two spaces; default false.
`translations`	query	`boolean`	não	Include supported translations; default false. Only true/false, first occurrence wins.

Respostas

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

Exemplo

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)

Testar no 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.

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
`pretty`	query	`boolean`	não	Indent JSON with two spaces; default false.

Respostas

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

Exemplo

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)

Testar no 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.

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
`search`	query	`string`	sim	The term to search for
`type`	query	`string` `wordgrammar_patternphrase`	não	Restrict the answer to one entry type
`limit`	query	`integer`	não	padrão: 10
`page`	query	`integer`	não	padrão: 1
`with_meanings`	query	`boolean`	não	Join the meanings (with translations, synonyms, antonyms) of every item padrão: false
`with_translations`	query	`boolean`	não	Join the short translations of every item padrão: false
`translation_languages`	query	`string[]` `ruesfrdeptzhar`	não	Keep only these translation languages (a repeated key); omit the key for all of them
`datasets`	query	`string[]`	sim	Public dataset names as repeated keys. Groups follow installation order. Each selected dataset costs one unit of the shared public rate budget.

Respostas

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

Exemplo

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)

Testar no playground

GET/api/v1/datasets

Publicly readable datasets and their terms, in installation order

Parâmetros

Sem parâmetros.

Respostas

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

Exemplo

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])

Testar no 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.

Corpo da requisição · `WordsBatchV1ReqDTO`

Nome	Tipo	Obrigatório	Descrição
`words`	`string[]`	sim	Headword spellings, 50 at most, each matched like GET /words/{word} (case-insensitively; an inflected form resolves to its base entry)

Respostas

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

Exemplo

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)

Testar no 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.

Corpo da requisição · `CreateSuggestionV1ReqDTO`

Nome	Tipo	Obrigatório	Descrição
`dataset`	`string`	não	Installed, publicly open dataset containing the headword and all supplied IDs. Omit to use the active dataset.
`headword`	`string`	sim	The headword the report is about; must exist in the dictionary
`word_id`	`object`	não	Id of the entry (part of speech) the report points at, from the word answers
`kind`	`string` `reportedit`	não	padrão: "report"
`message`	`object`	não	What is wrong and, ideally, what would be right. Required for a report; an optional comment on an edit
`edits`	`SuggestionEditV1DTO[]`	não	Edit flow: every touched target of the word form with its proposed values
`author_name`	`object`	não	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`	não	The sender agrees that `author_name` is shown and exported; required when a name is given

Respostas

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

Exemplo

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)

Testar no playground

Esquemas

SuggestionEditV1DTO

Nome	Tipo	Obrigatório	Descrição
`target_type`	`string` `wordmeaningmeaning_translationshort_translation`	sim
`target_id`	`number`	sim	Id of the targeted row, from the word answers
`changes`	`object`	sim	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

Nome	Tipo	Obrigatório	Descrição
`dataset`	`string`	não	Installed, publicly open dataset containing the headword and all supplied IDs. Omit to use the active dataset.
`headword`	`string`	sim	The headword the report is about; must exist in the dictionary
`word_id`	`object`	não	Id of the entry (part of speech) the report points at, from the word answers
`kind`	`string` `reportedit`	não	padrão: "report"
`message`	`object`	não	What is wrong and, ideally, what would be right. Required for a report; an optional comment on an edit
`edits`	`SuggestionEditV1DTO[]`	não	Edit flow: every touched target of the word form with its proposed values
`author_name`	`object`	não	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`	não	The sender agrees that `author_name` is shown and exported; required when a name is given

WordsBatchV1ReqDTO

Nome	Tipo	Obrigatório	Descrição
`words`	`string[]`	sim	Headword spellings, 50 at most, each matched like GET /words/{word} (case-insensitively; an inflected form resolves to its base entry)

PublicSearchV1MetaT

Nome	Tipo	Obrigatório	Descrição
`dataset`	`string`	não	Present only for an explicitly selected dataset.
`count`	`integer`	sim
`fuzzy`	`boolean`	sim
`short_term`	`boolean`	sim

PublicSearchV1ResT

Nome	Tipo	Obrigatório	Descrição
`data`	`PublicSearchWordV1T[]`	sim
`meta`	`PublicSearchV1MetaT`	sim

PublicSearchWordV1T

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

OriginT

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

OriginLicenseT

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

Nome	Tipo	Obrigatório	Descrição
`spdx`	`string`	não
`name`	`string`	sim
`url`	`string`	sim
`text`	`string`	não	Required for custom licenses; preserved verbatim when supplied.

OriginAcquisitionT

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

Nome	Tipo	Obrigatório	Descrição
`id`	`string`	sim
`method`	`string` `copyfork`	sim
`recorded_at`	`string \| null`	sim
`revision`	`string`	não
`via`	`object`	não	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.

Nome	Tipo	Obrigatório	Descrição
`origin_id`	`string`	sim
`spdx`	`string`	não
`name`	`string`	sim
`url`	`string`	sim
`text`	`string`	não	Required for custom licenses; preserved verbatim when supplied.

EnPartOfSpeechE

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

EnWordFormsE

Um de: 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

Um de: A1, A2, B1, B2, C1, C2

EnAreaVariantsE

Um de: common, british, american, australian

CategoryE

Um de: scientific, technical, medical, legal, business, IT, art, political, sport, culinary

LanguageRegisterE

Um de: formal, informal, slang

PronunciationT

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

Nome	Tipo	Obrigatório	Descrição
`audio`	`PronunciationAudioT[]`	não	Recordings carry their own terms, independent of the word's text.
`type`	`string` `ipaenpr`	sim
`text`	`string \| null`	sim
`area_variant`	`EnAreaVariantsE`	sim
`sort_order`	`integer`	sim

PronunciationAudioT

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

Nome	Tipo	Obrigatório
`url`	`string`	sim
`source_url`	`string \| null`	não
`attribution`	`string \| null`	não
`licenses`	`OriginLicenseT[]`	sim
`sort_order`	`integer`	sim

EnVerbTransitivityE

Um de: transitive, intransitive, both

EnPhrasalObjectPatternE

Um de: no_object, inseparable, separable, separable_pronoun_only

PublicWordV1FormT

Nome	Tipo	Obrigatório	Descrição
`alternatives`	`string[]`	não
`id`	`integer`	sim
`word`	`string`	sim
`form_of_word`	`EnWordFormsE`	sim
`area_variant`	`EnAreaVariantsE`	sim
`transcription`	`string \| null`	sim
`pronunciations`	`PronunciationT[]`	não	Ordered pronunciations, with legacy transcription and base-form fallback.

PublicSearchDetailedV1MetaT

Nome	Tipo	Obrigatório	Descrição
`dataset`	`string`	não	Present only for an explicitly selected dataset.
`page`	`integer`	sim
`limit`	`integer`	sim
`has_more`	`boolean`	sim
`fuzzy`	`boolean`	sim
`short_term`	`boolean`	sim

PublicSearchDetailedV1ResT

Nome	Tipo	Obrigatório	Descrição
`data`	`PublicWordV1T[]`	sim
`meta`	`PublicSearchDetailedV1MetaT`	sim

PublicWordV1T

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

PublicWordV1MeaningT

Nome	Tipo	Obrigatório	Descrição
`etymology_number`	`integer \| null`	não	Local number of the owning word etymology; null when unknown.
`id`	`integer`	sim
`sort_order`	`integer`	sim
`title`	`string`	sim
`definition`	`string`	sim
`is_obsolete`	`boolean`	sim
`examples`	`string[]`	sim
`quotes`	`MeaningQuoteT[]`	não
`categories`	`CategoryE[]`	sim
`meaning_level`	`WordLevelE \| null`	sim
`area_variant`	`EnAreaVariantsE`	sim
`language_register`	`LanguageRegisterE \| null`	sim
`translations`	`PublicWordV1MeaningTranslationT[]`	sim
`synonyms`	`string[]`	sim
`antonyms`	`string[]`	sim

MeaningQuoteT

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

Nome	Tipo	Obrigatório
`text`	`string`	sim
`reference`	`string \| null`	sim
`source_url`	`string \| null`	não

PublicWordV1MeaningTranslationT

Nome	Tipo	Obrigatório
`id`	`integer`	sim
`language`	`AvailableTranslationLanguagesE`	sim
`title`	`string`	sim
`definition`	`string`	sim
`variants_of_words`	`string[]`	sim

AvailableTranslationLanguagesE

Um de: ru, es, fr, de, pt, zh, ar

PublicWordV1ShortTranslationT

Nome	Tipo	Obrigatório
`id`	`integer`	sim
`language`	`AvailableTranslationLanguagesE`	sim
`description`	`string`	sim
`variants_of_words`	`string[]`	sim

PublicWordV1ResT

Nome	Tipo	Obrigatório	Descrição
`data`	`PublicWordV1T`	sim

PublicHeadwordV1MetaT

Nome	Tipo	Obrigatório
`word`	`string`	sim
`count`	`integer`	sim
`variants`	`string[]`	não

PublicHeadwordV1ResT

Nome	Tipo	Obrigatório	Descrição
`data`	`PublicWordV1T[]`	sim
`meta`	`PublicHeadwordV1MetaT`	sim

PublicMeaningV1T

Nome	Tipo	Obrigatório	Descrição
`origins`	`OriginT[]`	não
`contributions`	`OriginT[]`	não
`licenses`	`WordLicenseT[]`	não
`word_id`	`integer`	sim
`part_of_speech`	`EnPartOfSpeechE`	sim
`source`	`string`	não
`modified`	`boolean`	não
`etymology_number`	`integer \| null`	não	Local number of the owning word etymology; null when unknown.
`id`	`integer`	sim
`sort_order`	`integer`	sim
`title`	`string`	sim
`definition`	`string`	sim
`is_obsolete`	`boolean`	sim
`examples`	`string[]`	sim
`quotes`	`MeaningQuoteT[]`	não
`categories`	`CategoryE[]`	sim
`meaning_level`	`WordLevelE \| null`	sim
`area_variant`	`EnAreaVariantsE`	sim
`language_register`	`LanguageRegisterE \| null`	sim
`translations`	`PublicWordV1MeaningTranslationT[]`	sim
`synonyms`	`string[]`	sim
`antonyms`	`string[]`	sim

PublicHeadwordMeaningsV1ResT

Nome	Tipo	Obrigatório	Descrição
`data`	`PublicMeaningV1T[]`	sim
`meta`	`PublicHeadwordV1MetaT`	sim

PublicWordFormV1T

Nome	Tipo	Obrigatório	Descrição
`origins`	`OriginT[]`	não
`contributions`	`OriginT[]`	não
`licenses`	`WordLicenseT[]`	não
`word_id`	`integer`	sim
`part_of_speech`	`EnPartOfSpeechE`	sim
`source`	`string`	não
`modified`	`boolean`	não
`alternatives`	`string[]`	não
`id`	`integer`	sim
`word`	`string`	sim
`form_of_word`	`EnWordFormsE`	sim
`area_variant`	`EnAreaVariantsE`	sim
`transcription`	`string \| null`	sim
`pronunciations`	`PronunciationT[]`	não	Ordered pronunciations, with legacy transcription and base-form fallback.

PublicHeadwordFormsV1ResT

Nome	Tipo	Obrigatório	Descrição
`data`	`PublicWordFormV1T[]`	sim
`meta`	`PublicHeadwordV1MetaT`	sim

PublicShortTranslationV1T

Nome	Tipo	Obrigatório
`origins`	`OriginT[]`	não
`contributions`	`OriginT[]`	não
`licenses`	`WordLicenseT[]`	não
`word_id`	`integer`	sim
`part_of_speech`	`EnPartOfSpeechE`	sim
`source`	`string`	não
`modified`	`boolean`	não
`id`	`integer`	sim
`language`	`AvailableTranslationLanguagesE`	sim
`description`	`string`	sim
`variants_of_words`	`string[]`	sim

PublicMeaningTranslationV1T

Nome	Tipo	Obrigatório
`meaning_id`	`integer`	sim
`origins`	`OriginT[]`	não
`contributions`	`OriginT[]`	não
`licenses`	`WordLicenseT[]`	não
`word_id`	`integer`	sim
`part_of_speech`	`EnPartOfSpeechE`	sim
`source`	`string`	não
`modified`	`boolean`	não
`id`	`integer`	sim
`language`	`AvailableTranslationLanguagesE`	sim
`title`	`string`	sim
`definition`	`string`	sim
`variants_of_words`	`string[]`	sim

PublicWordLinkV1T

Nome	Tipo	Obrigatório
`meaning_id`	`integer`	sim
`word`	`string`	sim
`origins`	`OriginT[]`	não
`contributions`	`OriginT[]`	não
`licenses`	`WordLicenseT[]`	não
`word_id`	`integer`	sim
`part_of_speech`	`EnPartOfSpeechE`	sim
`source`	`string`	não
`modified`	`boolean`	não

PublicHeadwordLinksV1ResT

Nome	Tipo	Obrigatório	Descrição
`data`	`PublicWordLinkV1T[]`	sim
`meta`	`PublicHeadwordV1MetaT`	sim

PublicChangeV1T

Nome	Tipo	Obrigatório	Descrição
`inherited_from`	`OriginT \| null`	não
`contribution`	`OriginT \| null`	não	Terms captured when this edit was made, independent of later dataset changes.
`reason`	`string \| null`	não
`created_at`	`string`	sim
`word`	`string`	sim
`part_of_speech`	`string \| null`	sim
`entity`	`ChangeEntityE`	sim
`action`	`ChangeActionE`	sim
`record`	`ChangeRecordT \| null`	sim
`diff`	`ChangeDiffT`	sim
`origin`	`ChangeOriginE`	sim
`author`	`string \| null`	sim
`source`	`string`	não

ChangeEntityE

What was edited

Um de: word, word_form, meaning, meaning_translation, short_translation

ChangeActionE

Um de: 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.

Nome	Tipo	Obrigatório	Descrição

ChangeFormRecordT

Nome	Tipo	Obrigatório	Descrição
`word`	`string`	sim
`form_of_word`	`string`	sim

ChangeMeaningRecordT

Nome	Tipo	Obrigatório	Descrição
`title`	`string`	sim
`sort_order`	`integer`	sim

ChangeTranslationRecordT

Nome	Tipo	Obrigatório
`meaning`	`ChangeMeaningRecordT`	sim
`language`	`string`	sim
`title`	`string`	sim

ChangeShortTranslationRecordT

Nome	Tipo	Obrigatório	Descrição
`language`	`string`	sim
`description`	`string`	sim

ChangeDiffT

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

Nome	Tipo	Obrigatório	Descrição

ChangeOriginE

Where an edit came from

Um de: admin, suggestion, revert

PublicHeadwordHistoryV1MetaT

Nome	Tipo	Obrigatório
`word`	`string`	sim
`count`	`integer`	sim
`variants`	`string[]`	não

PublicHeadwordHistoryV1ResT

Nome	Tipo	Obrigatório	Descrição
`data`	`PublicChangeV1T[]`	sim
`meta`	`PublicHeadwordHistoryV1MetaT`	sim

PublicDatasetTermsV1T

Nome	Tipo	Obrigatório
`origins`	`OriginT[]`	não
`licenses`	`WordLicenseT[]`	não
`description`	`string \| null`	não
`dataset`	`string`	sim
`title`	`string`	não
`active`	`boolean`	sim
`source`	`string`	sim
`dataset_version`	`string \| null`	sim
`license`	`string`	sim
`license_url`	`string`	sim
`attribution`	`string`	sim
`attribution_url`	`string \| null`	sim
`notice`	`string`	sim
`license_text`	`string`	sim

PublicWordDatasetV1T

Nome	Tipo	Obrigatório
`word`	`string`	sim
`variants`	`string[]`	sim
`count`	`integer`	sim
`entries`	`PublicWordV1T[]`	sim
`origins`	`OriginT[]`	não
`licenses`	`WordLicenseT[]`	não
`description`	`string \| null`	não
`dataset`	`string`	sim
`title`	`string`	não
`active`	`boolean`	sim
`source`	`string`	sim
`dataset_version`	`string \| null`	sim
`license`	`string`	sim
`license_url`	`string`	sim
`attribution`	`string`	sim
`attribution_url`	`string \| null`	sim
`notice`	`string`	sim
`license_text`	`string`	sim

PublicWordDatasetsV1MetaT

Nome	Tipo	Obrigatório
`word`	`string`	sim
`datasets`	`integer`	sim
`found`	`integer`	sim

PublicWordDatasetsV1ResT

Nome	Tipo	Obrigatório	Descrição
`data`	`PublicWordDatasetV1T[]`	sim
`meta`	`PublicWordDatasetsV1MetaT`	sim

PublicHeadwordTranslationsV1T

Nome	Tipo	Obrigatório	Descrição
`short_translations`	`PublicShortTranslationV1T[]`	sim
`meaning_translations`	`PublicMeaningTranslationV1T[]`	sim

PublicHeadwordTranslationsV1ResT

Nome	Tipo	Obrigatório	Descrição
`meta`	`PublicHeadwordV1MetaT`	sim
`data`	`PublicHeadwordTranslationsV1T`	sim

PublicWordsBatchItemV1T

Nome	Tipo	Obrigatório
`word`	`string`	sim
`count`	`integer`	sim
`entries`	`PublicWordV1T[]`	sim

PublicWordsBatchV1MetaT

Nome	Tipo	Obrigatório	Descrição
`count`	`integer`	sim
`not_found`	`string[]`	sim

PublicWordsBatchV1ResT

Nome	Tipo	Obrigatório	Descrição
`data`	`PublicWordsBatchItemV1T[]`	sim
`meta`	`PublicWordsBatchV1MetaT`	sim

PublicWordsV1MetaT

Nome	Tipo	Obrigatório
`limit`	`integer`	sim
`has_more`	`boolean`	sim
`next_cursor`	`string \| null`	sim

PublicWordsV1ResT

Nome	Tipo	Obrigatório	Descrição
`data`	`PublicWordV1T[]`	sim
`meta`	`PublicWordsV1MetaT`	sim

PublicDatasetCountsV1T

Nome	Tipo	Obrigatório
`entries`	`integer`	sim
`words`	`integer`	sim
`phrases`	`integer`	sim
`grammar_patterns`	`integer`	sim
`word_forms`	`integer`	sim
`meanings`	`integer`	sim
`meaning_translations`	`integer`	sim
`short_translations`	`integer`	sim

PublicMetaV1T

Nome	Tipo	Obrigatório
`origins`	`OriginT[]`	não
`licenses`	`WordLicenseT[]`	não
`description`	`string \| null`	não
`api_version`	`string`	sim
`app_version`	`string`	sim
`dataset_version`	`string \| null`	sim
`license`	`string`	sim
`license_url`	`string`	sim
`attribution`	`string`	sim
`notice`	`string`	sim
`dataset`	`string`	não
`title`	`string`	não
`source`	`string`	não
`attribution_url`	`string \| null`	não
`license_text`	`string`	não
`modified_entries`	`integer`	não
`counts`	`PublicDatasetCountsV1T`	sim
`available_languages`	`PublicAvailableLanguagesV1T`	sim

PublicAvailableLanguagesV1T

Nome	Tipo	Obrigatório	Descrição
`source`	`string[]`	sim
`translations`	`AvailableTranslationLanguagesE[]`	sim

PublicMetaV1ResT

Nome	Tipo	Obrigatório	Descrição
`data`	`PublicMetaV1T`	sim

PublicSuggestionCreatedV1T

Nome	Tipo	Obrigatório	Descrição
`id`	`integer`	sim
`status`	`string`	sim

PublicSuggestionCreatedV1ResT

Nome	Tipo	Obrigatório	Descrição
`data`	`PublicSuggestionCreatedV1T`	sim

PublicApiErrorT

Nome	Tipo	Obrigatório
`statusCode`	`number`	sim
`message`	`string`	sim
`error`	`boolean`	sim

DictionaryApiV1DatasetsResT

Nome	Tipo	Obrigatório	Descrição
`data`	`object[]`	sim
`meta`	`object`	sim	found counts datasets with entries, including for adapters whose misses are HTTP 200.

DictionaryApiV1ResT

Nome	Tipo	Obrigatório	Descrição

DictionaryApiDefinitionT

Nome	Tipo	Obrigatório
`definition`	`string`	sim
`example`	`string`	não
`synonyms`	`string[]`	sim
`antonyms`	`string[]`	sim

DictionaryApiPhoneticT

Nome	Tipo	Obrigatório	Descrição
`text`	`string`	não
`audio`	`string`	sim
`sourceUrl`	`string`	não
`license`	`DictionaryApiLicenseT`	não
`vocabBloom`	`object`	não	Lossless recording terms; the upstream singular license cannot express all of these.

DictionaryApiLicenseT

Nome	Tipo	Obrigatório	Descrição
`name`	`string`	sim
`url`	`string`	sim

DictionaryApiErrorT

Nome	Tipo	Obrigatório
`title`	`string`	sim
`message`	`string`	sim
`resolution`	`string`	sim

DictionaryApiV2DatasetsResT

Nome	Tipo	Obrigatório	Descrição
`data`	`object[]`	sim
`meta`	`object`	sim	found counts datasets with entries, including for adapters whose misses are HTTP 200.

DictionaryApiV2ResT

Nome	Tipo	Obrigatório	Descrição

DictionaryApiMeaningT

Nome	Tipo	Obrigatório
`partOfSpeech`	`string`	sim
`definitions`	`DictionaryApiDefinitionT[]`	sim
`synonyms`	`string[]`	sim
`antonyms`	`string[]`	sim

FreeDictionaryDatasetsResT

Nome	Tipo	Obrigatório	Descrição
`data`	`object[]`	sim
`meta`	`object`	sim	found counts datasets with entries, including for adapters whose misses are HTTP 200.

FreeDictionaryEntriesResT

Nome	Tipo	Obrigatório	Descrição
`word`	`string`	sim
`entries`	`FreeDictionaryEntryT[]`	sim
`source`	`object`	sim
`vocabBloom`	`PublicDatasetTermsV1T`	sim	Terms of the dataset read. Word-specific origins are retained on each entry.

FreeDictionaryEntryT

Nome	Tipo	Obrigatório	Descrição
`language`	`FreeDictionaryLanguageT`	sim
`partOfSpeech`	`string`	sim
`pronunciations`	`object[]`	sim
`forms`	`object[]`	sim
`senses`	`FreeDictionarySenseT[]`	sim
`synonyms`	`string[]`	sim
`antonyms`	`string[]`	sim
`vocabBloom`	`object`	sim	Native entry identity and lossless terms; additive to the upstream format.

FreeDictionaryLanguageT

Nome	Tipo	Obrigatório	Descrição
`code`	`string`	sim
`name`	`string`	sim

FreeDictionarySenseT

Nome	Tipo	Obrigatório
`definition`	`string`	sim
`tags`	`string[]`	sim
`examples`	`string[]`	sim
`quotes`	`object[]`	sim
`synonyms`	`string[]`	sim
`antonyms`	`string[]`	sim
`translations`	`object[]`	não
`subsenses`	`FreeDictionarySenseT[]`	sim

FreeDictionaryErrorT

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

Nome	Tipo	Obrigatório	Descrição

FreeDictionaryLanguagesResT

Nome	Tipo	Obrigatório	Descrição

PublicDatasetsV1ResT

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

Nome	Tipo	Obrigatório	Descrição
`data`	`PublicDatasetTermsV1T[]`	sim
`meta`	`object`	sim

PublicSearchDatasetResultV1T

Nome	Tipo	Obrigatório
`status`	`string` `ok`	sim
`data`	`PublicWordV1T[]`	sim
`meta`	`PublicSearchDetailedV1MetaT`	sim
`origins`	`OriginT[]`	não
`licenses`	`WordLicenseT[]`	não
`description`	`string \| null`	não
`dataset`	`string`	sim
`title`	`string`	não
`active`	`boolean`	sim
`source`	`string`	sim
`dataset_version`	`string \| null`	sim
`license`	`string`	sim
`license_url`	`string`	sim
`attribution`	`string`	sim
`attribution_url`	`string \| null`	sim
`notice`	`string`	sim
`license_text`	`string`	sim

PublicSearchDatasetUnavailableV1T

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

Nome	Tipo	Obrigatório
`status`	`string` `unavailable`	sim
`error`	`string` `dataset_unavailable`	sim
`origins`	`OriginT[]`	não
`licenses`	`WordLicenseT[]`	não
`description`	`string \| null`	não
`dataset`	`string`	sim
`title`	`string`	não
`active`	`boolean`	sim
`source`	`string`	sim
`dataset_version`	`string \| null`	sim
`license`	`string`	sim
`license_url`	`string`	sim
`attribution`	`string`	sim
`attribution_url`	`string \| null`	sim
`notice`	`string`	sim
`license_text`	`string`	sim

PublicSearchDatasetV1T

Nome	Tipo	Obrigatório	Descrição

PublicSearchDatasetsV1ResT

Nome	Tipo	Obrigatório	Descrição
`data`	`PublicSearchDatasetV1T[]`	sim
`meta`	`object`	sim

PublicSemanticMatchV1T

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

Nome	Tipo	Obrigatório	Descrição
`word`	`PublicSearchWordV1T`	sim
`meaning`	`object`	sim
`score`	`number`	sim	Cosine similarity from -1 to 1; no calibrated no-answer threshold.

PublicSemanticSearchV1ResT

Nome	Tipo	Obrigatório	Descrição
`data`	`PublicSemanticMatchV1T[]`	sim
`meta`	`object`	sim

PublicSemanticStatusV1ResT

Nome	Tipo	Obrigatório	Descrição
`data`	`object`	sim