v3

latestOpenAPI 3.0.02026-08-081996601.2 MB

Glossaries

Upsert glossary entries

Upserts entries into a glossary in bulk. Entries with existing terms are updated. New terms are inserted. The platform rebuilds the glossary index after the upsert. Agents use the updated glossary after the rebuild completes.

post/v2/glossaries/{glossary_key}/entries

Path parameters

glossary_keystring required

A user-provided key that uniquely identifies a glossary.

Example:eng-acronyms

The unique key of the glossary.

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Request body

entriesobject required

A map of terms to their expanded forms. Keys are terms (1–200 characters); values are expansions (1–1000 characters).

Example request

{
  "entries": {
    "k8s": "Kubernetes",
    "tf": "Terraform"
  }
}

Response

The entries are upserted. The index rebuild completes asynchronously.