Search Synonyms
openthesaurus.search_synonyms
ActionBusiness appsconnection required
Calls the OpenThesaurus API with the connection's credentials.
Look up the German synonym groups for a word.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- No auth
- Providers
- OpenThesaurus
- Secret shape
- no credential — OpenThesaurus' API is public; the connection is a contact and a host
- Config it needs
- contact, base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
4 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
term The German word to look up, as a single term rather than a sentence. | string | Yes | — | — | Test |
supersynsets Also return each group's hypernyms, the broader terms above it. | boolean | No | false | — | — |
subsynsets Also return each group's hyponyms, the narrower terms below it. | boolean | No | false | — | — |
baseform Also return the word's base form when the term given is an inflected one, such as 'Auto' for 'Autos'. | boolean | No | false | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"baseform": false,
"subsynsets": false,
"supersynsets": false,
"term": "Test"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
term The term that was looked up. | string | — |
found False when OpenThesaurus holds no synonym group for the term; branch on this rather than on an empty list. | boolean | — |
synonyms Every synonym across every group, in order, without repeats and without the term itself — the list most workflows want. | array | — |
synset_count How many distinct synonym groups matched. | number | — |
synsets One entry per synonym group OpenThesaurus returned. | array | — |
synsets[].id OpenThesaurus' own identifier for the group. | number | — |
synsets[].categories The subject categories the group is filed under, when it has any. | array | — |
synsets[].terms The words in this group, as plain strings. | array | — |
synsets[].supersynsets Broader terms above this group; empty unless 'supersynsets' was set. | array | — |
synsets[].subsynsets Narrower terms below this group; empty unless 'subsynsets' was set. | array | — |
baseforms The base form of an inflected term; empty unless 'baseform' was set or the term already is a base form. | array | — |
meta.api_version The API version OpenThesaurus reported. | string | — |
meta.source The service the entries came from. | string | — |
meta.license The licence the returned entries are published under. | string | — |
meta.date When OpenThesaurus generated the response. | string | — |
{
"baseforms": [],
"found": false,
"meta": {
"api_version": "",
"date": "",
"license": "",
"source": ""
},
"synonyms": [],
"synset_count": 0,
"synsets": [
{
"categories": [],
"id": 0,
"subsynsets": [],
"supersynsets": [],
"terms": []
}
],
"term": ""
}Notes
- OpenThesaurus is a German thesaurus; the term and every result are German.
- OpenThesaurus' API is public: the connection carries no credential and nothing is sent as authentication. It carries the contact address OpenThesaurus requires in the User-Agent header of every request.
- OpenThesaurus allows 60 requests per minute from one IP address and answers with an error beyond that; nothing here retries, so pace a loop that looks up many words.
Related OpenThesaurus nodes
See Search Synonyms run in a workflow.
In a technical demo we add the OpenThesaurus connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.