# Collate Glossaries API

**Canonical:** https://apis.io/apis/collate/collate-glossaries-api/  
**Provider:** Collate — https://apis.io/providers/collate/  
**Base URL:** https://sandbox.open-metadata.org/api/v1  
**Documentation:** https://docs.open-metadata.org/latest/api-reference

Collate Glossaries API is one of 107 APIs that [Collate](https://apis.io/providers/collate/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Glossary. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

A `Glossary` is collection of hierarchical `GlossaryTerms`.

## Operations (58)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/glossaries` | List glossaries |
| PUT | `/v1/glossaries` | Create or update a glossary |
| POST | `/v1/glossaries` | Create a glossary |
| GET | `/v1/glossaries/name/{name}` | Get a glossary by name |
| DELETE | `/v1/glossaries/name/{name}` | Delete a glossary by name |
| GET | `/v1/glossaries/{id}` | Get a glossary by Id |
| DELETE | `/v1/glossaries/{id}` | Delete a glossary by Id |
| PATCH | `/v1/glossaries/{id}` | Update a glossary |
| DELETE | `/v1/glossaries/async/{id}` | Asynchronously delete a glossary by Id |
| GET | `/v1/glossaries/name/{name}/export` | Export glossary in CSV format |
| GET | `/v1/glossaries/name/{name}/exportAsync` | Export glossary in CSV format |
| GET | `/v1/glossaries/{id}/context` | Get the AI context for an entity by id |
| GET | `/v1/glossaries/name/{fqn}/context` | Get the AI context for an entity by fully qualified name |
| GET | `/v1/glossaries/documentation/csv` | Get CSV documentation |
| GET | `/v1/glossaries/{id}/versions/{version}` | Get a version of the glossaries |
| PUT | `/v1/glossaries/name/{name}/import` | Import glossary terms from CSV to create, and update glossary terms |
| PUT | `/v1/glossaries/name/{name}/importAsync` | Import glossary in CSV format asynchronously |
| PUT | `/v1/glossaries/name/{name}/importRdf` | Import an OWL/SKOS ontology (RDF) into glossaries |
| GET | `/v1/glossaries/history` | List all entity versions within a time range |
| GET | `/v1/glossaries/{id}/versions` | List glossary versions |
| PATCH | `/v1/glossaries/name/{fqn}` | Update a glossary using name |
| PUT | `/v1/glossaries/restore` | Restore a soft deleted glossary |
| PUT | `/v1/glossaries/{id}/vote` | Update Vote for a Entity |
| POST | `/v1/glossaryTerms/{id}/relations` | Add a typed relation to another glossary term |
| PUT | `/v1/glossaryTerms/{id}/assets/add` | Bulk Add Glossary Term to Assets |
| PUT | `/v1/glossaryTerms/{id}/assets/remove` | Bulk Remove Glossary Term from Assets |
| GET | `/v1/glossaryTerms` | List glossary terms |
| PUT | `/v1/glossaryTerms` | Create or update a glossary term |
| POST | `/v1/glossaryTerms` | Create a glossary term |
| POST | `/v1/glossaryTerms/createMany` | Create multiple glossary terms at once |
| GET | `/v1/glossaryTerms/name/{fqn}` | Get a glossary term by fully qualified name |
| DELETE | `/v1/glossaryTerms/name/{fqn}` | Delete a glossary term by fully qualified name |
| PATCH | `/v1/glossaryTerms/name/{fqn}` | Update a glossary term by name |
| GET | `/v1/glossaryTerms/{id}` | Get a glossary term by Id |
| DELETE | `/v1/glossaryTerms/{id}` | Delete a glossary term by Id |
| PATCH | `/v1/glossaryTerms/{id}` | Update a glossary term |
| DELETE | `/v1/glossaryTerms/async/{id}` | Asynchronously delete a glossary term by Id |
| GET | `/v1/glossaryTerms/name/{fqn}/export` | Export glossary term in CSV format |
| GET | `/v1/glossaryTerms/name/{fqn}/exportAsync` | Export glossary term in CSV format asynchronously |
| GET | `/v1/glossaryTerms/{id}/context` | Get the AI context for an entity by id |
| GET | `/v1/glossaryTerms/name/{fqn}/context` | Get the AI context for an entity by fully qualified name |
| GET | `/v1/glossaryTerms/assets/counts` | Get all glossary terms with their asset counts |
| GET | `/v1/glossaryTerms/byIds` | Get multiple glossary terms by Ids |
| GET | `/v1/glossaryTerms/relationTypes/usage` | Get usage counts for all relation types |
| GET | `/v1/glossaryTerms/{id}/relationsGraph` | Get the relation graph for a glossary term |
| GET | `/v1/glossaryTerms/{id}/versions/{version}` | Get a version of the glossary term |
| PUT | `/v1/glossaryTerms/name/{fqn}/import` | Import glossary terms from CSV |
| PUT | `/v1/glossaryTerms/name/{fqn}/importAsync` | Import glossary term from CSV asynchronously |
| GET | `/v1/glossaryTerms/history` | List all entity versions within a time range |
| GET | `/v1/glossaryTerms/{id}/assets` | List assets tagged with this glossary term |
| GET | `/v1/glossaryTerms/name/{fqn}/assets` | List assets tagged with this glossary term by fully qualified name |
| GET | `/v1/glossaryTerms/{id}/versions` | List glossary term versions |
| PUT | `/v1/glossaryTerms/{id}/moveAsync` | Move a glossary term to a new parent or glossary |
| DELETE | `/v1/glossaryTerms/{id}/relations/{toTermId}` | Remove a relation to another glossary term |
| PUT | `/v1/glossaryTerms/restore` | Restore a soft deleted glossary term |
| GET | `/v1/glossaryTerms/search` | Search glossary terms with pagination |
| PUT | `/v1/glossaryTerms/{id}/vote` | Update Vote for a Entity |
| PUT | `/v1/glossaryTerms/{id}/tags/validate` | Validate Tags Addition to Glossary Term |

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/collate/refs/heads/main/openapi/collate-glossaries-api-openapi.yml
- **Documentation** — https://docs.open-metadata.org/latest/api-reference
- **APIReference** — https://docs.open-metadata.org/latest/api-reference

## Other Collate APIs (12)

- [Collate Activity Stream API](https://apis.io/apis/collate/collate-activity-stream-api/)
- [Collate Agent Executions API](https://apis.io/apis/collate/collate-agent-executions-api/)
- [Collate AI Applications API](https://apis.io/apis/collate/collate-ai-applications-api/)
- [Collate AI Audit Reports API](https://apis.io/apis/collate/collate-ai-audit-reports-api/)
- [Collate AI Context API](https://apis.io/apis/collate/collate-ai-context-api/)
- [Collate AI Framework Controls API](https://apis.io/apis/collate/collate-ai-framework-controls-api/)
- [Collate AI Governance API](https://apis.io/apis/collate/collate-ai-governance-api/)
- [Collate AI Governance Frameworks API](https://apis.io/apis/collate/collate-ai-governance-frameworks-api/)
- [Collate AI Governance Policies API](https://apis.io/apis/collate/collate-ai-governance-policies-api/)
- [Collate Announcements API](https://apis.io/apis/collate/collate-announcements-api/)
- [Collate API Collections API](https://apis.io/apis/collate/collate-api-collections-api/)
- [Collate API Endpoint API](https://apis.io/apis/collate/collate-api-endpoint-api/)

## Tags

Glossary

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/collate/collate-glossaries-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/collate/.