Skip to main content
POST
Create a key (write)

Authorizations

Authorization
string
header
required

API token: tsu_pat_… (PAT) or tsu_proj_… (project token). The token's granted RBAC permissions determine access; see each operation's x-permission.

Path Parameters

projectId
string
required

Project id (UUID) or id-embedded path slug.

Query Parameters

branch
string

Target an open translation branch instead of main. Required when the project's main branch is protected.

Body

application/json
key
string
required

Lookup identifier. Segments (split on the project separator) may contain only letters, digits, _ and -.

Required string length: 1 - 500
Example:

"home.hero.title"

description
string

Optional translator-facing context for the key.

Maximum string length: 1000
Example:

"Headline shown on the landing page hero."

tags
string[]

Up to 20 labels for filtering and organizing keys.

Maximum array length: 20
Maximum string length: 50
Example:
isPlural
boolean

Set true to make this a plural key (values are keyed by CLDR plural form).

values
object

Optional initial values, keyed by language code. Singular: { "fr": "…" }; plural: { "fr": { "one": "…", "other": "…" } }.

Example:

Response

The created key's metadata.

success
boolean
required
data
object
required