Create a key

Creates a key in the selected file together with its fresh shared segment and ordered source variants. Project text creation automations run once per source variant; source and target statuses follow the project's status automations for a created text, falling back to NEW when none matches. Identical existing content is not linked automatically. Optional Idempotency-Key supports replay. Single-language CSV independent cell creation is not supported; import a complete CSV file. Requires stack-level segment management permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^rc_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Public identifier of the file.

Body Params

Request body to create a key in a file, together with its fresh shared segment and ordered source variants.

string
required
length between 1 and 65536

Explicit nonblank key. Uses the file format's editable-key grammar and project normalization. At most 128 nested components; the reserved separator is not accepted.

string | null

Separate group for REQUIRED_KEY_WITH_GROUP formats only. Omission or null means no group; other formats reject non-null values.

boolean
required

Whether the source variants use plural forms. Must be supported by the file format; singular keys accept OTHER forms only.

source_variants
array of objects
required
length between 0 and 1000

Ordered source variants. Empty creates an empty source; repeated device/plural combinations keep their order. Project creation automations run once per variant. Total submitted content is limited to 1,048,576 UTF-16 code units.

source_variants*
label_ids
array of strings | null, unique

Existing labels in this workspace. Omission, null or an empty array supplies no explicit labels; creation automations may add labels. At most 150 distinct identities.

label_ids
string | null

Context for AI translation. Omission or null means no context.

Headers
string
length between 1 and 255

Optional unique key for best-effort POST retry protection. Redis reserves the key, the request runs with ordinary service transactions, then the successful response is cached separately for 24 hours by default. There is no request-wide transaction or atomic commit between the operation and its replay result. A matching cached response is replayed verbatim with Idempotent-Replayed: true. Redis loss/eviction or retention expiry can remove protection and allow re-execution. Uploads and chunked bodies are covered; multipart boundaries and JSON property order may differ. Retries still pass validation and current authorization; a later 403/404 does not undo the original operation. A changed payload returns 422 idempotency_key_mismatch. A recent active reservation returns 409 idempotency_key_in_use with Retry-After. A retry with an unresolved key, including an unfinished reservation older than 5 minutes, returns 409 idempotency_outcome_unknown without Retry-After. This timeout does not release the reservation or permit re-execution while it is retained. Inspect the affected resource before starting a new operation; do not blindly reuse an unresolved key after expiry. A 4xx rejection releases the reservation, allowing the same key to be retried after correcting the cause. A 5xx or interruption after execution starts leaves it unresolved. An unavailable reservation store returns 503 before execution; an oversized request returns 413. Cache-save failure or a response over the cache limit preserves the original success status, headers and body; only future retries become unresolved. When idempotency is explicitly disabled by server configuration, the header is ignored and requests execute normally without retry protection. Use a new unique key for each intended operation.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json