<!-- Source: https://docs.geopera.com/api-reference/operations/glossary · Markdown for LLMs -->

<!-- AUTO-GENERATED by scripts/generate-api-reference.cjs from the committed OpenAPI spec. Do not edit by hand. -->

# Glossary operations

Reference glossary and collections metadata.

Each operation below is reachable at `POST /v1/op/{operation_id}` or the resource path `POST /v1/{resource}/{action}`, with a Bearer token (a `gpra_` API key or a session token). Back to the [Operations Reference](/api-reference/operations) index.

## `glossary.collections.get`

Get a single catalog collection by name.

| | |
|---|---|
| **Scope** | `catalog:read` |
| **Side-effect** | read |
| **HTTP** | `POST /v1/op/glossary.collections.get`  ·  `POST /v1/glossary/collections/get` |
| **Python / TypeScript** | `client.glossary.collections.get(…)` |
| **CLI** | `geopera glossary collections get …` |

**Request** — `CollectionGetInput`

| Field | Type | Required | Description |
|---|---|---|---|
| `collection_name` | string | yes |  |

**Response** — a streaming or binary payload (NDJSON / file / tile). Call the HTTP endpoint directly; the JSON SDK return does not apply.

## `glossary.collections.list`

List catalog collections (provider-compatible, paged).

| | |
|---|---|
| **Scope** | `catalog:read` |
| **Side-effect** | read |
| **HTTP** | `POST /v1/op/glossary.collections.list`  ·  `POST /v1/glossary/collections/list` |
| **Python / TypeScript** | `client.glossary.collections.list(…)` |
| **CLI** | `geopera glossary collections list …` |

**Request** — `src__operations__glossary__reads__CollectionsListInput`

| Field | Type | Required | Description |
|---|---|---|---|
| `integrations` | string | — |  |
| `type` | string | — |  |
| `page` | integer | — |  |
| `size` | integer | — |  |
| `sort` | string | — |  |

**Response** — a streaming or binary payload (NDJSON / file / tile). Call the HTTP endpoint directly; the JSON SDK return does not apply.

## `glossary.data_products.get`

Get a single catalog data product by name.

| | |
|---|---|
| **Scope** | `catalog:read` |
| **Side-effect** | read |
| **HTTP** | `POST /v1/op/glossary.data_products.get`  ·  `POST /v1/glossary/data_products/get` |
| **Python / TypeScript** | `client.glossary.data_products.get(…)` |
| **CLI** | `geopera glossary data-products get …` |

**Request** — `DataProductGetInput`

| Field | Type | Required | Description |
|---|---|---|---|
| `data_product_name` | string | yes |  |

**Response** — a streaming or binary payload (NDJSON / file / tile). Call the HTTP endpoint directly; the JSON SDK return does not apply.

## `glossary.data_products.list`

List catalog data products (provider-compatible, paged).

| | |
|---|---|
| **Scope** | `catalog:read` |
| **Side-effect** | read |
| **HTTP** | `POST /v1/op/glossary.data_products.list`  ·  `POST /v1/glossary/data_products/list` |
| **Python / TypeScript** | `client.glossary.data_products.list(…)` |
| **CLI** | `geopera glossary data-products list …` |

**Request** — `DataProductsListInput`

| Field | Type | Required | Description |
|---|---|---|---|
| `dataProductId` | string | — |  |
| `page` | integer | — |  |
| `size` | integer | — |  |
| `sort` | string | — |  |

**Response** — a streaming or binary payload (NDJSON / file / tile). Call the HTTP endpoint directly; the JSON SDK return does not apply.

## `glossary.providers.get`

Get a single catalog provider by name.

| | |
|---|---|
| **Scope** | `catalog:read` |
| **Side-effect** | read |
| **HTTP** | `POST /v1/op/glossary.providers.get`  ·  `POST /v1/glossary/providers/get` |
| **Python / TypeScript** | `client.glossary.providers.get(…)` |
| **CLI** | `geopera glossary providers get …` |

**Request** — `ProviderGetInput`

| Field | Type | Required | Description |
|---|---|---|---|
| `provider_name` | string | yes |  |

**Response** — a streaming or binary payload (NDJSON / file / tile). Call the HTTP endpoint directly; the JSON SDK return does not apply.

## `glossary.providers.list`

List catalog providers (PRODUCER/HOST, paged).

| | |
|---|---|
| **Scope** | `catalog:read` |
| **Side-effect** | read |
| **HTTP** | `POST /v1/op/glossary.providers.list`  ·  `POST /v1/glossary/providers/list` |
| **Python / TypeScript** | `client.glossary.providers.list(…)` |
| **CLI** | `geopera glossary providers list …` |

**Request** — `ProvidersListInput`

| Field | Type | Required | Description |
|---|---|---|---|
| `page` | integer | — |  |
| `size` | integer | — |  |
| `sort` | string | — |  |
| `role` | string | — |  |

**Response** — a streaming or binary payload (NDJSON / file / tile). Call the HTTP endpoint directly; the JSON SDK return does not apply.