Search the covered vocabulary

GET/v1/words

Lists catalogue words with the number of clips indexed for each. Use it to check coverage before integrating, or to power an autocomplete over words that will actually return clips.

Parameters

Name	In	Type	Default	Required	Description
q	query	string		no	Prefix or substring to search for. Omit to list by coverage.
language	query	string	en	no	Language of the clips, as a two-letter code. Only languages listed by /corpus return results.
gloss	query	en | es | ja | pt | ru | tr | zh	en	no	Language for word meanings in the response. Falls back to English when a meaning is missing in the requested language.
level	query	string		no	Restrict to these CEFR levels, comma separated. Omit for all levels.
hasClips	query	boolean	true	no	Restrict to words with at least one clip.
limit	query	integer	20	no	Items per page.
cursor	query	string		no	The nextCursor of the previous page. Opaque; do not construct it yourself.

Response

Field	Type	Description
words	object[]
words[].word	string
words[].wordId	integer
words[].level	A1 | A2 | B1 | B2 | C1 | C2	CEFR level assigned during screening.
words[].meaning	string	Meaning in the requested gloss language.
words[].clipCount	integer
totalCount	integer
nextCursor	string

Errors

Status	Code	When
401	invalid_key	The key is missing, unknown or disabled.
429	rate_limited	Too many requests, or the plan quota is spent. Retry-After carries the wait in seconds.

Example

curl https://clips.vocaflare.com/v1/words \
  -H "Authorization: Bearer $VOCAFLARE_API_KEY"

{
  "words": [
    {
      "word": "receive",
      "wordId": 4127,
      "level": "B1",
      "meaning": "almak",
      "clipCount": 9
    },
    {
      "word": "recipe",
      "wordId": 4130,
      "level": "A2",
      "meaning": "tarif",
      "clipCount": 4
    }
  ],
  "totalCount": 2758,
  "nextCursor": "eyJvIjoyMH0"
}