Console

Start

Platform

App store purchases

Auth

Builds

Database

Flags

Hosting

Jobs and cron

Localization

Monitoring

Network

Notifications

Organizations

Payments

Queues

Events

Realtime

Runners

Sandboxes

Storage

Webhooks

Workflows

Getting Started

Installation

Authentication

AI Services

KV Store

Overview

Webhooks

Deploy & Infrastructure

Reference

On this page

Request
Glossary
ResourceMeta
GlossarySpec
GlossaryTerm
Response
ResourceMeta
GlossarySpec
GlossaryStatus
GlossaryTerm
Condition
Errors
Examples

Reference

Create a glossary

Creates a glossary.

Checked 2026-09-28

Creates a glossary.

Path POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/glossaries
Scope localization:write
Effect write — a successful call changes state.
Collection glossaries
Query glossary_id, validate_only

#Request

Field	Type	What it is
`parent`	`string`	The parent to create in. Required.
`glossary_id`	`string`	The glossary id, the final name segment; the server assigns one when empty.
`glossary`	`Glossary`	The glossary to create; only caller-writable fields are read. Required.
`validate_only`	`bool`	Validate and return the result without writing anything.

#Glossary

Field	Type	What it is
`name`	`string`	`orgs/{org}/projects/{project}/envs/{env}/glossaries/{glossary}`.
`meta`	`ResourceMeta`	Resource metadata.
`spec`	`GlossarySpec`	Desired state. Required.

#ResourceMeta

Field	Type	What it is
`labels`	`map<string, string>`	Caller-writable, indexed labels (AIP-122 label rules).
`annotations`	`map<string, string>`	Caller-writable, unindexed annotations.
`display_name`	`string`	Caller-writable human-readable name.

#GlossarySpec

Field	Type	What it is
`terms`	`GlossaryTerm[]`	The terms; at most 5000.

#GlossaryTerm

Field	Type	What it is
`term`	`string`	The term, as written in the source. Required.
`description`	`string`	A note for translators, at most 500 characters.
`rule`	`TermRule`	What to do with the term. Required. One of `translate`, `keep`, `forbidden`.
`translations`	`map<string, string>`	Locale to the required translation; used by `TERM_RULE_TRANSLATE`.
`replacement`	`string`	Suggested wording; used by `TERM_RULE_FORBIDDEN`.
`locales`	`string[]`	The locales the term applies to; empty is every locale.
`case_sensitive`	`bool`	Match the term's letter case exactly.

#Response

Field	Type	What it is
`name`	`string`	`orgs/{org}/projects/{project}/envs/{env}/glossaries/{glossary}`.
`uid`	`string`	`gls_<cell><ulid>`; never reused. Output only.
`meta`	`ResourceMeta`	Resource metadata.
`spec`	`GlossarySpec`	Desired state. Required.
`status`	`GlossaryStatus`	Observed state. Output only.

#ResourceMeta

Field	Type	What it is
`generation`	`int64`	Increases by one on every change to `spec`. Output only.
`etag`	`string`	Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as `If-Match` or `etag` to make Update and Delete conditional; a mismatch fails with ABORTED / 409 `ETAG_MISMATCH`. Output only.
`create_time`	`timestamp`	When the Resource was created. Output only.
`update_time`	`timestamp`	When the Resource last changed. Output only.
`delete_time`	`timestamp`	Set while the Resource is being deleted. Output only.
`labels`	`map<string, string>`	Caller-writable, indexed labels (AIP-122 label rules).
`annotations`	`map<string, string>`	Caller-writable, unindexed annotations.
`display_name`	`string`	Caller-writable human-readable name.
`creator`	`string`	The principal that created the Resource. Output only.

#GlossarySpec

Field	Type	What it is
`terms`	`GlossaryTerm[]`	The terms; at most 5000.

#GlossaryStatus

Field	Type	What it is
`observed_generation`	`int64`	The generation this status was computed from. Output only.
`conditions`	`Condition[]`	Ready, Reconciling, Stalled. Output only.
`term_count`	`int32`	The number of terms. Output only.

#GlossaryTerm

Field	Type	What it is
`term`	`string`	The term, as written in the source. Required.
`description`	`string`	A note for translators, at most 500 characters.
`rule`	`TermRule`	What to do with the term. Required. One of `translate`, `keep`, `forbidden`.
`translations`	`map<string, string>`	Locale to the required translation; used by `TERM_RULE_TRANSLATE`.
`replacement`	`string`	Suggested wording; used by `TERM_RULE_FORBIDDEN`.
`locales`	`string[]`	The locales the term applies to; empty is every locale.
`case_sensitive`	`bool`	Match the term's letter case exactly.

#Condition

Field	Type	What it is
`type`	`string`	The condition type, for example `Ready`.
`status`	`ConditionStatus`	Whether the condition holds. One of `true`, `false`, `unknown`.
`observed_generation`	`int64`	The generation this observation was made against.
`reason`	`string`	A machine-readable UpperCamelCase reason.
`message`	`string`	A customer-safe human-readable message.
`severity`	`Severity`	How severe a FALSE condition is. One of `info`, `warning`, `error`.
`transition_time`	`timestamp`	When `status` last changed.

#Errors

UNAUTHENTICATED — No valid key or token was presented.
PERMISSION_DENIED — The key lacks the method's permission.
UNKNOWN_FIELD — The request has a field the schema does not know.
INVALID_FIELD — A field failed validation.
RESOURCE_ALREADY_EXISTS — A Resource with this name exists.
IDEMPOTENCY_KEY_REUSED — An Idempotency-Key was reused with another body.
IDEMPOTENCY_IN_PROGRESS — The first call with this Idempotency-Key is still running.
PLAN_LIMIT_REACHED — The plan's limit is reached.

Every error arrives in the body Errors describes.

#Examples

curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/glossaries" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"spec":{}}'

Was this page helpful?

Tell us what is missing, wrong, or unclear — this opens a real inbox.

Send feedback

Platform links