Glossary

Extract glossary candidates

Ask Glossa to propose terms from the project's source strings.

POST
/v1/glossary/extract

Ask Glossa to propose terms from the project's source strings. Each run looks only at source strings changed since the previous run. Candidates arrive as pending terms; list them with GET /v1/glossary?status=pending. Needs the Team plan or higher. Extractions are capped per cycle; past the cap the answer is 429 extract-cap-reached with the date it resets.

Authorization

deployToken
headerAuthorizationBearer <token>

A project deploy token, minted in the console under Settings, Developer, API tokens. Send the whole value, including the numeric prefix before the |. A token carries a set of abilities (push, pull, manage, read, write) and each operation requires one of them. Tokens do not inherit from each other: a manage token cannot read the glossary unless it also has read.

Response Body

The extraction was queued.

application/json
  1. response
chunks?integer

Groups of strings queued for extraction.

candidates?integer

Candidate terms sent for review.

curl -X POST 'https://api.transglot.ai/v1/glossary/extract'
{  "chunks": 4,  "candidates": 380}