{"components":{"headers":{"Cache-Control":{"description":"The one-time response must not be stored by HTTP caches.","schema":{"enum":["no-store"],"type":"string"}},"ETag":{"description":"Opaque strong validator for this representation. Keep its quotation marks and use it as If-Match on a documented conditional write. A replay carries the original ETag, which may now be stale.","schema":{"type":"string"}},"Idempotent-Replayed":{"description":"True when the original successful result was replayed for this key.","schema":{"type":"boolean"}},"Location":{"description":"URL of the import to poll.","schema":{"type":"string"},"style":"simple"},"RateLimit":{"description":"State of the rate-limit policy currently closest to rejection (IETF draft-ietf-httpapi-ratelimit-headers): the quoted policy name with `r` = requests remaining right now and `t` = seconds until the full quota is available again. Example: `\"api-key\";r=42;t=7`. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.","schema":{"type":"string"}},"RateLimit-Policy":{"description":"The rate-limit policies applied to the request: each quoted policy name with `q` = sustained request quota per window of `w` seconds. Example: `\"api-key\";q=180;w=60, \"workspace\";q=600;w=60`. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"format":"int32","type":"integer"}}},"responses":{"BadRequest":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The request is malformed: an unknown or invalid query parameter, an invalid id in the path, or a body that is not valid JSON. `code` names the problem, `errors` the parameter or field.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"ContentTooLarge":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The request exceeds the body or upload limit; no operation was performed.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"Forbidden":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Insufficient permissions.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"InternalServerError":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"An unexpected internal server error occurred.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"NotFound":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The resource does not exist, or the API key cannot see it.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"PreconditionFailed":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The current representation does not match If-Match (`precondition_failed`). No change was applied.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"ServiceUnavailable":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The service is temporarily unavailable. Retry after the number of seconds in the Retry-After header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}}},"TooManyRequests":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The API rate limit was exceeded. Wait for the number of seconds given in the Retry-After header, then retry.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}}},"Unauthorized":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Invalid or missing API key."},"UnprocessableContent":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The request is well-formed, but values are invalid; `errors` points at each of them.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}}},"schemas":{"AddLanguagesJob":{"description":"The import that adds the requested languages to the branch.","properties":{"data":{"$ref":"#/components/schemas/Import","description":"The import that adds the languages. Poll it until it reaches a terminal status."},"job_type":{"description":"Always `ADD_LANGUAGES`.","enum":["ADD_LANGUAGES"],"example":"ADD_LANGUAGES","type":"string"},"object_type":{"description":"Always `JOB`.","enum":["JOB"],"example":"JOB","type":"string"}},"required":["data","job_type","object_type"],"type":"object"},"AddProjectLanguages":{"additionalProperties":false,"description":"Request body to add target languages to a branch.","properties":{"language_codes":{"description":"Language codes of the target languages to add, at most 1000. Duplicates are ignored.","example":["de-AT","fr"],"items":{"type":"string"},"maxItems":1000,"minItems":0,"type":"array"}},"required":["language_codes"],"type":"object"},"ApiKey":{"description":"An API key of the workspace, without its token. Only getApiKey includes the permissions, for the key the request is made with.","properties":{"created_at":{"description":"When the API key was created.","example":"2026-01-15T10:30:00.123Z","format":"date-time","type":"string"},"deactivated_at":{"description":"When the API key was deactivated; null while it is active. A deactivated key no longer works.","example":"2026-10-01T08:00:00.123Z","format":"date-time","type":["string","null"]},"deactivation_reason":{"description":"Why the API key was deactivated; null while it is active.","example":"MANUAL_REVOCATION","oneOf":[{"$ref":"#/components/schemas/ApiKeyDeactivationReason"},{"type":"null"}]},"description":{"description":"Description of the API key.","example":"Pushes translations from the release pipeline.","type":["string","null"]},"expires_at":{"description":"When the API key stops working: the end of its last valid day in UTC. Null when it does not expire.","example":"2027-01-01T00:00:00.123Z","format":"date-time","type":["string","null"]},"id":{"description":"Unique identifier of the API key.","example":"api_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^api_[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}$","type":"string"},"last_used_at":{"description":"When the API key was last used, to the minute; null when it has not been used.","example":"2026-09-30T12:00:00.123Z","format":"date-time","type":["string","null"]},"management_mode":{"$ref":"#/components/schemas/ApiKeyManagementMode","description":"Whose permissions the API key follows: `WORKSPACE_MANAGED` keys act with the permissions stored on the key, `USER_OWNED` keys with the current permissions of the member in `member_id`.","example":"WORKSPACE_MANAGED"},"member_id":{"description":"The member a personal (`USER_OWNED`) key belongs to or a `USER` key is assigned to; null for other keys and once that member has left the workspace.","pattern":"^wsu_[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}$","type":["string","null"]},"name":{"description":"Name of the API key.","example":"CI pipeline","type":"string"},"object_type":{"description":"Always `API_KEY`.","enum":["API_KEY"],"example":"API_KEY","type":"string"},"permissions":{"description":"The current permissions of the key the request is made with: one per workspace area, and one per stack area that applies to every stack the key reaches, unless `stack_permissions` names the stack. Only getApiKey fills it; null elsewhere.","example":[{"level":"MANAGE","scope":"STACK","target":"RESOURCES"}],"items":{"$ref":"#/components/schemas/Permission"},"type":["array","null"]},"scope":{"$ref":"#/components/schemas/ApiKeyScope","description":"What the API key reaches.","example":"WORKSPACE"},"stack_id":{"description":"The only stack a `STACK` key reaches; null for the other scopes and once that stack is deleted.","pattern":"^stack_[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}$","type":["string","null"]},"stack_permissions":{"description":"The stacks on which the key's stack permissions differ from those in `permissions`. Only getApiKey fills it; null elsewhere.","example":[{"permissions":[{"level":"MANAGE","scope":"STACK","target":"RESOURCES"}],"stack_id":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde"}],"items":{"$ref":"#/components/schemas/StackPermissions"},"type":["array","null"]},"updated_at":{"description":"When the API key was last changed; using it doesn't count as a change.","example":"2026-06-20T14:45:00.123Z","format":"date-time","type":"string"},"workspace_id":{"description":"Unique identifier of the workspace the API key belongs to.","example":"space_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^space_[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}$","type":"string"}},"required":["created_at","deactivated_at","deactivation_reason","description","expires_at","id","last_used_at","management_mode","member_id","name","object_type","permissions","scope","stack_id","stack_permissions","updated_at","workspace_id"],"type":"object"},"ApiKeyCollection":{"description":"A cursor-paginated collection of API keys.","properties":{"data":{"description":"The list of items in this page.","example":[{"created_at":"2026-01-15T10:30:00.123Z","deactivated_at":"2026-10-01T08:00:00.123Z","deactivation_reason":"MANUAL_REVOCATION","description":"Pushes translations from the release pipeline.","expires_at":"2027-01-01T00:00:00.123Z","id":"api_0197c8f2-5a6b-7cde-8f12-3456789abcde","last_used_at":"2026-09-30T12:00:00.123Z","management_mode":"WORKSPACE_MANAGED","member_id":"wsu_0197c8f2-5a6b-7cde-8f12-3456789abcde","name":"CI pipeline","object_type":"API_KEY","permissions":[{"level":"MANAGE","scope":"STACK","target":"RESOURCES"}],"scope":"WORKSPACE","stack_id":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","stack_permissions":[{"permissions":[{"level":"MANAGE","scope":"STACK","target":"RESOURCES"}],"stack_id":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde"}],"updated_at":"2026-06-20T14:45:00.123Z","workspace_id":"space_0197c8f2-5a6b-7cde-8f12-3456789abcde"}],"items":{"$ref":"#/components/schemas/ApiKey"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"ApiKeyDeactivationReason":{"description":"The stored cause of API key deactivation.","enum":["EXPIRATION_DATE","WORKSPACE_USER_REMOVED","STACK_DELETED","MANUAL_REVOCATION","SELF_SERVICE_DISABLED"],"type":"string"},"ApiKeyFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+api_key[created_at]","-api_key[created_at]","+api_key[name]","-api_key[name]","+api_key[updated_at]","-api_key[updated_at]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/ApiKeyFilterGroup"}},"type":"object"},"ApiKeyFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/ApiKeyFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/ApiKeyFilterClause"},"minItems":1,"type":"array"},"api_key[created_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"api_key[deactivated_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"api_key[deactivation_reason]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["EXPIRATION_DATE","WORKSPACE_USER_REMOVED","STACK_DELETED","MANUAL_REVOCATION","SELF_SERVICE_DISABLED"],"type":"string"},"_in":{"items":{"enum":["EXPIRATION_DATE","WORKSPACE_USER_REMOVED","STACK_DELETED","MANUAL_REVOCATION","SELF_SERVICE_DISABLED"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["EXPIRATION_DATE","WORKSPACE_USER_REMOVED","STACK_DELETED","MANUAL_REVOCATION","SELF_SERVICE_DISABLED"],"type":"string"},"_nin":{"items":{"enum":["EXPIRATION_DATE","WORKSPACE_USER_REMOVED","STACK_DELETED","MANUAL_REVOCATION","SELF_SERVICE_DISABLED"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"api_key[description]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"api_key[id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^api_[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}$","type":"string"},"_in":{"items":{"pattern":"^api_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^api_[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}$","type":"string"},"_nin":{"items":{"pattern":"^api_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"api_key[management_mode]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["WORKSPACE_MANAGED","USER_OWNED"],"type":"string"},"_in":{"items":{"enum":["WORKSPACE_MANAGED","USER_OWNED"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["WORKSPACE_MANAGED","USER_OWNED"],"type":"string"},"_nin":{"items":{"enum":["WORKSPACE_MANAGED","USER_OWNED"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"api_key[member_id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^wsu_[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}$","type":"string"},"_in":{"items":{"pattern":"^wsu_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^wsu_[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}$","type":"string"},"_nin":{"items":{"pattern":"^wsu_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"api_key[name]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"api_key[scope]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["WORKSPACE","STACK","USER"],"type":"string"},"_in":{"items":{"enum":["WORKSPACE","STACK","USER"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["WORKSPACE","STACK","USER"],"type":"string"},"_nin":{"items":{"enum":["WORKSPACE","STACK","USER"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"api_key[stack_id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^stack_[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}$","type":"string"},"_in":{"items":{"pattern":"^stack_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^stack_[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}$","type":"string"},"_nin":{"items":{"pattern":"^stack_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"api_key[updated_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"}},"type":"object"},"ApiKeyFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/ApiKeyFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/ApiKeyFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"ApiKeyManagementMode":{"description":"Who manages the API key and determines its permissions.","enum":["WORKSPACE_MANAGED","USER_OWNED"],"type":"string"},"ApiKeyScope":{"description":"What the API key reaches. A `WORKSPACE` key reaches the workspace's stacks, a `STACK` key only the stack in `stack_id`, and a `USER` key is assigned to the member in `member_id`. User-owned keys use the member's current permissions; workspace-managed keys assigned to a user retain their configured permissions.","enum":["WORKSPACE","STACK","USER"],"type":"string"},"ApiLog":{"description":"A logged request against the LingoHub public API.","properties":{"api_key_id":{"description":"Unique identifier of the API key that issued the request, or null when the request was not made with an API key.","example":"api_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^api_[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}$","type":["string","null"]},"created_at":{"description":"Timestamp when the request was logged.","example":"2025-01-15T10:30:00.123Z","format":"date-time","type":"string"},"id":{"description":"Unique identifier of the API log entry.","example":"req_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^req_[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}$","type":"string"},"method":{"$ref":"#/components/schemas/HttpMethod","description":"HTTP method of the logged request.","example":"GET"},"object_type":{"description":"Always `API_LOG`.","enum":["API_LOG"],"example":"API_LOG","type":"string"},"path":{"description":"Request path of the logged request.","example":"/v2/projects","type":"string"},"request_id":{"description":"The request's id, as V2 problem details and the X-Request-ID response header carry it. One request can have several entries.","example":"0197c8f2-5a6b-7cde-8f12-3456789abcde","format":"uuid","type":"string"},"status_code":{"description":"HTTP status code of the response.","example":200,"format":"int32","type":"integer"}},"required":["api_key_id","created_at","id","method","object_type","path","request_id","status_code"],"type":"object"},"ApiLogCollection":{"description":"A list of API log entries with cursor pagination capability.","properties":{"data":{"description":"The list of items in this page.","example":[{"api_key_id":"api_0197c8f2-5a6b-7cde-8f12-3456789abcde","created_at":"2025-01-15T10:30:00.123Z","id":"req_0197c8f2-5a6b-7cde-8f12-3456789abcde","method":"GET","object_type":"API_LOG","path":"/v2/projects","request_id":"0197c8f2-5a6b-7cde-8f12-3456789abcde","status_code":200}],"items":{"$ref":"#/components/schemas/ApiLog"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"ApiLogFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+api_log[created_at]","-api_log[created_at]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/ApiLogFilterGroup"}},"type":"object"},"ApiLogFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/ApiLogFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/ApiLogFilterClause"},"minItems":1,"type":"array"},"api_log[api_key_id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^api_[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}$","type":"string"},"_in":{"items":{"pattern":"^api_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^api_[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}$","type":"string"},"_nin":{"items":{"pattern":"^api_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"api_log[created_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"api_log[id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^req_[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}$","type":"string"},"_in":{"items":{"pattern":"^req_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^req_[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}$","type":"string"},"_nin":{"items":{"pattern":"^req_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"api_log[method]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["GET","HEAD","POST","PUT","PATCH","DELETE","OPTIONS","TRACE","OTHER"],"type":"string"},"_in":{"items":{"enum":["GET","HEAD","POST","PUT","PATCH","DELETE","OPTIONS","TRACE","OTHER"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["GET","HEAD","POST","PUT","PATCH","DELETE","OPTIONS","TRACE","OTHER"],"type":"string"},"_nin":{"items":{"enum":["GET","HEAD","POST","PUT","PATCH","DELETE","OPTIONS","TRACE","OTHER"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"api_log[path]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"api_log[request_id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"uuid","type":"string"},"_in":{"items":{"format":"uuid","type":"string"},"minItems":1,"type":"array"},"_ne":{"format":"uuid","type":"string"},"_nin":{"items":{"format":"uuid","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"api_log[status_code]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"int32","maximum":32767,"minimum":-32768,"type":"integer"},"_gt":{"format":"int32","maximum":32767,"minimum":-32768,"type":"integer"},"_gte":{"format":"int32","maximum":32767,"minimum":-32768,"type":"integer"},"_in":{"items":{"format":"int32","maximum":32767,"minimum":-32768,"type":"integer"},"minItems":1,"type":"array"},"_lt":{"format":"int32","maximum":32767,"minimum":-32768,"type":"integer"},"_lte":{"format":"int32","maximum":32767,"minimum":-32768,"type":"integer"},"_ne":{"format":"int32","maximum":32767,"minimum":-32768,"type":"integer"},"_nin":{"items":{"format":"int32","maximum":32767,"minimum":-32768,"type":"integer"},"minItems":1,"type":"array"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"int32","maximum":32767,"minimum":-32768,"type":"integer"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"}},"type":"object"},"ApiLogFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/ApiLogFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/ApiLogFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"AttachContextImage":{"additionalProperties":false,"description":"Request body to attach a context image to segments, given directly or found from rendered strings.","properties":{"auto_connect_suggestions":{"description":"Whether rendered strings found only by their text are attached (`true`, the default) or stay suggestions to review in the app (`false`). Strings whose keys match several segments always stay suggestions.","example":true,"type":["boolean","null"]},"rendered_strings":{"description":"Rendered strings, as the iOS and Android SDKs send them, to find the segments by their keys or text, as on upload.","example":[{"highlight_box":{"height":48,"left":40,"top":120,"width":200},"keys":[{"key":"checkout.title","table":"app.messages"}],"text":"Pay now"}],"items":{"$ref":"#/components/schemas/ContextImageRenderedString"},"maxItems":1000,"minItems":0,"type":["array","null"]},"segments":{"description":"Segments to attach the context image to, each optionally with its highlight boxes. An attached segment stays attached, and a suggestion becomes an attachment. Each segment may appear only once.","example":[{"segment_id":"seg_0197c8f2-5a6b-7cde-8f12-3456789abcde"}],"items":{"$ref":"#/components/schemas/AttachContextImageSegment"},"maxItems":100,"minItems":0,"type":["array","null"]}},"type":"object"},"AttachContextImageSegment":{"additionalProperties":false,"description":"Request body part naming one segment to attach the context image to, optionally with its highlight boxes.","properties":{"highlight_boxes":{"description":"Where the segment's text appears in the image, replacing its current boxes; `[]` removes them. Leaving it out keeps them.","example":[{"height":48,"left":40,"top":120,"width":200}],"items":{"$ref":"#/components/schemas/ContextImageHighlightBox"},"maxItems":150,"minItems":0,"type":["array","null"]},"segment_id":{"description":"Segment to attach. The image is attached to the segment's text in the image's language.","example":"seg_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^seg_[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}$","type":"string"}},"required":["segment_id"],"type":"object"},"AuditActorType":{"description":"Kind of permanent audit actor.","enum":["LINGOHUB_ROBOT","USER","API_KEY","LINA"],"type":"string"},"AuditChange":{"description":"One field of a changed object, with its new and previous value.","properties":{"is_changed":{"description":"Whether the change set the field to a new value; false for the fields a create or delete lists. Null when older entries didn't record it.","example":true,"type":["boolean","null"]},"is_redacted":{"description":"Whether the values are hidden because the field is a secret, a URL or otherwise sensitive.","example":false,"type":"boolean"},"name":{"description":"Name of the field.","example":"name","type":"string"},"previous_value":{"description":"Value of the field before the change, as JSON; null when it was null, wasn't recorded or is redacted.","example":"Website","oneOf":[{"$ref":"#/components/schemas/AuditJsonValue"},{"type":"null"}]},"value":{"description":"Value of the field after the change, as JSON; null when it was null, wasn't recorded or is redacted. Ids are public ids.","example":"Website (EN)","oneOf":[{"$ref":"#/components/schemas/AuditJsonValue"},{"type":"null"}]}},"required":["is_changed","is_redacted","name","previous_value","value"],"type":"object"},"AuditChanges":{"description":"What the change did, per affected object: each field with its new and previous value. Creates and deletes list the object's fields with `is_changed` false. Secrets, URLs and other sensitive fields are shown as redacted. At most 100 objects and 256 fields per object are listed; `omitted_*` counts the rest.","properties":{"datasets":{"description":"The affected objects, in recorded order.","example":[{"entity_id":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","entity_type":"PROJECT","entries":[{"is_changed":true,"is_redacted":false,"name":"name","previous_value":"Website","value":"Website (EN)"},{"is_changed":false,"is_redacted":true,"name":"website","previous_value":null,"value":null}],"omitted_entries":0}],"items":{"$ref":"#/components/schemas/AuditDataset"},"type":"array"},"omitted_datasets":{"description":"Objects not listed beyond the first 100.","example":0,"format":"int32","minimum":0,"type":"integer"}},"required":["datasets","omitted_datasets"],"type":"object"},"AuditDataset":{"description":"One object the change affected, with its changed fields. An object that can't be read is listed as UNKNOWN without fields.","properties":{"entity_id":{"description":"Id of the object, also after it was deleted; null when the object has none or it wasn't recorded.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^(api|bii|bkp|bkr|gls|iau|ivo|la|lina|pis|pr|prb|prl|rc|rol|sg|space|stack|stackl|sub|svi|tm|whe|wsu)_[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}$","type":["string","null"]},"entity_type":{"$ref":"#/components/schemas/AuditEntityType","description":"Kind of object; UNKNOWN when it can't be read or isn't known.","example":"PROJECT"},"entries":{"description":"The fields of the object, in recorded order.","example":[{"is_changed":true,"is_redacted":false,"name":"name","previous_value":"Website","value":"Website (EN)"}],"items":{"$ref":"#/components/schemas/AuditChange"},"type":"array"},"omitted_entries":{"description":"Fields not listed: those beyond the first 256 and those that aren't published.","example":0,"format":"int32","minimum":0,"type":"integer"}},"required":["entity_id","entity_type","entries","omitted_entries"],"type":"object"},"AuditEntityType":{"description":"Kind of object a change affected. UNKNOWN marks an object that can't be read or isn't known; its fields are not listed.","enum":["API_KEY","BACKUP","BACKUP_RESTORE","BILLING_INFO","INVOICE","SUBSCRIPTION","GLOSSARY","INVITATION","LABEL","LINA","TRANSLATION_MEMORY","PROJECT","BRANCH","PROJECT_INTEGRATION","INTEGRATION_AUTHENTICATION","PROJECT_LANGUAGE","RESOURCE","IMPORT","STACK","STACK_LANGUAGE","STACK_MEMBER","STYLE_GUIDE","USER","WEBHOOK","WORKSPACE","WORKSPACE_ROLE","WORKSPACE_MEMBER","PROJECT_SETTINGS","UNKNOWN"],"type":"string"},"AuditJsonValue":{"description":"A recorded value as JSON, of the type the field has: a string, number, boolean, object or array. Ids are public ids, never database ids.","oneOf":[{"maxLength":65536,"type":"string"},{"type":"number"},{"type":"boolean"},{"items":{},"maxItems":1000,"type":"array"},{"additionalProperties":true,"maxProperties":1000,"type":"object"}]},"AuditLog":{"description":"One change in the workspace's audit log: what changed, who changed it and in which project. The changed values are returned by getAuditLog.","properties":{"actor_id":{"description":"The actor who made the change: the permanent identity of a user, API key, LINA or LingoHub itself. It stays the same after a member is removed from the workspace or a user, API key or LINA is deleted. Null only for entries without an actor.","example":"act_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^act_[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}$","type":["string","null"]},"actor_name":{"description":"Current name of who made the change; a deleted user, API key or LINA is named \"Deleted User\", \"Deleted API Key\" or \"Deleted LINA\". Null only for entries without an actor.","example":"CI deployment key","type":["string","null"]},"actor_type":{"description":"What kind of actor made the change; null only for entries without an actor.","example":"API_KEY","oneOf":[{"$ref":"#/components/schemas/AuditActorType"},{"type":"null"}]},"category":{"$ref":"#/components/schemas/AuditLogCategory","description":"Area of the change.","example":"PROJECTS"},"created_at":{"description":"When the change was made.","example":"2025-01-15T10:30:00.123Z","format":"date-time","type":"string"},"event":{"$ref":"#/components/schemas/AuditLogEvent","description":"Kind of change.","example":"UPDATE"},"id":{"description":"Unique identifier of the audit log entry.","example":"audit_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^audit_[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}$","type":"string"},"object_type":{"description":"Always `AUDIT_LOG`.","enum":["AUDIT_LOG"],"example":"AUDIT_LOG","type":"string"},"project_id":{"description":"The project the change was made in; null when there is none or it was deleted.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":["string","null"]},"project_name":{"description":"Name of the project when the change was made; kept after the project is deleted.","example":"Website","type":["string","null"]},"request_id":{"description":"Id of the request that made the change, as V2 problem details and the X-Request-ID response header carry it; the API log entries of an API request have the same request_id.","example":"0197c8f2-5a6b-7cde-8f12-3456789abcde","format":"uuid","type":"string"},"target":{"$ref":"#/components/schemas/AuditLogTarget","description":"What was changed.","example":"GENERAL"},"updated_at":{"description":"When the audit log entry was last changed.","example":"2025-01-15T10:30:00.123Z","format":"date-time","type":"string"}},"required":["actor_id","actor_name","actor_type","category","created_at","event","id","object_type","project_id","project_name","request_id","target","updated_at"],"type":"object"},"AuditLogCategory":{"description":"Public audit log category.","enum":["WORKSPACES","TMS","MARKETPLACE","API","MEMBERS","LABELS","PROJECTS","USERS"],"type":"string"},"AuditLogCollection":{"description":"A cursor-paginated collection of workspace audit logs.","properties":{"data":{"description":"The list of items in this page.","example":[{"actor_id":"act_0197c8f2-5a6b-7cde-8f12-3456789abcde","actor_name":"CI deployment key","actor_type":"API_KEY","category":"PROJECTS","created_at":"2025-01-15T10:30:00.123Z","event":"UPDATE","id":"audit_0197c8f2-5a6b-7cde-8f12-3456789abcde","object_type":"AUDIT_LOG","project_id":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","project_name":"Website","request_id":"0197c8f2-5a6b-7cde-8f12-3456789abcde","target":"GENERAL","updated_at":"2025-01-15T10:30:00.123Z"}],"items":{"$ref":"#/components/schemas/AuditLog"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"AuditLogEvent":{"description":"Public audit log event.","enum":["CREATE","UPDATE","DELETE","RENAME","IMPORT","EXPORT","DEACTIVATE","ACTIVATE","CANCEL","RENEW","APPROVE","FAIL","ACCEPT","DECLINE","TRANSFER","RESET","CONFIRM","ENABLE","DISABLE","SCHEDULE"],"type":"string"},"AuditLogFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+audit_log[created_at]","-audit_log[created_at]","+audit_log[updated_at]","-audit_log[updated_at]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/AuditLogFilterGroup"}},"type":"object"},"AuditLogFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/AuditLogFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/AuditLogFilterClause"},"minItems":1,"type":"array"},"audit_log[actor_id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^act_[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}$","type":"string"},"_in":{"items":{"pattern":"^act_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^act_[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}$","type":"string"},"_nin":{"items":{"pattern":"^act_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"audit_log[actor_type]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["LINGOHUB_ROBOT","USER","API_KEY","LINA"],"type":"string"},"_in":{"items":{"enum":["LINGOHUB_ROBOT","USER","API_KEY","LINA"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["LINGOHUB_ROBOT","USER","API_KEY","LINA"],"type":"string"},"_nin":{"items":{"enum":["LINGOHUB_ROBOT","USER","API_KEY","LINA"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"audit_log[category]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["WORKSPACES","TMS","MARKETPLACE","API","MEMBERS","LABELS","PROJECTS","USERS"],"type":"string"},"_in":{"items":{"enum":["WORKSPACES","TMS","MARKETPLACE","API","MEMBERS","LABELS","PROJECTS","USERS"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["WORKSPACES","TMS","MARKETPLACE","API","MEMBERS","LABELS","PROJECTS","USERS"],"type":"string"},"_nin":{"items":{"enum":["WORKSPACES","TMS","MARKETPLACE","API","MEMBERS","LABELS","PROJECTS","USERS"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"audit_log[created_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"audit_log[event]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["CREATE","UPDATE","DELETE","RENAME","IMPORT","EXPORT","DEACTIVATE","ACTIVATE","CANCEL","RENEW","APPROVE","FAIL","ACCEPT","DECLINE","TRANSFER","RESET","CONFIRM","ENABLE","DISABLE","SCHEDULE"],"type":"string"},"_in":{"items":{"enum":["CREATE","UPDATE","DELETE","RENAME","IMPORT","EXPORT","DEACTIVATE","ACTIVATE","CANCEL","RENEW","APPROVE","FAIL","ACCEPT","DECLINE","TRANSFER","RESET","CONFIRM","ENABLE","DISABLE","SCHEDULE"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["CREATE","UPDATE","DELETE","RENAME","IMPORT","EXPORT","DEACTIVATE","ACTIVATE","CANCEL","RENEW","APPROVE","FAIL","ACCEPT","DECLINE","TRANSFER","RESET","CONFIRM","ENABLE","DISABLE","SCHEDULE"],"type":"string"},"_nin":{"items":{"enum":["CREATE","UPDATE","DELETE","RENAME","IMPORT","EXPORT","DEACTIVATE","ACTIVATE","CANCEL","RENEW","APPROVE","FAIL","ACCEPT","DECLINE","TRANSFER","RESET","CONFIRM","ENABLE","DISABLE","SCHEDULE"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"audit_log[id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^audit_[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}$","type":"string"},"_in":{"items":{"pattern":"^audit_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^audit_[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}$","type":"string"},"_nin":{"items":{"pattern":"^audit_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"audit_log[project_id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^pr_[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}$","type":"string"},"_in":{"items":{"pattern":"^pr_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^pr_[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}$","type":"string"},"_nin":{"items":{"pattern":"^pr_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"audit_log[project_name]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"audit_log[request_id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"uuid","type":"string"},"_in":{"items":{"format":"uuid","type":"string"},"minItems":1,"type":"array"},"_ne":{"format":"uuid","type":"string"},"_nin":{"items":{"format":"uuid","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"audit_log[target]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["GENERAL","PROFILE","PROFILE_URL","SUBSCRIPTION","BILLING_INFOS","PAYMENT_INFOS","INVOICES","PAYMENTS","GLOSSARIES","TRANSLATION_MEMORIES","STYLE_GUIDES","ORDERS","KEYS","WEBHOOKS","INVITATION","PERMISSION","ROLE","LOCALES","RESOURCES","PACKAGES","BACKUPS","PRE_TRANSLATION","INTEGRATIONS","API_LOGS","STACK","LINA","AUDIT_LOGS","SEGMENT_TEXT_EDITS","WORK_LOGS","PASSWORD","WORKSPACE","TWO_FACTOR","TEXT_PROCESSINGS","SETTINGS","BRANCHES"],"type":"string"},"_in":{"items":{"enum":["GENERAL","PROFILE","PROFILE_URL","SUBSCRIPTION","BILLING_INFOS","PAYMENT_INFOS","INVOICES","PAYMENTS","GLOSSARIES","TRANSLATION_MEMORIES","STYLE_GUIDES","ORDERS","KEYS","WEBHOOKS","INVITATION","PERMISSION","ROLE","LOCALES","RESOURCES","PACKAGES","BACKUPS","PRE_TRANSLATION","INTEGRATIONS","API_LOGS","STACK","LINA","AUDIT_LOGS","SEGMENT_TEXT_EDITS","WORK_LOGS","PASSWORD","WORKSPACE","TWO_FACTOR","TEXT_PROCESSINGS","SETTINGS","BRANCHES"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["GENERAL","PROFILE","PROFILE_URL","SUBSCRIPTION","BILLING_INFOS","PAYMENT_INFOS","INVOICES","PAYMENTS","GLOSSARIES","TRANSLATION_MEMORIES","STYLE_GUIDES","ORDERS","KEYS","WEBHOOKS","INVITATION","PERMISSION","ROLE","LOCALES","RESOURCES","PACKAGES","BACKUPS","PRE_TRANSLATION","INTEGRATIONS","API_LOGS","STACK","LINA","AUDIT_LOGS","SEGMENT_TEXT_EDITS","WORK_LOGS","PASSWORD","WORKSPACE","TWO_FACTOR","TEXT_PROCESSINGS","SETTINGS","BRANCHES"],"type":"string"},"_nin":{"items":{"enum":["GENERAL","PROFILE","PROFILE_URL","SUBSCRIPTION","BILLING_INFOS","PAYMENT_INFOS","INVOICES","PAYMENTS","GLOSSARIES","TRANSLATION_MEMORIES","STYLE_GUIDES","ORDERS","KEYS","WEBHOOKS","INVITATION","PERMISSION","ROLE","LOCALES","RESOURCES","PACKAGES","BACKUPS","PRE_TRANSLATION","INTEGRATIONS","API_LOGS","STACK","LINA","AUDIT_LOGS","SEGMENT_TEXT_EDITS","WORK_LOGS","PASSWORD","WORKSPACE","TWO_FACTOR","TEXT_PROCESSINGS","SETTINGS","BRANCHES"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"audit_log[updated_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"}},"type":"object"},"AuditLogFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/AuditLogFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/AuditLogFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"AuditLogTarget":{"description":"Public audit log target.","enum":["GENERAL","PROFILE","PROFILE_URL","SUBSCRIPTION","BILLING_INFOS","PAYMENT_INFOS","INVOICES","PAYMENTS","GLOSSARIES","TRANSLATION_MEMORIES","STYLE_GUIDES","ORDERS","KEYS","WEBHOOKS","INVITATION","PERMISSION","ROLE","LOCALES","RESOURCES","PACKAGES","BACKUPS","PRE_TRANSLATION","INTEGRATIONS","API_LOGS","STACK","LINA","AUDIT_LOGS","SEGMENT_TEXT_EDITS","WORK_LOGS","PASSWORD","WORKSPACE","TWO_FACTOR","TEXT_PROCESSINGS","SETTINGS","BRANCHES"],"type":"string"},"AuditLogWithChanges":{"description":"One change in the workspace's audit log: what changed, who changed it, in which project, and the changed values with their previous ones.","properties":{"actor_id":{"description":"The actor who made the change: the permanent identity of a user, API key, LINA or LingoHub itself. It stays the same after a member is removed from the workspace or a user, API key or LINA is deleted. Null only for entries without an actor.","example":"act_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^act_[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}$","type":["string","null"]},"actor_name":{"description":"Current name of who made the change; a deleted user, API key or LINA is named \"Deleted User\", \"Deleted API Key\" or \"Deleted LINA\". Null only for entries without an actor.","example":"CI deployment key","type":["string","null"]},"actor_type":{"description":"What kind of actor made the change; null only for entries without an actor.","example":"API_KEY","oneOf":[{"$ref":"#/components/schemas/AuditActorType"},{"type":"null"}]},"category":{"$ref":"#/components/schemas/AuditLogCategory","description":"Area of the change.","example":"PROJECTS"},"changes":{"description":"The changed values; null when the stored record of the change can't be read.","oneOf":[{"$ref":"#/components/schemas/AuditChanges"},{"type":"null"}]},"created_at":{"description":"When the change was made.","example":"2025-01-15T10:30:00.123Z","format":"date-time","type":"string"},"event":{"$ref":"#/components/schemas/AuditLogEvent","description":"Kind of change.","example":"UPDATE"},"id":{"description":"Unique identifier of the audit log entry.","example":"audit_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^audit_[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}$","type":"string"},"object_type":{"description":"Always `AUDIT_LOG`.","enum":["AUDIT_LOG"],"example":"AUDIT_LOG","type":"string"},"project_id":{"description":"The project the change was made in; null when there is none or it was deleted.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":["string","null"]},"project_name":{"description":"Name of the project when the change was made; kept after the project is deleted.","example":"Website","type":["string","null"]},"request_id":{"description":"Id of the request that made the change, as V2 problem details and the X-Request-ID response header carry it; the API log entries of an API request have the same request_id.","example":"0197c8f2-5a6b-7cde-8f12-3456789abcde","format":"uuid","type":"string"},"target":{"$ref":"#/components/schemas/AuditLogTarget","description":"What was changed.","example":"GENERAL"},"updated_at":{"description":"When the audit log entry was last changed.","example":"2025-01-15T10:30:00.123Z","format":"date-time","type":"string"}},"required":["actor_id","actor_name","actor_type","category","changes","created_at","event","id","object_type","project_id","project_name","request_id","target","updated_at"],"type":"object"},"AutomationAction":{"description":"What the rule does and to which texts. `type` selects the shape; it follows from the rule's `type` for now.","discriminator":{"mapping":{"ADD_LABEL":"#/components/schemas/AutomationAddLabelAction","REPLACE_TEXT":"#/components/schemas/AutomationReplaceTextAction","SET_STATUS":"#/components/schemas/AutomationSetStatusAction"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AutomationReplaceTextAction"},{"$ref":"#/components/schemas/AutomationSetStatusAction"},{"$ref":"#/components/schemas/AutomationAddLabelAction"}],"type":"object"},"AutomationAddLabelAction":{"description":"Adds a label to the segment.","properties":{"label_id":{"description":"The label to add; null when the label no longer exists in the workspace.","example":"la_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^la_[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}$","type":["string","null"]},"target":{"$ref":"#/components/schemas/AutomationTarget","description":"The texts the action changes.","example":{"conditions":[],"language_codes":[],"selector":"TRIGGERING_TEXT"}},"type":{"description":"Selects this shape of the body.","enum":["ADD_LABEL"],"example":"ADD_LABEL","type":"string"}},"required":["label_id","target","type"],"type":"object"},"AutomationCondition":{"description":"A plain-text condition; conditions in one list must all match.","properties":{"mode":{"$ref":"#/components/schemas/AutomationMatchMode","description":"Plain-text matching mode. Regular expressions are not used.","example":"CONTAINS"},"subject":{"$ref":"#/components/schemas/AutomationConditionSubject","description":"Subject inspected by the condition.","example":"TEXT"},"value":{"description":"Match text; null for conditions that require no text value.","example":"draft","type":["string","null"]}},"required":["mode","subject","value"],"type":"object"},"AutomationConditionSubject":{"description":"What a condition looks at. `KEY`: the segment's keys; the condition matches when one of them does. `TEXT`: the content of the text. `DESCRIPTION`: the segment's description.","enum":["KEY","TEXT","DESCRIPTION"],"type":"string"},"AutomationMatchMode":{"description":"How a condition compares, case-sensitively and as plain text (no regular expressions). `IS_EMPTY` and `IS_NOT_EMPTY` take no `value`. `EQUALS`, `STARTS_WITH`, `ENDS_WITH` and `CONTAINS` compare with `value`, which they require.","enum":["IS_EMPTY","IS_NOT_EMPTY","EQUALS","STARTS_WITH","ENDS_WITH","CONTAINS"],"type":"string"},"AutomationOrigin":{"description":"Where the change comes from. `IMPORT`: an import of files, including Git and integration syncs. `EDITOR`: a key or text changed directly, in the editor or through the API. `ANY`: either. Changes made by LINA or pre-translation don't run automation rules.","enum":["IMPORT","EDITOR","ANY"],"type":"string"},"AutomationReplaceTextAction":{"description":"Replaces every occurrence of `search` in the text with `replace`.","properties":{"is_placeholder_excluded":{"description":"Whether placeholders in the text are left unchanged.","example":true,"type":"boolean"},"replace":{"description":"The replacement; an empty string deletes the found text.","example":"color","type":"string"},"search":{"description":"The plain text to search for, case-sensitively.","example":"colour","type":"string"},"target":{"$ref":"#/components/schemas/AutomationTarget","description":"The texts the action changes.","example":{"conditions":[],"language_codes":[],"selector":"TRIGGERING_TEXT"}},"type":{"description":"Selects this shape of the body.","enum":["REPLACE_TEXT"],"example":"REPLACE_TEXT","type":"string"}},"required":["is_placeholder_excluded","replace","search","target","type"],"type":"object"},"AutomationRole":{"description":"Which texts of a segment can start the rule. `SOURCE`: the source text. `TARGET`: a text in a target language. `ANY`: either. A rule that reacts to keys takes `ANY`, because a key has no language.","enum":["SOURCE","TARGET","ANY"],"type":"string"},"AutomationScope":{"description":"Which incoming changes may trigger a configured rule.","properties":{"language_codes":{"description":"Empty means every language; meaningful only for text-level triggers.","example":["de"],"items":{"description":"Language code that uniquely identifies a locale. Valid examples would be 'en', 'en-GB', 'de', 'de-DE' etc. according to [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).","type":"string"},"type":"array"},"origin":{"$ref":"#/components/schemas/AutomationOrigin","description":"IMPORT, EDITOR, or ANY. LINA/pretranslation bypass this workflow pipeline.","example":"ANY"},"role":{"$ref":"#/components/schemas/AutomationRole","description":"Source/target scope; meaningful only for text-level triggers.","example":"ANY"}},"required":["language_codes","origin","role"],"type":"object"},"AutomationSetStatusAction":{"description":"Sets the status of the texts.","properties":{"status":{"$ref":"#/components/schemas/TextStatus","description":"The status to set.","example":"APPROVED"},"target":{"$ref":"#/components/schemas/AutomationTarget","description":"The texts the action changes.","example":{"conditions":[],"language_codes":[],"selector":"TRIGGERING_TEXT"}},"type":{"description":"Selects this shape of the body.","enum":["SET_STATUS"],"example":"SET_STATUS","type":"string"}},"required":["status","target","type"],"type":"object"},"AutomationTarget":{"description":"Which texts an action writes; separate from trigger scope.","properties":{"conditions":{"description":"Conditions checked per acted-on target text, separately from trigger conditions.","example":[{"mode":"CONTAINS","subject":"TEXT","value":"draft"}],"items":{"$ref":"#/components/schemas/AutomationCondition"},"type":"array"},"language_codes":{"description":"Empty means every target language; relevant for SEGMENT_TARGET_TEXTS.","example":["de"],"items":{"description":"Language code that uniquely identifies a locale. Valid examples would be 'en', 'en-GB', 'de', 'de-DE' etc. according to [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).","type":"string"},"type":"array"},"selector":{"$ref":"#/components/schemas/AutomationTargetSelector","description":"Act on the triggering text or matching target texts of its segment.","example":"TRIGGERING_TEXT"}},"required":["conditions","language_codes","selector"],"type":"object"},"AutomationTargetSelector":{"description":"Which texts the action changes. `TRIGGERING_TEXT`: the text that started the rule. `SEGMENT_TARGET_TEXTS`: the segment's texts in the target languages, optionally limited by `language_codes` and `conditions`; only a status rule that reacts to the source text can use it.","enum":["TRIGGERING_TEXT","SEGMENT_TARGET_TEXTS"],"type":"string"},"AutomationTrigger":{"description":"What starts the rule. `KEY_CREATED`, `KEY_UPDATED` and `KEY_CREATED_OR_UPDATED`: a key is created, changed, or either; only `LABEL` rules can react to keys. `TEXT_CREATED`, `TEXT_UPDATED` and `TEXT_CREATED_OR_UPDATED`: a text is created, changed, or either.","enum":["KEY_CREATED","KEY_UPDATED","KEY_CREATED_OR_UPDATED","TEXT_CREATED","TEXT_UPDATED","TEXT_CREATED_OR_UPDATED"],"type":"string"},"AutomationType":{"description":"The rule family. It decides the rule's action and how the family's matching rules run. `TEXT` replaces text (`REPLACE_TEXT`): every matching rule applies, in list order, so the replacements chain. `STATUS` sets a status (`SET_STATUS`): the first matching rule wins and the others are skipped. `LABEL` adds a label (`ADD_LABEL`): every matching rule applies. The families run in this order: text replacements first, then status changes, then labels.","enum":["TEXT","STATUS","LABEL"],"type":"string"},"AzureOrganization":{"description":"A provider-discovered Azure organization; not a LingoHub workspace.","properties":{"key":{"description":"External Azure organization key; not a LingoHub ID.","example":"eb6e4656-77fc-42a1-9181-4c6d8e9da5d1","type":"string"},"name":{"description":"Azure organization name used in the repository namespace.","example":"company","type":"string"},"object_type":{"description":"Always `AZURE_ORGANIZATION`.","enum":["AZURE_ORGANIZATION"],"example":"AZURE_ORGANIZATION","type":"string"}},"required":["key","name","object_type"],"type":"object"},"AzureOrganizationCollection":{"description":"One bounded provider discovery page.","properties":{"data":{"description":"The list of items in this page.","example":[{"key":"eb6e4656-77fc-42a1-9181-4c6d8e9da5d1","name":"company","object_type":"AZURE_ORGANIZATION"}],"items":{"$ref":"#/components/schemas/AzureOrganization"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"AzureProject":{"description":"A provider-discovered Azure project; not a LingoHub project.","properties":{"key":{"description":"External Azure project key; not a LingoHub ID.","example":"eb6e4656-77fc-42a1-9181-4c6d8e9da5d1","type":"string"},"name":{"description":"Azure project name used in the repository namespace.","example":"App","type":"string"},"object_type":{"description":"Always `AZURE_PROJECT`.","enum":["AZURE_PROJECT"],"example":"AZURE_PROJECT","type":"string"}},"required":["key","name","object_type"],"type":"object"},"AzureProjectCollection":{"description":"One bounded provider discovery page.","properties":{"data":{"description":"The list of items in this page.","example":[{"key":"eb6e4656-77fc-42a1-9181-4c6d8e9da5d1","name":"App","object_type":"AZURE_PROJECT"}],"items":{"$ref":"#/components/schemas/AzureProject"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"Backup":{"description":"A snapshot of one branch: its files, keys and texts in the listed languages.","properties":{"branch_id":{"description":"Unique identifier of the branch the backup is a snapshot of; null once the branch is deleted.","example":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":["string","null"]},"branch_name":{"description":"Name of the branch when the backup was requested; it stays after the branch is renamed or deleted.","example":"main","type":"string"},"created_at":{"description":"When the backup was requested; the snapshot is taken when it runs.","example":"2026-01-01T10:00:00.123Z","format":"date-time","type":"string"},"id":{"description":"Unique identifier of the backup.","example":"bkp_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^bkp_[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}$","type":"string"},"name":{"description":"Name of the backup.","example":"Before release","type":"string"},"object_type":{"description":"Always `BACKUP`.","enum":["BACKUP"],"example":"BACKUP","type":"string"},"project_id":{"description":"Unique identifier of the project the backup belongs to.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"},"source_language_code":{"description":"Source language of the snapshot.","example":"en","type":"string"},"status":{"$ref":"#/components/schemas/BackupStatus","description":"Status of the backup.","example":"SUCCEEDED"},"status_details":{"description":"Why the backup failed; null when there is nothing to explain.","example":null,"oneOf":[{"$ref":"#/components/schemas/SyncStatusDetails"},{"type":"null"}]},"target_language_codes":{"description":"The languages in the snapshot; until it has succeeded, the requested ones.","example":["de","fr"],"items":{"description":"Language code that uniquely identifies a locale. Valid examples would be 'en', 'en-GB', 'de', 'de-DE' etc. according to [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).","type":"string"},"type":"array"},"updated_at":{"description":"When the backup was last changed, including its status.","example":"2026-01-01T10:01:00.123Z","format":"date-time","type":"string"}},"required":["branch_id","branch_name","created_at","id","name","object_type","project_id","source_language_code","status","status_details","target_language_codes","updated_at"],"type":"object"},"BackupCollection":{"description":"A list of backups with cursor pagination.","properties":{"data":{"description":"The list of items in this page.","example":[{"branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","branch_name":"main","created_at":"2026-01-01T10:00:00.123Z","id":"bkp_0197c8f2-5a6b-7cde-8f12-3456789abcde","name":"Before release","object_type":"BACKUP","project_id":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","source_language_code":"en","status":"SUCCEEDED","status_details":null,"target_language_codes":["de","fr"],"updated_at":"2026-01-01T10:01:00.123Z"}],"items":{"$ref":"#/components/schemas/Backup"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"BackupFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+backup[branch_name]","-backup[branch_name]","+backup[created_at]","-backup[created_at]","+backup[name]","-backup[name]","+backup[updated_at]","-backup[updated_at]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/BackupFilterGroup"}},"type":"object"},"BackupFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/BackupFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/BackupFilterClause"},"minItems":1,"type":"array"},"backup[branch_id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^prb_[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}$","type":"string"},"_in":{"items":{"pattern":"^prb_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^prb_[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}$","type":"string"},"_nin":{"items":{"pattern":"^prb_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"backup[branch_name]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"backup[created_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"backup[id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^bkp_[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}$","type":"string"},"_in":{"items":{"pattern":"^bkp_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^bkp_[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}$","type":"string"},"_nin":{"items":{"pattern":"^bkp_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"backup[name]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"backup[status]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["QUEUED","PROCESSING","SUCCEEDED","FAILED"],"type":"string"},"_in":{"items":{"enum":["QUEUED","PROCESSING","SUCCEEDED","FAILED"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["QUEUED","PROCESSING","SUCCEEDED","FAILED"],"type":"string"},"_nin":{"items":{"enum":["QUEUED","PROCESSING","SUCCEEDED","FAILED"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"backup[updated_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"}},"type":"object"},"BackupFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/BackupFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/BackupFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"BackupJob":{"description":"A backup snapshot scheduled for asynchronous processing.","properties":{"data":{"$ref":"#/components/schemas/Backup","description":"The backup, to poll at the URL in `Location`."},"job_type":{"description":"Always `BACKUP`.","enum":["BACKUP"],"example":"BACKUP","type":"string"},"object_type":{"description":"Always `JOB`.","enum":["JOB"],"example":"JOB","type":"string"}},"required":["data","job_type","object_type"],"type":"object"},"BackupRestore":{"description":"A restore of languages of a backup into a branch.","properties":{"backup_id":{"description":"Unique identifier of the backup that is restored.","example":"bkp_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^bkp_[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}$","type":"string"},"branch_id":{"description":"Unique identifier of the branch the backup is restored into.","example":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"},"created_at":{"description":"When the restore was requested.","example":"2026-01-01T10:00:00.123Z","format":"date-time","type":"string"},"id":{"description":"Unique identifier of the restore.","example":"bkr_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^bkr_[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}$","type":"string"},"language_codes":{"description":"The languages restored from the backup.","example":["en","de"],"items":{"description":"Language code that uniquely identifies a locale. Valid examples would be 'en', 'en-GB', 'de', 'de-DE' etc. according to [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).","type":"string"},"type":"array"},"object_type":{"description":"Always `BACKUP_RESTORE`.","enum":["BACKUP_RESTORE"],"example":"BACKUP_RESTORE","type":"string"},"project_id":{"description":"Unique identifier of the project of the backup and the branch.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"},"status":{"$ref":"#/components/schemas/BackupRestoreStatus","description":"Status of the restore.","example":"SUCCEEDED"},"status_details":{"description":"Why the restore failed; null when there is nothing to explain.","example":null,"oneOf":[{"$ref":"#/components/schemas/SyncStatusDetails"},{"type":"null"}]},"updated_at":{"description":"When the restore was last changed, including its status.","example":"2026-01-01T10:01:00.123Z","format":"date-time","type":"string"}},"required":["backup_id","branch_id","created_at","id","language_codes","object_type","project_id","status","status_details","updated_at"],"type":"object"},"BackupRestoreJob":{"description":"A snapshot restore scheduled for asynchronous processing.","properties":{"data":{"$ref":"#/components/schemas/BackupRestore","description":"The restore, to poll at the URL in `Location`."},"job_type":{"description":"Always `BACKUP_RESTORE`.","enum":["BACKUP_RESTORE"],"example":"BACKUP_RESTORE","type":"string"},"object_type":{"description":"Always `JOB`.","enum":["JOB"],"example":"JOB","type":"string"}},"required":["data","job_type","object_type"],"type":"object"},"BackupRestoreStatus":{"description":"Status of a restore. `QUEUED` and `PROCESSING` are pending; `SUCCEEDED` and `FAILED` are final.","enum":["QUEUED","PROCESSING","SUCCEEDED","FAILED"],"type":"string"},"BackupSchedule":{"description":"When automatic backups run: daily or weekly, at a time of day in UTC.","properties":{"day_of_week":{"description":"Day of the week for a `WEEKLY` schedule; null for `DAILY`.","example":"MONDAY","oneOf":[{"$ref":"#/components/schemas/BackupScheduleWeekday"},{"type":"null"}]},"period":{"$ref":"#/components/schemas/BackupSchedulePeriod","description":"Daily or weekly schedule.","example":"WEEKLY"},"time":{"description":"Stored execution time of day in UTC.","example":"10:30","type":"string"}},"required":["day_of_week","period","time"],"type":"object"},"BackupSchedulePeriod":{"description":"Period of a persisted automatic-backup schedule.","enum":["DAILY","WEEKLY"],"type":"string"},"BackupScheduleWeekday":{"description":"Weekday of a weekly automatic-backup schedule.","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"BackupSettings":{"description":"Stored automatic-backup configuration addressed by its project ID. An absent schedule is disabled, without fabricated timestamps.","properties":{"branch_ids":{"description":"The branches each scheduled run backs up. With none, the schedule runs without backing anything up.","example":["prb_0197c8f2-5a6b-7cde-8f12-3456789abcde"],"items":{"pattern":"^prb_[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}$","type":"string"},"type":"array"},"created_at":{"description":"Creation time of the stored schedule; null when absent.","example":"2026-09-30T00:00:00.123Z","format":"date-time","type":["string","null"]},"id":{"description":"Project public ID addressing this singleton configuration.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^pr_[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}$","type":"string"},"is_enabled":{"description":"A schedule exists. Backups are only made for the branches in `branch_ids`; with none, the schedule runs without backing anything up.","example":true,"type":"boolean"},"next_execution_at":{"description":"Stored next scheduled execution time, or null when absent. This is not a guarantee of execution or success.","example":"2026-10-05T10:30:00.123Z","format":"date-time","type":["string","null"]},"object_type":{"description":"Always `BACKUP_SETTINGS`.","enum":["BACKUP_SETTINGS"],"example":"BACKUP_SETTINGS","type":"string"},"schedule":{"description":"The schedule, or null when automatic backups are off.","example":{"day_of_week":"MONDAY","period":"WEEKLY","time":"10:30"},"oneOf":[{"$ref":"#/components/schemas/BackupSchedule"},{"type":"null"}]},"updated_at":{"description":"Last stored schedule update; branch selection can change independently and also changes the ETag. Null when no schedule exists.","example":"2026-09-30T00:00:00.123Z","format":"date-time","type":["string","null"]}},"required":["branch_ids","created_at","id","is_enabled","next_execution_at","object_type","schedule","updated_at"],"type":"object"},"BackupStatus":{"description":"Status of a backup. `QUEUED` and `PROCESSING` are pending; `SUCCEEDED` and `FAILED` are final, and only a `SUCCEEDED` backup can be restored.","enum":["QUEUED","PROCESSING","SUCCEEDED","FAILED"],"type":"string"},"BitbucketWorkspace":{"description":"A provider-discovered Git setup item.","properties":{"key":{"description":"External workspace slug; not a LingoHub workspace ID.","example":"company","type":"string"},"object_type":{"description":"Always `BITBUCKET_WORKSPACE`.","enum":["BITBUCKET_WORKSPACE"],"example":"BITBUCKET_WORKSPACE","type":"string"}},"required":["key","object_type"],"type":"object"},"BitbucketWorkspaceCollection":{"description":"One bounded provider discovery page.","properties":{"data":{"description":"The list of items in this page.","example":[{"key":"company","object_type":"BITBUCKET_WORKSPACE"}],"items":{"$ref":"#/components/schemas/BitbucketWorkspace"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"BlankContentHandling":{"description":"What an export does with an empty text: `KEEP` writes the entry with an empty text, `SKIP` leaves the entry out.","enum":["KEEP","SKIP"],"type":"string"},"Branch":{"description":"A branch of a LingoHub project. Each project has exactly one default branch.","properties":{"created_at":{"description":"Timestamp when the branch was created.","example":"2025-01-15T10:30:00.123Z","format":"date-time","type":"string"},"git_branch":{"description":"The name of the remote Git branch this branch is connected to; null when it isn't connected or the connection is deactivated. getBranchGitIntegration has the details.","example":"main","type":["string","null"]},"id":{"description":"Unique identifier of the branch.","example":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^prb_[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}$","type":"string"},"initialization_status":{"$ref":"#/components/schemas/BranchInitializationStatus","description":"Outcome of the initial copy of a branch created from a starting point; `SUCCEEDED` right away for an empty branch. Until it's `SUCCEEDED` the branch can be renamed or deleted, but not imported into, exported, given languages or made the default."},"is_default":{"description":"Whether this is the default branch of the project.","example":true,"type":"boolean"},"name":{"description":"Display name of the branch; unique in the project. A connected Git branch keeps its own name (`git_branch`).","example":"main","maxLength":4096,"minLength":0,"type":"string"},"object_type":{"description":"Always `BRANCH`.","enum":["BRANCH"],"example":"BRANCH","type":"string"},"project_id":{"description":"Unique identifier of the project this branch belongs to.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"},"updated_at":{"description":"Timestamp when the branch was last updated.","example":"2025-06-20T14:45:00.123Z","format":"date-time","type":"string"}},"required":["created_at","git_branch","id","initialization_status","is_default","name","object_type","project_id","updated_at"],"type":"object"},"BranchCollection":{"description":"A list of project branches.","properties":{"data":{"description":"The list of items in this page.","example":[{"created_at":"2025-01-15T10:30:00.123Z","git_branch":"main","id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","initialization_status":"QUEUED","is_default":true,"name":"main","object_type":"BRANCH","project_id":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","updated_at":"2025-06-20T14:45:00.123Z"}],"items":{"$ref":"#/components/schemas/Branch"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"BranchFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+branch[created_at]","-branch[created_at]","+branch[name]","-branch[name]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/BranchFilterGroup"}},"type":"object"},"BranchFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/BranchFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/BranchFilterClause"},"minItems":1,"type":"array"},"branch[created_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"branch[id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^prb_[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}$","type":"string"},"_in":{"items":{"pattern":"^prb_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^prb_[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}$","type":"string"},"_nin":{"items":{"pattern":"^prb_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"branch[is_default]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_false":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_true":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"}},"type":"object"},"branch[name]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"}},"type":"object"},"BranchFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/BranchFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/BranchFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"BranchGitIntegration":{"description":"A branch's link to its remote branch. Its id is the branch's.","example":{"created_at":"2026-09-01T10:00:00.123Z","git_branch":"release/2.0","id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","is_protected":false,"last_pull_at":"2026-09-30T08:15:00.123Z","last_pull_commit_sha":"e89d9270a7c0b3f1d2e4f5a6b7c8d9e0f1a2b3c4","last_push_at":null,"last_push_commit_sha":null,"object_type":"BRANCH_GIT_INTEGRATION","project_id":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","type":"SYSTEM","updated_at":"2026-09-30T08:15:00.123Z"},"properties":{"created_at":{"description":"When the branch was linked.","example":"2026-09-30T00:00:00.123Z","format":"date-time","type":"string"},"git_branch":{"description":"The remote branch the branch syncs with; its name may differ from the branch's.","example":"main","type":"string"},"id":{"description":"The branch's id.","example":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^prb_[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}$","type":"string"},"is_protected":{"description":"Branch protection the provider reported when the binding was created; not a fresh provider check. Null when the provider did not report it.","example":false,"type":["boolean","null"]},"last_pull_at":{"description":"When a pull of the branch last succeeded; null before the first one.","example":"2026-09-30T08:15:00.123Z","format":"date-time","type":["string","null"]},"last_pull_commit_sha":{"description":"The commit the last successful pull read; null before the first one.","example":"e89d9270a7c0b3f1d2e4f5a6b7c8d9e0f1a2b3c4","type":["string","null"]},"last_push_at":{"description":"When a push of the branch last succeeded; null before the first one.","example":"2026-09-30T09:30:00.123Z","format":"date-time","type":["string","null"]},"last_push_commit_sha":{"description":"The commit the last successful push made; null before the first one.","example":"0a1b2c3d4e5f0a1b2c3d4e5f0a1b2c3d4e5f0a1b","type":["string","null"]},"object_type":{"description":"Always `BRANCH_GIT_INTEGRATION`.","enum":["BRANCH_GIT_INTEGRATION"],"example":"BRANCH_GIT_INTEGRATION","type":"string"},"project_id":{"description":"The id of the branch's project.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"},"type":{"$ref":"#/components/schemas/GitBranchType","description":"How the link came about: `DEFAULT` for the default branch, `USER` when linked by hand, `SYSTEM` when created by branching.","example":"DEFAULT"},"updated_at":{"description":"When the link last changed.","example":"2026-09-30T00:00:00.123Z","format":"date-time","type":"string"}},"required":["created_at","git_branch","id","is_protected","last_pull_at","last_pull_commit_sha","last_push_at","last_push_commit_sha","object_type","project_id","type","updated_at"],"type":"object"},"BranchInitializationStatus":{"description":"QUEUED and PROCESSING are pending. SUCCEEDED means the branch is ready; a branch created without a starting point is ready immediately. FAILED, CANCELLED and SKIPPED are final: the copy didn't complete and the branch may be incomplete; delete it and create a new one to retry. Poll GET /v2/branches/{id} every two seconds while pending.","enum":["QUEUED","PROCESSING","SUCCEEDED","FAILED","CANCELLED","SKIPPED"],"type":"string"},"BulkTransitionSegmentItem":{"additionalProperties":false,"description":"Request body part naming a text of the branch and the status change to make.","properties":{"action":{"$ref":"#/components/schemas/TextAction","description":"APPROVE, REOPEN, MARK_TRANSLATED or REJECT; the source text takes only APPROVE and REOPEN.","example":"APPROVE"},"language_code":{"description":"Language of the text, one of the branch's languages.","example":"de","type":"string"},"segment_id":{"description":"The segment of the text. It must have a key in the branch.","example":"seg_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^seg_[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}$","type":"string"}},"required":["action","language_code","segment_id"],"type":"object"},"BulkUpdateSegmentItem":{"additionalProperties":false,"description":"Request body part naming a segment of the branch and its changes, with the fields of updateSegment.","properties":{"description":{"description":"Note for translators. Null clears it.","example":"Label on the sign-in button","type":["string","null"]},"is_not_translatable":{"description":"Whether the segment is excluded from translation.","example":false,"type":"boolean"},"is_plural":{"description":"Whether the segment has plural forms. Becoming singular keeps the OTHER form and removes the other plural forms in all languages.","example":false,"type":"boolean"},"label_ids":{"description":"Replaces the segment's labels with these labels of the workspace; `[]` removes them all. At most 150.","example":["la_0197c8f2-5a6b-7cde-8f12-3456789abcde"],"items":{"example":"la_0197c8f2-5a6b-7cde-8f12-3456789abcde","maxLength":150,"minLength":0,"pattern":"^la_[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}$","type":"string"},"maxItems":150,"type":"array","uniqueItems":true},"segment_id":{"description":"The segment to change. It must have a key in the branch.","example":"seg_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^seg_[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}$","type":"string"},"texts":{"additionalProperties":{"$ref":"#/components/schemas/UpdateSegmentText"},"description":"The texts to change, by language code; languages left out keep their text. `variants` replaces a language's text, and `[]` clears it.","example":{"de":{"variants":[{"content":"Anmelden"}]}},"type":"object"}},"required":["segment_id"],"type":"object"},"Capabilities":{"description":"What a project accepts: its type, the largest file it imports and its native file formats. Computed from the project type, so it has no timestamps.","properties":{"max_import_file_bytes":{"description":"Largest file the project imports, in bytes. Applies to each file inside a ZIP archive too.","example":10485760,"format":"int64","type":"integer"},"object_type":{"description":"Always `CAPABILITIES`.","enum":["CAPABILITIES"],"example":"CAPABILITIES","type":"string"},"project_id":{"description":"The project these capabilities belong to.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"},"project_type":{"$ref":"#/components/schemas/ProjectType","description":"The project's type."},"resource_formats":{"description":"The project's native file formats.","example":[{"extensions":[".xml"],"format":"ANDROID_XML","is_segment_creation_available":true,"is_standalone_creation_available":true}],"items":{"$ref":"#/components/schemas/FormatCapabilities"},"type":"array"}},"required":["max_import_file_bytes","object_type","project_id","project_type","resource_formats"],"type":"object"},"CaseSensitivity":{"description":"How a term form is matched with regard to case:\n  - SENSITIVE: only text of the same case matches.\n  - PERMISSIVE: text of any case matches, and a case difference is flagged as a hint.\n  - INSENSITIVE: text of any case matches.\n","enum":["SENSITIVE","PERMISSIVE","INSENSITIVE"],"type":"string"},"CommentLanguages":{"description":"Which exported files carry comments: `ALL` every file, `SOURCE` only the file of the source language.","enum":["ALL","SOURCE"],"type":"string"},"ContentConnectionStatus":{"description":"Public values of the existing ContentConnectionStatus configuration.","enum":["ACTIVE","SUSPENDED","REVOKED"],"type":"string"},"ContentFilterType":{"description":"Public values of the existing ContentFilterType configuration.","enum":["INCLUDE","EXCLUDE"],"type":"string"},"ContentPathFilter":{"description":"One stored provider selection rule in the integration configuration.","properties":{"type":{"$ref":"#/components/schemas/ContentFilterType","description":"Whether the provider value is included or excluded.","example":"INCLUDE"},"value":{"description":"Stored provider path or selection pattern. Interpretation follows the provider's existing selection workflow.","example":"**","type":"string"}},"required":["type","value"],"type":"object"},"ContentfulEnvironment":{"description":"A provider-discovered Contentful environment.","properties":{"key":{"description":"External Contentful environment key.","example":"master","type":"string"},"object_type":{"description":"Always `CONTENTFUL_ENVIRONMENT`.","enum":["CONTENTFUL_ENVIRONMENT"],"example":"CONTENTFUL_ENVIRONMENT","type":"string"}},"required":["key","object_type"],"type":"object"},"ContentfulEnvironmentCollection":{"description":"One bounded provider discovery page.","properties":{"data":{"description":"The list of items in this page.","example":[{"key":"master","object_type":"CONTENTFUL_ENVIRONMENT"}],"items":{"$ref":"#/components/schemas/ContentfulEnvironment"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"ContentfulLanguage":{"description":"A provider-discovered Contentful language.","properties":{"code":{"description":"Original provider locale code.","example":"de-DE","type":"string"},"fallback_code":{"description":"Original provider fallback locale code.","example":"en-US","type":["string","null"]},"is_source":{"description":"Whether this is the provider source locale.","example":false,"type":"boolean"},"language_code":{"description":"Matched LingoHub language code; null when the provider locale is unsupported.","example":"de-DE","type":["string","null"]},"object_type":{"description":"Always `CONTENTFUL_LANGUAGE`.","enum":["CONTENTFUL_LANGUAGE"],"example":"CONTENTFUL_LANGUAGE","type":"string"}},"required":["code","fallback_code","is_source","language_code","object_type"],"type":"object"},"ContentfulLanguageCollection":{"description":"One bounded provider discovery page.","properties":{"data":{"description":"The list of items in this page.","example":[{"code":"de-DE","fallback_code":"en-US","is_source":false,"language_code":"de-DE","object_type":"CONTENTFUL_LANGUAGE"}],"items":{"$ref":"#/components/schemas/ContentfulLanguage"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"ContentfulSpace":{"description":"A provider-discovered Contentful space.","properties":{"key":{"description":"External Contentful space key.","example":"example-space","type":"string"},"name":{"description":"Space display name.","example":"Website","type":"string"},"object_type":{"description":"Always `CONTENTFUL_SPACE`.","enum":["CONTENTFUL_SPACE"],"example":"CONTENTFUL_SPACE","type":"string"}},"required":["key","name","object_type"],"type":"object"},"ContentfulSpaceCollection":{"description":"One bounded provider discovery page.","properties":{"data":{"description":"The list of items in this page.","example":[{"key":"example-space","name":"Website","object_type":"CONTENTFUL_SPACE"}],"items":{"$ref":"#/components/schemas/ContentfulSpace"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"ContextImage":{"description":"A visual context image attached to segments of a project, giving translators and AI agents visual context for the text they work on.","properties":{"app_version":{"description":"Client-reported application version of the last stored capture.","example":"2.1.0","type":["string","null"]},"attachments":{"description":"The segments the image is attached to, with their highlight boxes. A match LingoHub only suggested counts once someone accepts it.","example":[{"highlight_boxes":[{"height":48,"left":40,"top":120,"width":200}],"segment_id":"seg_0197c8f2-5a6b-7cde-8f12-3456789abcde"}],"items":{"$ref":"#/components/schemas/ContextImageAttachment"},"type":"array"},"capture_key":{"description":"Client-chosen screen identity, scoped to this project language; null for ordinary uploads.","example":"checkout/payment-sheet","type":["string","null"]},"captured_at":{"description":"When the current image file was stored. Metadata edits and unchanged captures do not move this timestamp; null for historical uploads.","example":"2026-10-08T10:30:00.123Z","format":"date-time","type":["string","null"]},"content_hash":{"description":"SHA-256 hex of the stored image bytes; null for historical uploads.","example":"0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef","type":["string","null"]},"created_at":{"description":"Timestamp when the context image was created.","example":"2025-01-15T10:30:00.123Z","format":"date-time","type":"string"},"description":{"description":"Optional description of what the image shows.","example":"Screenshot of the checkout screen showing the payment options.","maxLength":4096,"minLength":0,"type":["string","null"]},"height":{"description":"Height of the image in pixels.","example":720,"format":"int32","type":"integer"},"id":{"description":"Unique identifier of the context image.","example":"ci_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^ci_[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}$","type":"string"},"language_code":{"description":"Language of the UI text shown in the image. Attachments link to segment texts of this language.","example":"en","type":"string"},"name":{"description":"Display name of the context image (defaults to the uploaded file's name).","example":"checkout-screen.png","maxLength":4096,"minLength":0,"type":"string"},"object_type":{"description":"Always `CONTEXT_IMAGE`.","enum":["CONTEXT_IMAGE"],"example":"CONTEXT_IMAGE","type":"string"},"project_id":{"description":"Unique identifier of the project this context image belongs to.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"},"updated_at":{"description":"Timestamp when the context image was last updated.","example":"2025-06-20T14:45:00.123Z","format":"date-time","type":"string"},"upload_status":{"$ref":"#/components/schemas/ContextImageUploadStatus","description":"Processing state of the uploaded image file.","example":"DONE"},"url":{"description":"URL of the image at its original size, loadable as returned. Anyone holding the URL can view the image. Null while the upload is still processing or when it failed.","example":"https://imagedelivery.net/abc/production/context_images/ci_0197c8f2-5a6b-7cde-8f12-3456789abcde/checkout-screen.png/con8192x8192","type":["string","null"]},"width":{"description":"Width of the image in pixels.","example":1280,"format":"int32","type":"integer"}},"required":["app_version","attachments","capture_key","captured_at","content_hash","created_at","description","height","id","language_code","name","object_type","project_id","updated_at","upload_status","url","width"],"type":"object"},"ContextImageAttachment":{"description":"A segment the context image is attached to, at the segment's text in the image's language.","properties":{"highlight_boxes":{"description":"Where the segment's text appears in the image, in pixels. Empty when no place is marked.","example":[{"height":48,"left":40,"top":120,"width":200}],"items":{"$ref":"#/components/schemas/ContextImageHighlightBox"},"type":"array"},"segment_id":{"description":"Unique identifier of the attached segment.","example":"seg_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^seg_[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}$","type":"string"}},"required":["highlight_boxes","segment_id"],"type":"object"},"ContextImageCaptureKey":{"additionalProperties":false,"description":"One key as looked up by the mobile SDK, optionally scoped to an iOS table.","properties":{"key":{"description":"Absolute resource key, matched exactly.","example":"checkout.title","maxLength":50000,"minLength":0,"type":"string"},"table":{"description":"iOS table name without file extension; null matches across the default branch.","example":"app.messages","maxLength":16384,"minLength":0,"type":["string","null"]}},"required":["key"],"type":"object"},"ContextImageCaptureOutcome":{"description":"CREATED stores a new image; REPLACED stores a new file at the same image identity; UNCHANGED leaves all stored data and upload usage unchanged.","enum":["CREATED","REPLACED","UNCHANGED"],"type":"string"},"ContextImageCollection":{"description":"A list of context images.","properties":{"data":{"description":"The list of items in this page.","example":[{"app_version":"2.1.0","attachments":[{"highlight_boxes":[{"height":48,"left":40,"top":120,"width":200}],"segment_id":"seg_0197c8f2-5a6b-7cde-8f12-3456789abcde"}],"capture_key":"checkout/payment-sheet","captured_at":"2026-10-08T10:30:00.123Z","content_hash":"0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef","created_at":"2025-01-15T10:30:00.123Z","description":"Screenshot of the checkout screen showing the payment options.","height":720,"id":"ci_0197c8f2-5a6b-7cde-8f12-3456789abcde","language_code":"en","name":"checkout-screen.png","object_type":"CONTEXT_IMAGE","project_id":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","updated_at":"2025-06-20T14:45:00.123Z","upload_status":"DONE","url":"https://imagedelivery.net/abc/production/context_images/ci_0197c8f2-5a6b-7cde-8f12-3456789abcde/checkout-screen.png/con8192x8192","width":1280}],"items":{"$ref":"#/components/schemas/ContextImage"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"ContextImageFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+context_image[created_at]","-context_image[created_at]","+context_image[name]","-context_image[name]","+context_image[updated_at]","-context_image[updated_at]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/ContextImageFilterGroup"}},"type":"object"},"ContextImageFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/ContextImageFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/ContextImageFilterClause"},"minItems":1,"type":"array"},"context_image[capture_key]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"context_image[captured_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"context_image[created_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"context_image[has_attachments]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_false":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_true":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"}},"type":"object"},"context_image[id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^ci_[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}$","type":"string"},"_in":{"items":{"pattern":"^ci_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^ci_[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}$","type":"string"},"_nin":{"items":{"pattern":"^ci_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"context_image[language_code]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_gt":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_in":{"items":{"type":"string"},"minItems":1,"type":"array"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nin":{"items":{"type":"string"},"minItems":1,"type":"array"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"context_image[name]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"context_image[updated_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"context_image[upload_status]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["PROCESSING","DONE","ERROR"],"type":"string"},"_in":{"items":{"enum":["PROCESSING","DONE","ERROR"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["PROCESSING","DONE","ERROR"],"type":"string"},"_nin":{"items":{"enum":["PROCESSING","DONE","ERROR"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"}},"type":"object"},"ContextImageFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/ContextImageFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/ContextImageFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"ContextImageHighlightBox":{"description":"A region of the image in whole pixels, measured from its top left corner. The box must lie inside the image.","properties":{"height":{"description":"Height of the box.","example":48,"format":"int32","minimum":1,"type":"integer"},"left":{"description":"Distance of the box's left edge from the image's left edge.","example":40,"format":"int32","minimum":0,"type":"integer"},"top":{"description":"Distance of the box's top edge from the image's top edge.","example":120,"format":"int32","minimum":0,"type":"integer"},"width":{"description":"Width of the box.","example":200,"format":"int32","minimum":1,"type":"integer"}},"required":["height","left","top","width"],"type":"object"},"ContextImageRenderedString":{"additionalProperties":false,"description":"One rendered string and its candidate keys. Exactly one matching segment gives a KEY_BASED link; ambiguity gives suggestions. With no key match, exact text matches give suggestions, or TEXT_BASED links when auto_connect_suggestions is true.","properties":{"highlight_box":{"description":"Where the string appears in the image. The boxes of all rendered strings that hit the same segment become its highlight boxes.","oneOf":[{"$ref":"#/components/schemas/ContextImageHighlightBox"},{"type":"null"}]},"keys":{"description":"Candidate SDK keys; an empty list uses text matching.","example":[{"key":"checkout.title","table":"app.messages"}],"items":{"$ref":"#/components/schemas/ContextImageCaptureKey"},"maxItems":10,"minItems":0,"type":"array"},"text":{"description":"The text as rendered on the screen.","example":"Pay now","maxLength":50000,"minLength":0,"type":"string"}},"required":["keys","text"],"type":"object"},"ContextImageUpload":{"description":"A visual context image attached to segments of a project, giving translators and AI agents visual context for the text they work on.","properties":{"app_version":{"description":"Client-reported application version of the last stored capture.","example":"2.1.0","type":["string","null"]},"attachments":{"description":"The segments the image is attached to, with their highlight boxes. Links that text recognition finds after the upload aren't in it yet.","example":[{"highlight_boxes":[{"height":48,"left":40,"top":120,"width":200}],"segment_id":"seg_0197c8f2-5a6b-7cde-8f12-3456789abcde"}],"items":{"$ref":"#/components/schemas/ContextImageAttachment"},"type":"array"},"capture_key":{"description":"Client-chosen screen identity, scoped to this project language; null for ordinary uploads.","example":"checkout/payment-sheet","type":["string","null"]},"captured_at":{"description":"When the current image file was stored. Metadata edits and unchanged captures do not move this timestamp; null for historical uploads.","example":"2026-10-08T10:30:00.123Z","format":"date-time","type":["string","null"]},"content_hash":{"description":"SHA-256 hex of the stored image bytes; null for historical uploads.","example":"0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef","type":["string","null"]},"created_at":{"description":"Timestamp when the context image was created.","example":"2025-01-15T10:30:00.123Z","format":"date-time","type":"string"},"description":{"description":"Optional description of what the image shows.","example":"Screenshot of the checkout screen showing the payment options.","maxLength":4096,"minLength":0,"type":["string","null"]},"height":{"description":"Height of the image in pixels.","example":720,"format":"int32","type":"integer"},"id":{"description":"Unique identifier of the context image.","example":"ci_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^ci_[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}$","type":"string"},"language_code":{"description":"Language of the UI text shown in the image. Attachments link to segment texts of this language.","example":"en","type":"string"},"name":{"description":"Display name of the context image (defaults to the uploaded file's name).","example":"checkout-screen.png","maxLength":4096,"minLength":0,"type":"string"},"object_type":{"description":"Always `CONTEXT_IMAGE`.","enum":["CONTEXT_IMAGE"],"example":"CONTEXT_IMAGE","type":"string"},"outcome":{"$ref":"#/components/schemas/ContextImageCaptureOutcome","description":"What this upload did.","example":"CREATED"},"project_id":{"description":"Unique identifier of the project this context image belongs to.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"},"updated_at":{"description":"Timestamp when the context image was last updated.","example":"2025-06-20T14:45:00.123Z","format":"date-time","type":"string"},"upload_status":{"$ref":"#/components/schemas/ContextImageUploadStatus","description":"Processing state of the uploaded image file.","example":"DONE"},"url":{"description":"URL of the image at its original size, loadable as returned. Anyone holding the URL can view the image. Null while the upload is still processing or when it failed.","example":"https://imagedelivery.net/abc/production/context_images/ci_0197c8f2-5a6b-7cde-8f12-3456789abcde/checkout-screen.png/con8192x8192","type":["string","null"]},"width":{"description":"Width of the image in pixels.","example":1280,"format":"int32","type":"integer"}},"required":["app_version","attachments","capture_key","captured_at","content_hash","created_at","description","height","id","language_code","name","object_type","outcome","project_id","updated_at","upload_status","url","width"],"type":"object"},"ContextImageUploadStatus":{"description":"Processing state of the uploaded image file:\n  - PROCESSING: the image file is still being stored\n  - DONE: the image file is stored and its `url` is available\n  - ERROR: storing the image file failed\n","enum":["PROCESSING","DONE","ERROR"],"type":"string"},"CreateBackup":{"additionalProperties":false,"description":"Request body to schedule a snapshot of the ready branch with a required display name.","properties":{"name":{"description":"Display name retained with the snapshot.","example":"Before release","maxLength":999,"minLength":1,"type":"string"}},"required":["name"],"type":"object"},"CreateBackupRestore":{"additionalProperties":false,"description":"Request body to restore languages of a succeeded backup into a branch of the same project.","properties":{"backup_id":{"description":"The succeeded backup to restore, of the branch's project.","example":"bkp_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^bkp_[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}$","type":"string"},"language_codes":{"description":"The languages to restore, each one the backup has; each language once.","example":["en","de"],"items":{"example":"en","type":"string"},"maxItems":1000,"minItems":1,"type":"array","uniqueItems":true}},"required":["backup_id","language_codes"],"type":"object"},"CreateBranch":{"additionalProperties":false,"description":"Request body to create a branch in a project, empty or as a copy of another branch of the project.","properties":{"name":{"description":"Display name of the new branch; unique in the project.","example":"feature/checkout","maxLength":4096,"minLength":0,"type":"string"},"starting_point_branch_id":{"description":"A branch of the same project whose initial copy has finished; the new branch gets a copy of its files, keys, languages and texts. Without it the branch starts empty, with only the source language.","example":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":["string","null"]}},"required":["name"],"type":"object"},"CreateBranchGitIntegration":{"additionalProperties":false,"description":"Request body to bind an existing non-default project branch to Git and queue its initial import.","properties":{"git_branch":{"description":"Remote Git branch validated through the current project connection.","example":"feature/checkout","maxLength":255,"minLength":0,"pattern":"^[^\\x00]*$","type":"string"}},"required":["git_branch"],"type":"object"},"CreateCodeCommitAuthentication":{"additionalProperties":false,"description":"Request body to create an AWS CodeCommit authentication. The credential is stored without a remote check.","properties":{"access_token":{"description":"Write-only provider credential. Saved without a remote validity check. Format: accessKey:secretKey or accessKey:secretKey:sessionToken.","example":"provider-credential","maxLength":8192,"minLength":1,"type":"string"},"name":{"description":"Display name for the stored authentication.","example":"Internal Git setup","maxLength":255,"minLength":1,"type":"string"},"provider":{"description":"Selects this shape of the body.","enum":["AWS_CODE_COMMIT"],"example":"AWS_CODE_COMMIT","type":"string"},"region":{"description":"Existing CodeCommit region setting.","example":"us-east-1","maxLength":255,"minLength":1,"type":"string"}},"required":["access_token","name","provider","region"],"type":"object"},"CreateContentfulProject":{"additionalProperties":false,"description":"Request body to create a Contentful project through its existing integration workflow.","properties":{"ai_context":{"description":"Project AI context.","example":"Help for our customers.","maxLength":512,"minLength":0,"type":["string","null"]},"authentication_id":{"description":"Workspace-owned authentication for this provider.","example":"iau_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^iau_[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}$","type":"string"},"color":{"description":"Optional icon color; omitted or null assigns a random color.","example":"#FF5733","maxLength":7,"minLength":7,"pattern":"#[0-9a-fA-F]{6}","type":["string","null"]},"environment_key":{"description":"The environment's `key` from listContentfulEnvironments; it becomes the name of the default branch.","example":"master","maxLength":255,"minLength":1,"type":"string"},"name":{"description":"Project name.","example":"Product help","maxLength":255,"minLength":2,"type":"string"},"path_filters":{"description":"Complete include/exclude selection. Empty selects no provider resources.","example":[{"type":"INCLUDE","value":"**"}],"items":{"$ref":"#/components/schemas/SetContentFilter"},"maxItems":1000,"minItems":0,"type":"array"},"source_language_code":{"description":"Source language.","example":"en","type":"string"},"space_key":{"description":"The space's `key` from listContentfulSpaces.","example":"x7pqr2abcd","maxLength":255,"minLength":1,"type":"string"},"space_name":{"description":"The space's `name` from listContentfulSpaces, shown in LingoHub.","example":"Product content","maxLength":255,"minLength":1,"type":"string"},"stack_id":{"description":"Optional existing shared stack to create the project in; it must use the requested source language (or have none yet), and missing target languages are added to it. Omit or send null to create a new stack of the project's own.","example":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stack_[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}$","type":["string","null"]},"target_language_codes":{"description":"Distinct target languages, excluding the source.","example":["de"],"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["authentication_id","environment_key","name","path_filters","source_language_code","space_key","space_name","target_language_codes"],"type":"object"},"CreateCrispHelpdeskAuthentication":{"additionalProperties":false,"description":"Request body to create a Crisp Helpdesk authentication. The credentials are validated with Crisp first.","properties":{"identifier":{"description":"Crisp plugin identifier.","example":"plugin-identifier","maxLength":255,"minLength":1,"type":"string"},"key":{"description":"Crisp plugin key. Never returned.","example":"provider-key","maxLength":8192,"minLength":1,"type":"string"},"name":{"description":"Authentication display name.","example":"Internal content test","maxLength":255,"minLength":1,"type":"string"},"provider":{"description":"Selects this shape of the body.","enum":["CRISP_HELPDESK"],"example":"CRISP_HELPDESK","type":"string"},"website_key":{"description":"External Crisp website key, not a LingoHub identity.","example":"website-key","maxLength":255,"minLength":1,"type":"string"}},"required":["identifier","key","name","provider","website_key"],"type":"object"},"CreateCrispHelpdeskProject":{"additionalProperties":false,"description":"Request body to create a Crisp Helpdesk project through its existing integration workflow.","properties":{"ai_context":{"description":"Project AI context.","example":"Help for our customers.","maxLength":512,"minLength":0,"type":["string","null"]},"authentication_id":{"description":"Workspace-owned authentication for this provider.","example":"iau_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^iau_[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}$","type":"string"},"color":{"description":"Optional icon color; omitted or null assigns a random color.","example":"#FF5733","maxLength":7,"minLength":7,"pattern":"#[0-9a-fA-F]{6}","type":["string","null"]},"is_publish_on_push":{"description":"Whether approved translations are published on push rather than saved as drafts.","example":false,"type":"boolean"},"name":{"description":"Project name.","example":"Product help","maxLength":255,"minLength":2,"type":"string"},"source_language_code":{"description":"Source language.","example":"en","type":"string"},"stack_id":{"description":"Optional existing shared stack to create the project in; it must use the requested source language (or have none yet), and missing target languages are added to it. Omit or send null to create a new stack of the project's own.","example":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stack_[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}$","type":["string","null"]},"target_language_codes":{"description":"Distinct target languages, excluding the source.","example":["de"],"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["authentication_id","is_publish_on_push","name","source_language_code","target_language_codes"],"type":"object"},"CreateExport":{"additionalProperties":false,"description":"Request body to export the branch's files.","properties":{"language_codes":{"description":"Languages to export, each one the branch has; null or empty exports all of the branch's languages.","example":["de","fr"],"items":{"type":"string"},"type":["array","null"]}},"type":"object"},"CreateGitLabAuthentication":{"additionalProperties":false,"description":"Request body to create a GitLab authentication. The token is stored without a remote check.","properties":{"access_token":{"description":"Write-only provider credential. Saved without a remote validity check.","example":"provider-credential","maxLength":8192,"minLength":1,"type":"string"},"is_self_hosted":{"description":"Whether to use the existing self-hosted GitLab configuration.","example":false,"type":"boolean"},"name":{"description":"Display name for the stored authentication.","example":"Internal Git setup","maxLength":255,"minLength":1,"type":"string"},"provider":{"description":"Selects this shape of the body.","enum":["GITLAB"],"example":"GITLAB","type":"string"},"provider_url":{"description":"Provider base URL, required for self-hosted GitLab. Otherwise ignored, preserving the existing hosted default.","example":"https://gitlab.example.com","maxLength":4096,"minLength":0,"type":["string","null"]}},"required":["access_token","is_self_hosted","name","provider"],"type":"object"},"CreateGlossary":{"additionalProperties":false,"description":"Request body to create a glossary.","properties":{"language_codes":{"description":"Languages the glossary covers, each once; every one a supported locale (GET /v2/locales lists them).","example":["en","de"],"items":{"example":"de","type":"string"},"type":"array","uniqueItems":true},"name":{"description":"Name of the glossary; it doesn't have to be unique.","example":"Product terms","maxLength":1000,"minLength":2,"type":"string"}},"required":["language_codes","name"],"type":"object"},"CreateHubSpotProject":{"additionalProperties":false,"description":"Request body to create a HubSpot project through its existing integration workflow.","properties":{"ai_context":{"description":"Project AI context.","example":"Help for our customers.","maxLength":512,"minLength":0,"type":["string","null"]},"authentication_id":{"description":"Workspace-owned authentication for this provider.","example":"iau_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^iau_[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}$","type":"string"},"color":{"description":"Optional icon color; omitted or null assigns a random color.","example":"#FF5733","maxLength":7,"minLength":7,"pattern":"#[0-9a-fA-F]{6}","type":["string","null"]},"enabled_content_types":{"description":"Enabled HubSpot content types.","example":["BLOG_POST"],"items":{"$ref":"#/components/schemas/HubSpotContentType"},"maxItems":100,"minItems":1,"type":"array"},"is_publish_on_push":{"description":"Whether approved translations are published on push rather than saved as drafts.","example":false,"type":"boolean"},"name":{"description":"Project name.","example":"Product help","maxLength":255,"minLength":2,"type":"string"},"path_filters":{"description":"Complete include/exclude selection. Empty selects no provider resources.","example":[{"type":"INCLUDE","value":"**"}],"items":{"$ref":"#/components/schemas/SetContentFilter"},"maxItems":1000,"minItems":0,"type":"array"},"source_language_code":{"description":"Source language.","example":"en","type":"string"},"stack_id":{"description":"Optional existing shared stack to create the project in; it must use the requested source language (or have none yet), and missing target languages are added to it. Omit or send null to create a new stack of the project's own.","example":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stack_[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}$","type":["string","null"]},"target_language_codes":{"description":"Distinct target languages, excluding the source.","example":["de"],"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["authentication_id","enabled_content_types","is_publish_on_push","name","path_filters","source_language_code","target_language_codes"],"type":"object"},"CreateIntegrationAuthentication":{"description":"Request body to create a stored integration authentication. `provider` selects the shape of the body. GitHub is not accepted: its authentications come from installing the GitHub app (getGitHubInstallationLink).","discriminator":{"mapping":{"AWS_CODE_COMMIT":"#/components/schemas/CreateCodeCommitAuthentication","AZURE":"#/components/schemas/CreateTokenAuthentication","BITBUCKET":"#/components/schemas/CreateTokenAuthentication","CONTENTFUL":"#/components/schemas/CreateTokenAuthentication","CRISP_HELPDESK":"#/components/schemas/CreateCrispHelpdeskAuthentication","GITLAB":"#/components/schemas/CreateGitLabAuthentication","HUBSPOT":"#/components/schemas/CreateTokenAuthentication","STORYBLOK":"#/components/schemas/CreateStoryblokAuthentication","STRIPO":"#/components/schemas/CreateTokenAuthentication","ZENDESK":"#/components/schemas/CreateZendeskAuthentication"},"propertyName":"provider"},"oneOf":[{"$ref":"#/components/schemas/CreateTokenAuthentication"},{"$ref":"#/components/schemas/CreateGitLabAuthentication"},{"$ref":"#/components/schemas/CreateCodeCommitAuthentication"},{"$ref":"#/components/schemas/CreateStoryblokAuthentication"},{"$ref":"#/components/schemas/CreateZendeskAuthentication"},{"$ref":"#/components/schemas/CreateCrispHelpdeskAuthentication"}],"type":"object"},"CreateInvitation":{"additionalProperties":false,"description":"Request body to invite one email address using the authenticated API-key actor as inviter.","properties":{"email":{"description":"Invitee email address; normalized to lowercase by the shared invitation flow.","example":"alex@example.com","format":"email","maxLength":4096,"minLength":1,"type":"string"},"message":{"description":"Optional invitation message.","example":"Welcome to the translation team.","maxLength":4096,"minLength":0,"type":["string","null"]},"stack_assignment":{"description":"Optional complete stack assignment. Omission or null invites to the workspace only.","oneOf":[{"$ref":"#/components/schemas/SetInvitationStackAssignment"},{"type":"null"}]},"workspace_role_id":{"description":"Non-owner workspace role.","example":"rol_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^rol_[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}$","type":"string"}},"required":["email","workspace_role_id"],"type":"object"},"CreateKey":{"additionalProperties":false,"description":"Request body to create a key in a file, with a new segment and its source text.","properties":{"group_key":{"description":"The group of the key, in formats with one group only (`key_type` REQUIRED_KEY_WITH_GROUP: PO, Qt TS, INI, Twine). Leaving it out or null creates the key without a group.","example":"checkout","maxLength":50000,"minLength":0,"type":["string","null"]},"is_plural":{"default":false,"description":"Whether the segment has plural forms. The file's format must allow it. Defaults to false.","example":false,"type":["boolean","null"]},"key":{"description":"The full key, as the Key object shows it: nested keys join their parts with dots and put a part that is empty or contains a dot, a double quote or a backslash in double quotes, escaping quotes and backslashes with a backslash. The project's key normalization applies. At most 128 parts and 49,999 characters as stored, with the group.","example":"navigation.sign_in","maxLength":100000,"minLength":1,"type":"string"},"label_ids":{"description":"Labels of the workspace to add to the new segment. The stack's automations can add more.","example":["la_0197c8f2-5a6b-7cde-8f12-3456789abcde"],"items":{"example":"la_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^la_[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}$","type":"string"},"maxItems":150,"minItems":0,"type":["array","null"],"uniqueItems":true},"source_variants":{"description":"The source text, one variant per device and plural form, in this order. Leaving it out, null or `[]` creates the key with an empty source text. At most 1,048,576 characters in total.","example":[{"content":"Sign in","device":"OTHER","plural_form":"OTHER"}],"items":{"$ref":"#/components/schemas/WriteTextVariant"},"maxItems":1000,"minItems":0,"type":["array","null"]}},"required":["key"],"type":"object"},"CreateKeysBulk":{"additionalProperties":false,"description":"Request body to create up to 150 keys in one file.","properties":{"items":{"description":"The keys to create, in this order, each like the body of createKey. At most 1,048,576 characters of source text in total.","example":[{"key":"navigation.sign_in","source_variants":[{"content":"Sign in"}]},{"key":"navigation.sign_out","source_variants":[{"content":"Sign out"}]}],"items":{"$ref":"#/components/schemas/CreateKey"},"maxItems":150,"minItems":1,"type":"array"}},"required":["items"],"type":"object"},"CreateLabel":{"additionalProperties":false,"description":"Request body to create a label.","properties":{"ai_context":{"description":"Tells LINA what segments with this label are about. A LINA with an AI engine reads it when its `context.is_labels_enabled` is on; LingoHub-managed LINAs always do.","example":"Short, catchy texts for marketing campaigns","maxLength":256,"minLength":0,"type":["string","null"]},"color":{"description":"Hex color code of the new label (e.g., #FF5733). Without it, the label gets one of the default label colors.","example":"#FF5733","maxLength":7,"minLength":7,"pattern":"#[0-9a-fA-F]{6}","type":"string"},"name":{"description":"Display name of the new label. Must be unique within the workspace (case-insensitive).","example":"Marketing","maxLength":255,"minLength":2,"type":"string"}},"required":["name"],"type":"object"},"CreateLina":{"additionalProperties":false,"description":"Request body to create a LINA whose engines you choose.","properties":{"color":{"description":"Color of the LINA's icon, as a hexadecimal RGB value. Defaults to `#C084FC`.","example":"#C084FC","pattern":"^#[0-9A-Fa-f]{6}$","type":"string"},"context":{"$ref":"#/components/schemas/CreateLinaContext","description":"Which context the LINA sends along with each text it translates. A source left out is enabled when the engine supports it.","example":{"is_translation_memory_enabled":false}},"description":{"description":"Description of the LINA.","example":"Product translator","maxLength":1024,"minLength":0,"type":["string","null"]},"glossary_id":{"description":"Glossary of the workspace the LINA uses for translation and for the terminology check. Left out or null: none.","example":"gls_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^gls_[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}$","type":["string","null"]},"is_tm_match_enabled":{"description":"Whether the LINA reuses a translation-memory match with exactly the same source text instead of translating it. Defaults to `false`.","example":false,"type":"boolean"},"language_engine_overrides":{"description":"Engines the LINA uses for single target languages instead of `linguistic_engine_id`, one per language. Defaults to none.","example":[{"language_code":"de","linguistic_engine_id":"engine_0197c8f2-5a6b-7cde-8f12-3456789abcde"}],"items":{"$ref":"#/components/schemas/SetLinaLanguageEngine"},"maxItems":1000,"minItems":0,"type":"array"},"linguistic_engine_id":{"description":"Engine the LINA translates with; it must be enabled in the workspace (GET /v2/linguistic-engines lists them).","example":"engine_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^engine_[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}$","type":"string"},"name":{"description":"Name of the LINA; it must be unique in the workspace, ignoring case.","example":"Localization","maxLength":255,"minLength":1,"type":"string"},"restricted_stack_ids":{"description":"Stacks of the workspace the LINA may work in; an empty list allows none. Left out or null: every stack.","example":["stack_0197c8f2-5a6b-7cde-8f12-3456789abcde"],"items":{"pattern":"^stack_[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}$","type":"string"},"maxItems":1000,"minItems":0,"type":["array","null"],"uniqueItems":true},"style_guide_id":{"description":"Style guide of the workspace the LINA follows when translating and for the style checks. Left out or null: none.","example":"sg_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^sg_[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}$","type":["string","null"]}},"required":["linguistic_engine_id","name"],"type":"object"},"CreateLinaContext":{"additionalProperties":false,"description":"Request body to choose the context a LINA sends along with each text. A source left out is enabled when the engine supports it.","properties":{"is_glossary_enabled":{"description":"Send the terms of the LINA's glossary.","example":true,"type":"boolean"},"is_labels_enabled":{"description":"Send the labels of the segment.","example":true,"type":"boolean"},"is_segments_enabled":{"description":"Send the description of the segment.","example":true,"type":"boolean"},"is_style_guide_enabled":{"description":"Send the rules of the LINA's style guide.","example":true,"type":"boolean"},"is_translation_memory_enabled":{"description":"Send similar translations from the translation memory.","example":false,"type":"boolean"}},"type":"object"},"CreateLinaExecution":{"additionalProperties":false,"description":"Request body to pre-translate segments of a branch with the stack's LINA.","properties":{"only_empty":{"description":"Translate only texts without a translation; `false` also translates texts that already have one.","example":true,"type":"boolean"},"segment_ids":{"description":"Segments of the branch to translate. Left out, every segment of the branch is translated.","example":["seg_0197c8f2-5a6b-7cde-8f12-3456789abcde"],"items":{"pattern":"^seg_[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}$","type":"string"},"maxItems":1000,"minItems":1,"type":"array","uniqueItems":true},"target_language_codes":{"description":"Target languages of the branch to translate into; each gets its own run.","example":["de","fr"],"items":{"description":"Language code that uniquely identifies a locale. Valid examples would be 'en', 'en-GB', 'de', 'de-DE' etc. according to [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).","type":"string"},"maxItems":1000,"minItems":1,"type":"array","uniqueItems":true}},"required":["only_empty","target_language_codes"],"type":"object"},"CreateProject":{"additionalProperties":false,"description":"Request body to create a file-based project.","properties":{"ai_context":{"description":"Context that tells LINA what the project is about; LINA gets it together with the stack's context.","example":"A translation project for our mobile app.","maxLength":512,"minLength":0,"type":["string","null"]},"color":{"description":"Hex color code of the project icon. Optional: omit it and the server assigns a random color.","example":"#FF5733","maxLength":7,"minLength":7,"pattern":"#[0-9a-fA-F]{6}","type":["string","null"]},"name":{"description":"The name of the project, 2 to 255 characters.","example":"My Project","maxLength":255,"minLength":2,"type":"string"},"source_language_code":{"description":"The source language code for the project.","example":"en","type":"string"},"stack_id":{"description":"Optional destination stack. Omit or send null to create a new private stack. The destination must use the requested source language (or have no source yet). An occupied private stack cannot accept another project. Existing stack configuration and access are retained; missing target languages are added stack-wide.","example":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stack_[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}$","type":["string","null"]},"target_language_codes":{"description":"Language codes of the project's target languages, at most 1000.","example":["en-US","de","de-AT"],"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"},"type":{"$ref":"#/components/schemas/FileProjectType","description":"The project's file format; it decides which files the project accepts and can't be changed later.","example":"GO_I18N_JSON"}},"required":["name","source_language_code","target_language_codes","type"],"type":"object"},"CreateProjectGitIntegration":{"additionalProperties":false,"description":"Request body to connect an existing project and queue its initial import.","properties":{"git_authentication_id":{"description":"Existing Git authentication in this workspace.","example":"iau_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^iau_[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}$","type":"string"},"git_branch":{"description":"Remote branch; the existing connection flow also renames the default LingoHub branch to this name.","example":"main","maxLength":255,"minLength":0,"pattern":"^[^\\x00]*$","type":"string"},"name":{"description":"Repository name.","example":"application","maxLength":4096,"minLength":0,"pattern":"^[^\\x00]*$","type":"string"},"namespace":{"description":"Repository namespace; empty where the provider has no namespace.","example":"lingohub","maxLength":4096,"minLength":0,"pattern":"^[^\\x00]*$","type":"string"},"path_filters":{"description":"Complete initial path selection; an empty list selects no files.","example":[{"type":"INCLUDE","value":"locales/**"}],"items":{"$ref":"#/components/schemas/SetGitFilter"},"maxItems":1000,"minItems":0,"type":"array"}},"required":["git_authentication_id","git_branch","name","namespace","path_filters"],"type":"object"},"CreateResource":{"additionalProperties":false,"description":"Request body to create an empty file.","properties":{"format":{"$ref":"#/components/schemas/ResourceFormat","description":"File format. getProjectCapabilities lists the accepted values: the project's `resource_formats` whose `is_standalone_creation_available` is true.","example":"I18NEXT_JSON"},"language_code_separator":{"description":"How the language is joined to the file name: `_`, `-` or `.`; Android XML also accepts `-r`.","enum":["_","-",".","-r"],"example":"_","maxLength":2,"minLength":1,"type":"string"},"path":{"description":"Relative resource path template, preserved exactly. Include %{locale}; a mixed locale/file basename also needs %{language_code_separator}. Parent folders are created automatically.","example":"locales/%{locale}/checkout.json","maxLength":4096,"minLength":1,"type":"string"}},"required":["format","language_code_separator","path"],"type":"object"},"CreateStack":{"additionalProperties":false,"description":"Request body to create a shared (`PUBLIC`) stack.","properties":{"ai_context":{"description":"Context that tells LINA what the stack is about, given with the project's own.","example":"Mobile apps for retail banking.","maxLength":512,"minLength":0,"type":["string","null"]},"color":{"description":"Hex color code of the stack icon. Optional: omit it and the server assigns a random color.","example":"#FCAFE3","maxLength":7,"minLength":7,"pattern":"#[0-9a-fA-F]{6}","type":["string","null"]},"name":{"description":"Display name of the new stack.","example":"My Brand New Stack","maxLength":999,"minLength":2,"type":"string"},"source_language_code":{"description":"The source language of the stack. Every stack has one: a project can only join a stack whose source language is its own. Use supported language codes from `/v2/locales`; add target languages through the stack languages.","example":"en","type":"string"}},"required":["name","source_language_code"],"type":"object"},"CreateStoryblokAuthentication":{"additionalProperties":false,"description":"Request body to create a Storyblok authentication. The token is validated with Storyblok first.","properties":{"access_token":{"description":"Provider access token. Validated and stored through the existing encrypted credential path; never returned.","example":"provider-token","maxLength":8192,"minLength":1,"type":"string"},"name":{"description":"Authentication display name.","example":"Internal content test","maxLength":255,"minLength":1,"type":"string"},"provider":{"description":"Selects this shape of the body.","enum":["STORYBLOK"],"example":"STORYBLOK","type":"string"},"region":{"$ref":"#/components/schemas/StoryblokRegion","description":"Existing Storyblok hosting region.","example":"EUROPE"}},"required":["access_token","name","provider","region"],"type":"object"},"CreateStoryblokProject":{"additionalProperties":false,"description":"Request body to create a Storyblok project through its existing integration workflow.","properties":{"ai_context":{"description":"Project AI context.","example":"Help for our customers.","maxLength":512,"minLength":0,"type":["string","null"]},"authentication_id":{"description":"Workspace-owned authentication for this provider.","example":"iau_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^iau_[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}$","type":"string"},"color":{"description":"Optional icon color; omitted or null assigns a random color.","example":"#FF5733","maxLength":7,"minLength":7,"pattern":"#[0-9a-fA-F]{6}","type":["string","null"]},"name":{"description":"Project name.","example":"Product help","maxLength":255,"minLength":2,"type":"string"},"path_filters":{"description":"Complete include/exclude selection. Empty selects no provider resources.","example":[{"type":"INCLUDE","value":"**"}],"items":{"$ref":"#/components/schemas/SetContentFilter"},"maxItems":1000,"minItems":0,"type":"array"},"source_language_code":{"description":"Source language.","example":"en","type":"string"},"space_key":{"description":"The space id from Storyblok's settings.","example":"287364","maxLength":255,"minLength":1,"type":"string"},"space_name":{"description":"The space's name, shown in LingoHub.","example":"Product content","maxLength":255,"minLength":1,"type":"string"},"stack_id":{"description":"Optional existing shared stack to create the project in; it must use the requested source language (or have none yet), and missing target languages are added to it. Omit or send null to create a new stack of the project's own.","example":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stack_[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}$","type":["string","null"]},"target_language_codes":{"description":"Distinct target languages, excluding the source.","example":["de"],"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["authentication_id","name","path_filters","source_language_code","space_key","space_name","target_language_codes"],"type":"object"},"CreateStripoProject":{"additionalProperties":false,"description":"Request body to create a Stripo project through its existing integration workflow.","properties":{"ai_context":{"description":"Project AI context.","example":"Help for our customers.","maxLength":512,"minLength":0,"type":["string","null"]},"authentication_id":{"description":"Workspace-owned authentication for this provider.","example":"iau_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^iau_[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}$","type":"string"},"color":{"description":"Optional icon color; omitted or null assigns a random color.","example":"#FF5733","maxLength":7,"minLength":7,"pattern":"#[0-9a-fA-F]{6}","type":["string","null"]},"name":{"description":"Project name.","example":"Product help","maxLength":255,"minLength":2,"type":"string"},"path_filters":{"description":"Complete include/exclude selection. Empty selects no provider resources.","example":[{"type":"INCLUDE","value":"**"}],"items":{"$ref":"#/components/schemas/SetContentFilter"},"maxItems":1000,"minItems":0,"type":"array"},"source_language_code":{"description":"Source language.","example":"en","type":"string"},"stack_id":{"description":"Optional existing shared stack to create the project in; it must use the requested source language (or have none yet), and missing target languages are added to it. Omit or send null to create a new stack of the project's own.","example":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stack_[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}$","type":["string","null"]},"target_language_codes":{"description":"Distinct target languages, excluding the source.","example":["de"],"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["authentication_id","name","path_filters","source_language_code","target_language_codes"],"type":"object"},"CreateStyleGuide":{"additionalProperties":false,"description":"Request body to create a new LingoHub style guide.","properties":{"ai_context":{"description":"Additional context provided to the AI to guide translation style and tone.","example":"Translate in a friendly and approachable tone suitable for a SaaS product.","maxLength":512,"minLength":0,"type":["string","null"]},"audience_description":{"description":"Description of the target audience for this style guide.","example":"Software developers and technical users familiar with localization workflows.","maxLength":16384,"minLength":0,"type":["string","null"]},"name":{"description":"Display name of the style guide.","example":"Workspace Style Guide","maxLength":128,"minLength":2,"type":"string"},"rules":{"description":"Style rules of the style guide. Omitted rules, or all of them when `rules` is omitted, are NOT_SPECIFIED.","oneOf":[{"$ref":"#/components/schemas/CreateStyleGuideRules"},{"type":"null"}]}},"required":["name"],"type":"object"},"CreateStyleGuideRules":{"additionalProperties":false,"description":"Style rules of a new style guide. An omitted rule is NOT_SPECIFIED.","properties":{"age_group":{"description":"Target age group for translation style and vocabulary choice.","example":"ADULTS","oneOf":[{"$ref":"#/components/schemas/StyleGuideAgeGroup"},{"type":"null"}]},"audience":{"description":"Target audience for translation style and vocabulary choice.","example":"DEVELOPERS","oneOf":[{"$ref":"#/components/schemas/StyleGuideAudience"},{"type":"null"}]},"domain":{"description":"Content domain to guide context-specific AI behavior.","example":"TECHNOLOGY","oneOf":[{"$ref":"#/components/schemas/StyleGuideDomain"},{"type":"null"}]},"formality":{"description":"Desired level of formality for translated text.","example":"FORMAL","oneOf":[{"$ref":"#/components/schemas/StyleGuideFormality"},{"type":"null"}]},"grammatical_person":{"description":"Grammatical person to use for translated text.","example":"SECOND_PERSON_SINGULAR","oneOf":[{"$ref":"#/components/schemas/StyleGuideGrammaticalPerson"},{"type":"null"}]},"language_complexity":{"description":"Desired level of language complexity for generated text.","example":"STANDARD","oneOf":[{"$ref":"#/components/schemas/StyleGuideLanguageComplexity"},{"type":"null"}]},"literal_translation":{"description":"Specifies how literally the source text should be translated.","example":"NEUTRAL","oneOf":[{"$ref":"#/components/schemas/StyleGuideLiteralTranslation"},{"type":"null"}]},"text_type":{"description":"Type of text being translated.","example":"SOFTWARE_UI","oneOf":[{"$ref":"#/components/schemas/StyleGuideTextType"},{"type":"null"}]},"vocabulary_type":{"description":"Type of vocabulary to guide AI word choice.","example":"TECHNICAL","oneOf":[{"$ref":"#/components/schemas/StyleGuideVocabularyType"},{"type":"null"}]},"voice":{"description":"Preferred grammatical voice for translated text.","example":"ACTIVE","oneOf":[{"$ref":"#/components/schemas/StyleGuideVoice"},{"type":"null"}]}},"type":"object"},"CreateTerm":{"additionalProperties":false,"description":"Request body to create a term with its forms.","properties":{"ai_context":{"description":"Context for AI translation, e.g. what the term means.","example":"Final step of the purchase flow.","maxLength":256,"minLength":0,"type":["string","null"]},"enforcement_status":{"description":"How strictly the term is applied. Defaults to ENFORCED.","example":"ENFORCED","oneOf":[{"$ref":"#/components/schemas/EnforcementStatus"},{"type":"null"}]},"forms":{"description":"The term's forms. A language has at most one preferred form; an untranslatable term's forms have no language.","example":[{"case_sensitivity":"SENSITIVE","form_type":"FULL_FORM","grammatical_gender":"FEMININE","grammatical_number":"SINGULAR","inherited_by":["de-AT","de-CH"],"language_code":"de","match_expression":"Kasse[n]?","matching":"AUTOMATIC","part_of_speech":"NOUN","text":"Kasse","usage_status":"PREFERRED"}],"items":{"$ref":"#/components/schemas/CreateTermForm"},"maxItems":100,"minItems":1,"type":"array"},"type":{"$ref":"#/components/schemas/TermType","description":"Whether the term is translated.","example":"TRANSLATABLE"}},"required":["forms","type"],"type":"object"},"CreateTermForm":{"additionalProperties":false,"description":"Request body to add a form to a term.","properties":{"case_sensitivity":{"description":"How the form is matched with regard to case. Defaults to SENSITIVE, as in the app.","example":"SENSITIVE","oneOf":[{"$ref":"#/components/schemas/CaseSensitivity"},{"type":"null"}]},"form_type":{"description":"Lexical type of the form.","example":"FULL_FORM","oneOf":[{"$ref":"#/components/schemas/TermFormType"},{"type":"null"}]},"grammatical_gender":{"description":"Grammatical gender of the form.","example":"FEMININE","oneOf":[{"$ref":"#/components/schemas/GrammaticalGender"},{"type":"null"}]},"grammatical_number":{"description":"Grammatical number of the form.","example":"SINGULAR","oneOf":[{"$ref":"#/components/schemas/GrammaticalNumber"},{"type":"null"}]},"inherited_by":{"description":"Languages of the glossary without a form of their own that use this form, e.g. `de-AT` and `de-CH` for a `de` form. Only for the preferred form of a translatable term.","example":["de-AT","de-CH"],"items":{"type":"string"},"maxItems":100,"minItems":0,"type":["array","null"]},"language_code":{"description":"Language of the form, one of the glossary's languages. Required for a translatable term; must be omitted for an untranslatable one, whose forms have no language.","example":"de","type":["string","null"]},"match_expression":{"description":"The regular expression a `CUSTOM` matching uses.","example":"Kasse[n]?","maxLength":256,"minLength":0,"type":["string","null"]},"matching":{"description":"How the form is matched against text. `AUTOMATIC` only for languages that support it (and only if the languages in `inherited_by` do too); left out, it is `AUTOMATIC` where possible and `PREFIX` otherwise, as in the app.","example":"AUTOMATIC","oneOf":[{"$ref":"#/components/schemas/Matching"},{"type":"null"}]},"part_of_speech":{"description":"Part of speech of the form.","example":"NOUN","oneOf":[{"$ref":"#/components/schemas/PartOfSpeech"},{"type":"null"}]},"text":{"description":"The form's text.","example":"Kasse","maxLength":4096,"minLength":1,"type":"string"},"usage_status":{"description":"How the form should be used. Defaults to PREFERRED.","example":"PREFERRED","oneOf":[{"$ref":"#/components/schemas/UsageStatus"},{"type":"null"}]}},"required":["text"],"type":"object"},"CreateTokenAuthentication":{"additionalProperties":false,"description":"Request body to create an authentication from an access token. Azure DevOps and Bitbucket store the token without a remote check; Contentful, HubSpot and Stripo validate it with the provider first.","properties":{"access_token":{"description":"Write-only provider access token; never returned.","example":"provider-token","maxLength":8192,"minLength":1,"type":"string"},"name":{"description":"Display name for the stored authentication.","example":"Company Azure DevOps","maxLength":255,"minLength":1,"type":"string"},"provider":{"description":"Selects this shape of the body.","enum":["AZURE","BITBUCKET","CONTENTFUL","HUBSPOT","STRIPO"],"example":"AZURE","type":"string"}},"required":["access_token","name","provider"],"type":"object"},"CreateWebhookEndpoint":{"additionalProperties":false,"description":"Request body to create a webhook endpoint. Send stack_id or project_id to receive the events of one stack or project, or neither for the whole workspace.","properties":{"description":{"description":"Description of the endpoint.","example":"Localization notifications","maxLength":4096,"minLength":0,"type":["string","null"]},"event_types":{"description":"Events to receive, as listed by listWebhookEventTypes, or [\"*\"] for all events, including those added later.","example":["project.created"],"items":{"example":"project.created","type":"string"},"minItems":1,"type":"array"},"project_id":{"description":"Limits deliveries to the events of this project. At most one of stack_id and project_id.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":["string","null"]},"stack_id":{"description":"Limits deliveries to the events of this stack and its projects. At most one of stack_id and project_id.","example":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stack_[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}$","type":["string","null"]},"url":{"description":"Public HTTPS address deliveries are sent to.","example":"https://example.com/hooks","maxLength":2048,"minLength":0,"type":"string"}},"required":["event_types","url"],"type":"object"},"CreateZendeskAuthentication":{"additionalProperties":false,"description":"Request body to create a Zendesk authentication. The credentials are validated with Zendesk first.","properties":{"access_token":{"description":"Provider access token. Validated and stored through the existing encrypted credential path; never returned.","example":"provider-token","maxLength":8192,"minLength":1,"type":"string"},"name":{"description":"Authentication display name.","example":"Internal content test","maxLength":255,"minLength":1,"type":"string"},"provider":{"description":"Selects this shape of the body.","enum":["ZENDESK"],"example":"ZENDESK","type":"string"},"provider_url":{"description":"Canonical HTTPS Zendesk tenant origin. Custom aliases, paths, credentials and ports are not accepted by this V2 creation route.","example":"https://example.zendesk.com","maxLength":2048,"minLength":1,"pattern":"^https://[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.zendesk\\.com/?$","type":"string"},"username":{"description":"Existing Zendesk API username; use the same value as the integration setup.","example":"agent@example.com","maxLength":255,"minLength":1,"type":"string"}},"required":["access_token","name","provider","provider_url","username"],"type":"object"},"CreateZendeskProject":{"additionalProperties":false,"description":"Request body to create a Zendesk project through its existing integration workflow.","properties":{"ai_context":{"description":"Project AI context.","example":"Help for our customers.","maxLength":512,"minLength":0,"type":["string","null"]},"authentication_id":{"description":"Workspace-owned authentication for this provider.","example":"iau_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^iau_[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}$","type":"string"},"color":{"description":"Optional icon color; omitted or null assigns a random color.","example":"#FF5733","maxLength":7,"minLength":7,"pattern":"#[0-9a-fA-F]{6}","type":["string","null"]},"name":{"description":"Project name.","example":"Product help","maxLength":255,"minLength":2,"type":"string"},"path_filters":{"description":"Complete include/exclude selection. Empty selects no provider resources.","example":[{"type":"INCLUDE","value":"**"}],"items":{"$ref":"#/components/schemas/SetContentFilter"},"maxItems":1000,"minItems":0,"type":"array"},"source_language_code":{"description":"Source language.","example":"en","type":"string"},"stack_id":{"description":"Optional existing shared stack to create the project in; it must use the requested source language (or have none yet), and missing target languages are added to it. Omit or send null to create a new stack of the project's own.","example":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stack_[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}$","type":["string","null"]},"target_language_codes":{"description":"Distinct target languages, excluding the source.","example":["de"],"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["authentication_id","name","path_filters","source_language_code","target_language_codes"],"type":"object"},"CsvFileFormatConfiguration":{"description":"How CSV files are read and written.","properties":{"delimiter":{"description":"The character between the columns. Null on older projects that never stored one.","example":";","type":["string","null"]},"description_header":{"description":"The header of the column with the descriptions. Null: imports take the column headed Description or Comment, and exports leave the header empty.","example":"description","type":["string","null"]},"is_import_detection_enabled":{"description":"Whether imports may update CSV settings from detected file content.","example":true,"type":"boolean"},"is_status_exported":{"description":"Whether CSV exports include status information.","example":false,"type":"boolean"},"key_header":{"description":"The header of the column with the keys. Null: imports take the column headed Title, Key or Id, and exports leave the header empty.","example":"key","type":["string","null"]},"quote":{"description":"The character that encloses a value. Null on older projects that never stored one.","example":"\"","type":["string","null"]}},"required":["delimiter","description_header","is_import_detection_enabled","is_status_exported","key_header","quote"],"type":"object"},"DetachContextImage":{"additionalProperties":false,"description":"Request body to detach a context image from one or more segments.","properties":{"include_suggestions":{"description":"Whether SUGGESTION links of these segments are dismissed as well. Defaults to false: detaching removes attachments only, so pending suggestions are never dismissed by accident.","example":false,"type":["boolean","null"]},"segment_ids":{"description":"Identifiers of the segments to detach the context image from. Segments the image is not attached to are skipped.","example":["seg_0197c8f2-5a6b-7cde-8f12-3456789abcde"],"items":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a segment, a valid value would be : seg_0197c8f2-5a6b-7cde-8f12-3456789abcde","example":"seg_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^seg_[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}$","type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"required":["segment_ids"],"type":"object"},"Distribution":{"description":"Delivers releases of a project's translations over the CDN to the apps of one environment and type.","properties":{"created_at":{"description":"When the distribution was created.","example":"2026-09-30T00:00:00.123Z","format":"date-time","type":"string"},"environment":{"$ref":"#/components/schemas/DistributionEnvironment","description":"The environment whose apps get the distribution.","example":"PRODUCTION"},"id":{"description":"Unique identifier of the distribution.","example":"dtb_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^dtb_[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}$","type":"string"},"is_fallback":{"description":"Whether the distribution is the fallback: it serves every app version that no version range matches.","example":false,"type":"boolean"},"name":{"description":"Name of the distribution.","example":"Production native files","type":"string"},"object_type":{"description":"Always `DISTRIBUTION`.","enum":["DISTRIBUTION"],"example":"DISTRIBUTION","type":"string"},"project_id":{"description":"Unique identifier of the project the distribution belongs to.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"},"type":{"$ref":"#/components/schemas/DistributionType","description":"What the distribution delivers: the project's files or the data of a mobile SDK.","example":"NATIVE_FORMAT"},"updated_at":{"description":"When the distribution was last changed.","example":"2026-09-30T00:00:00.123Z","format":"date-time","type":"string"},"version_from":{"description":"Lower bound of the app versions the distribution serves, inclusive; null on the fallback.","example":"1.0.0","type":["string","null"]},"version_to":{"description":"Upper bound of the app versions the distribution serves, exclusive; null on the fallback.","example":"2.0.0","type":["string","null"]}},"required":["created_at","environment","id","is_fallback","name","object_type","project_id","type","updated_at","version_from","version_to"],"type":"object"},"DistributionCollection":{"description":"A list of distributions with cursor pagination.","properties":{"data":{"description":"The list of items in this page.","example":[{"created_at":"2026-09-30T00:00:00.123Z","environment":"PRODUCTION","id":"dtb_0197c8f2-5a6b-7cde-8f12-3456789abcde","is_fallback":false,"name":"Production native files","object_type":"DISTRIBUTION","project_id":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","type":"NATIVE_FORMAT","updated_at":"2026-09-30T00:00:00.123Z","version_from":"1.0.0","version_to":"2.0.0"}],"items":{"$ref":"#/components/schemas/Distribution"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"DistributionEnvironment":{"description":"Stored distribution environment.","enum":["DEVELOPMENT","TEST","STAGING","PRODUCTION"],"type":"string"},"DistributionFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+distribution[created_at]","-distribution[created_at]","+distribution[is_fallback]","-distribution[is_fallback]","+distribution[name]","-distribution[name]","+distribution[updated_at]","-distribution[updated_at]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/DistributionFilterGroup"}},"type":"object"},"DistributionFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/DistributionFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/DistributionFilterClause"},"minItems":1,"type":"array"},"distribution[created_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"distribution[environment]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["DEVELOPMENT","TEST","STAGING","PRODUCTION"],"type":"string"},"_in":{"items":{"enum":["DEVELOPMENT","TEST","STAGING","PRODUCTION"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["DEVELOPMENT","TEST","STAGING","PRODUCTION"],"type":"string"},"_nin":{"items":{"enum":["DEVELOPMENT","TEST","STAGING","PRODUCTION"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"distribution[id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^dtb_[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}$","type":"string"},"_in":{"items":{"pattern":"^dtb_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^dtb_[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}$","type":"string"},"_nin":{"items":{"pattern":"^dtb_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"distribution[is_fallback]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_false":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_true":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"}},"type":"object"},"distribution[name]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"distribution[type]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["NATIVE_FORMAT","MOBILE_SDK_ANDROID","MOBILE_SDK_IOS"],"type":"string"},"_in":{"items":{"enum":["NATIVE_FORMAT","MOBILE_SDK_ANDROID","MOBILE_SDK_IOS"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["NATIVE_FORMAT","MOBILE_SDK_ANDROID","MOBILE_SDK_IOS"],"type":"string"},"_nin":{"items":{"enum":["NATIVE_FORMAT","MOBILE_SDK_ANDROID","MOBILE_SDK_IOS"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"distribution[updated_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"distribution[version_from]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"distribution[version_to]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"}},"type":"object"},"DistributionFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/DistributionFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/DistributionFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"DistributionRelease":{"description":"A release of a distribution: the project's translations of one branch, exported as an archive the CDN can serve.","properties":{"activated_at":{"description":"When the release went live; null when it isn't the live release.","example":"2026-09-30T00:00:00.123Z","format":"date-time","type":["string","null"]},"archive_size_kib":{"description":"Size of the archive in KiB, rounded up; null until the release has succeeded.","example":42,"format":"int32","type":["integer","null"]},"branch_name":{"description":"The branch the release was made from, under its name at that time.","example":"main","type":"string"},"created_at":{"description":"When the release was created.","example":"2026-09-30T00:00:00.123Z","format":"date-time","type":"string"},"distribution_id":{"description":"Unique identifier of the distribution the release belongs to.","example":"dtb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^dtb_[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}$","type":"string"},"download_url":{"description":"URL of the release's archive, valid for 24 hours; reading the release again gives a fresh one. Null unless the release SUCCEEDED.","example":"https://storage.lingohub.com/distribution-releases/rel_0197c8f2-5a6b-7cde-8f12-3456789abcde.zip?token=abc","type":["string","null"]},"download_url_expires_at":{"description":"When `download_url` stops working; null when there is no URL.","example":"2026-10-01T00:00:00.123Z","format":"date-time","type":["string","null"]},"export_id":{"description":"Unique identifier of the export that made the release's archive; read it for the reason of a failure and its log lines. Null once the export is past the workspace's plan retention and deleted.","example":"reg_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^reg_[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}$","type":["string","null"]},"file_count":{"description":"Number of files in the archive; null until the release has succeeded.","example":12,"format":"int32","type":["integer","null"]},"id":{"description":"Unique identifier of the release.","example":"rel_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^rel_[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}$","type":"string"},"key_counts":{"description":"Retained successful-entry key counts; null when unavailable. The total sums file entries, so separate language files count separately while bundled languages count once. Historical releases are not backfilled.","example":{"entries":[{"file_path":"messages.json","key_count":500,"language_codes":["en","de"]}],"total":500},"oneOf":[{"$ref":"#/components/schemas/DistributionReleaseKeyCountSnapshot"},{"type":"null"}]},"language_codes":{"description":"Languages of the release.","example":["en","de"],"items":{"description":"Language code that uniquely identifies a locale. Valid examples would be 'en', 'en-GB', 'de', 'de-DE' etc. according to [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).","type":"string"},"type":"array"},"name":{"description":"Name of the release.","example":"September release","type":"string"},"object_type":{"description":"Always `DISTRIBUTION_RELEASE`.","enum":["DISTRIBUTION_RELEASE"],"example":"DISTRIBUTION_RELEASE","type":"string"},"project_id":{"description":"Unique identifier of the project the release belongs to.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"},"status":{"$ref":"#/components/schemas/DistributionReleaseStatus","description":"Status of the release.","example":"SUCCEEDED"},"updated_at":{"description":"When the release was last changed, including when it went live.","example":"2026-09-30T00:00:00.123Z","format":"date-time","type":"string"}},"required":["activated_at","archive_size_kib","branch_name","created_at","distribution_id","download_url","download_url_expires_at","export_id","file_count","id","key_counts","language_codes","name","object_type","project_id","status","updated_at"],"type":"object"},"DistributionReleaseCollection":{"description":"A list of distribution releases with cursor pagination.","properties":{"data":{"description":"The list of items in this page.","example":[{"activated_at":"2026-09-30T00:00:00.123Z","archive_size_kib":42,"branch_name":"main","created_at":"2026-09-30T00:00:00.123Z","distribution_id":"dtb_0197c8f2-5a6b-7cde-8f12-3456789abcde","download_url":"https://storage.lingohub.com/distribution-releases/rel_0197c8f2-5a6b-7cde-8f12-3456789abcde.zip?token=abc","download_url_expires_at":"2026-10-01T00:00:00.123Z","export_id":"reg_0197c8f2-5a6b-7cde-8f12-3456789abcde","file_count":12,"id":"rel_0197c8f2-5a6b-7cde-8f12-3456789abcde","key_counts":{"entries":[{"file_path":"messages.json","key_count":500,"language_codes":["en","de"]}],"total":500},"language_codes":["en","de"],"name":"September release","object_type":"DISTRIBUTION_RELEASE","project_id":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","status":"SUCCEEDED","updated_at":"2026-09-30T00:00:00.123Z"}],"items":{"$ref":"#/components/schemas/DistributionRelease"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"DistributionReleaseFileKeyCount":{"description":"Selected logical keys in one successful release file; does not infer separate counts inside bundled language files.","properties":{"file_path":{"description":"Retained exported file path.","example":"en.json","type":"string"},"key_count":{"description":"Selected logical keys in this entry, counted once across its languages. Zero means an empty selection.","example":500,"format":"int32","minimum":0,"type":"integer"},"language_codes":{"description":"Languages selected for this file; bundled files can contain several.","example":["en","de"],"items":{"description":"Language code that uniquely identifies a locale. Valid examples would be 'en', 'en-GB', 'de', 'de-DE' etc. according to [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).","example":"en","type":"string"},"type":"array"}},"required":["file_path","key_count","language_codes"],"type":"object"},"DistributionReleaseFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+distribution_release[branch_name]","-distribution_release[branch_name]","+distribution_release[created_at]","-distribution_release[created_at]","+distribution_release[name]","-distribution_release[name]","+distribution_release[updated_at]","-distribution_release[updated_at]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/DistributionReleaseFilterGroup"}},"type":"object"},"DistributionReleaseFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/DistributionReleaseFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/DistributionReleaseFilterClause"},"minItems":1,"type":"array"},"distribution_release[activated_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"distribution_release[archive_size_kib]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"_gt":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"_gte":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"_in":{"items":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"minItems":1,"type":"array"},"_lt":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"_lte":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"_ne":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"_nin":{"items":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"minItems":1,"type":"array"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"distribution_release[branch_name]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"distribution_release[created_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"distribution_release[file_count]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"_gt":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"_gte":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"_in":{"items":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"minItems":1,"type":"array"},"_lt":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"_lte":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"_ne":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"_nin":{"items":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"minItems":1,"type":"array"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"distribution_release[id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^rel_[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}$","type":"string"},"_in":{"items":{"pattern":"^rel_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^rel_[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}$","type":"string"},"_nin":{"items":{"pattern":"^rel_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"distribution_release[name]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"distribution_release[status]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["PROCESSING","SUCCEEDED","FAILED"],"type":"string"},"_in":{"items":{"enum":["PROCESSING","SUCCEEDED","FAILED"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["PROCESSING","SUCCEEDED","FAILED"],"type":"string"},"_nin":{"items":{"enum":["PROCESSING","SUCCEEDED","FAILED"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"distribution_release[updated_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"}},"type":"object"},"DistributionReleaseFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/DistributionReleaseFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/DistributionReleaseFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"DistributionReleaseKeyCountSnapshot":{"description":"Retained successful export entry counts. Unknown statistics make the entire snapshot unavailable.","properties":{"entries":{"description":"One count per successful exported file, including combined multi-language files.","example":[{"file_path":"en.json","key_count":500,"language_codes":["en"]}],"items":{"$ref":"#/components/schemas/DistributionReleaseFileKeyCount"},"type":"array"},"total":{"description":"Sum of the entry counts, not a distinct count across separate files or languages.","example":500,"format":"int64","minimum":0,"type":"integer"}},"required":["entries","total"],"type":"object"},"DistributionReleaseStatus":{"description":"`PROCESSING` while the files of the release are exported, then `SUCCEEDED` or `FAILED`.","enum":["PROCESSING","SUCCEEDED","FAILED"],"type":"string"},"DistributionType":{"description":"Stored distribution type.","enum":["NATIVE_FORMAT","MOBILE_SDK_ANDROID","MOBILE_SDK_IOS"],"type":"string"},"EffectiveLanguagePermission":{"description":"Effective member language access after stack text permissions and language defaults are evaluated.","enum":["NO_ACCESS","READ_ACCESS","RESTRICTED_ACCESS","FULL_ACCESS"],"example":"READ_ACCESS","type":"string"},"EnforcementStatus":{"description":"Controls how strictly a term is applied during translation:\n  - ENFORCED: the term is visible in the editor, used in the translation process, and checked in the quality checks.\n  - INFORMATIONAL: the term is visible in the editor and used in the translation process, but not checked in the quality checks.\n","enum":["ENFORCED","INFORMATIONAL"],"type":"string"},"Error":{"description":"RFC 9457 problem details. `code` identifies the problem type (one per `type` URL); `errors` lists rejected fields or parameters; `required_permission` names the permission a 403 lacked.","properties":{"code":{"$ref":"#/components/schemas/ErrorCode","description":"Machine-readable problem type.","example":"resource_not_found"},"detail":{"description":"Human-readable explanation of this occurrence of the problem.","example":"Resource with ID 'pr_0197c8f2-5a6b-7cde-8f12-3456789abcde' was not found.","type":"string"},"errors":{"description":"Rejected fields or parameters. Present when the problem concerns specific fields or parameters.","example":[{"code":"minLength","detail":"must be at least 2 characters long","parameter":"limit","pointer":"#/name"}],"items":{"$ref":"#/components/schemas/FieldError"},"type":"array"},"instance":{"description":"Path of the request that produced the problem.","example":"/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","type":"string"},"request_id":{"description":"Correlation id of the request, also returned in the `X-Request-ID` header. Quote it when contacting support.","example":"f47ac10b-58cc-4372-a567-0e02b2c3d479","type":"string"},"required_permission":{"$ref":"#/components/schemas/RequiredPermission","description":"The permission the API key lacks. Present on 403 responses."},"status":{"description":"HTTP status code.","example":404,"format":"int32","type":"integer"},"title":{"description":"Short, constant summary of the problem type.","example":"Resource not found","type":"string"},"type":{"description":"URL identifying the problem type and pointing to its documentation.","example":"https://api.lingohub.com/errors/resource-not-found","type":"string"}},"required":["code","detail","instance","request_id","status","title","type"],"type":"object"},"ErrorCode":{"description":"Machine-readable problem type of a V2 error response. Each code has a fixed HTTP status and documentation at its `type` URL.","enum":["invalid_json","invalid_parameter","missing_parameter","unknown_parameter","invalid_filter","invalid_cursor","bad_request","missing_api_key","invalid_api_key","expired_api_key","revoked_api_key","disabled_api_key","insufficient_permissions","resource_not_found","route_not_found","method_not_allowed","not_acceptable","precondition_failed","content_too_large","unsupported_media_type","already_exists","idempotency_outcome_unknown","idempotency_key_in_use","stack_not_empty","branch_not_ready","backup_not_ready","backup_in_use","default_branch_protected","owner_membership_protected","source_language_protected","branch_limit_reached","context_image_limit_reached","automation_limit_reached","translation_order_pending","git_integration_not_configured","branch_git_integration_not_configured","git_integration_unauthorized","conflict","validation_failed","idempotency_key_mismatch","rate_limit_exceeded","internal_error","upstream_error","service_unavailable","upstream_timeout"],"type":"string"},"EscapeFileFormatConfiguration":{"description":"How special characters are written.","properties":{"is_character_escaping_enabled":{"description":"Whether file writers escape characters.","example":true,"type":"boolean"}},"required":["is_character_escaping_enabled"],"type":"object"},"Export":{"description":"An export of the branch's files, or a push of them to an integration.","properties":{"branch_id":{"description":"Unique identifier of the branch the export was made from; null once the branch is deleted.","example":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":["string","null"]},"created_at":{"description":"Timestamp when the export was created.","example":"2025-01-15T10:30:00.123Z","format":"date-time","type":"string"},"download_url":{"description":"URL of the zip with the exported files, valid for 24 hours; reading the export again gives a fresh one. Null unless the export SUCCEEDED.","example":"https://storage.lingohub.com/exports/reg_0197c8f2-5a6b-7cde-8f12-3456789abcde?token=abc","type":["string","null"]},"download_url_expires_at":{"description":"When `download_url` stops working. Retrieve the export again for a fresh URL; null when there is no URL.","example":"2025-01-16T10:30:00.123Z","format":"date-time","type":["string","null"]},"git_result":{"description":"Persisted commit, actual Git head branch and any associated pull-request reference for this export's confirmed successful push; null when no complete result was recorded. A later failed or skipped attempt can retain an earlier confirmed result. A null result does not prove that a failed provider request had no remote side effects.","example":null,"oneOf":[{"$ref":"#/components/schemas/ExportGitResult"},{"type":"null"}]},"id":{"description":"Unique identifier of the export.","example":"reg_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^reg_[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}$","type":"string"},"language_codes":{"description":"Languages the export was limited to; null when it includes every language.","example":["de","fr"],"items":{"type":"string"},"type":["array","null"]},"object_type":{"description":"Always `EXPORT`.","enum":["EXPORT"],"example":"EXPORT","type":"string"},"status":{"$ref":"#/components/schemas/ExportStatus","description":"Status of the export.","example":"SUCCEEDED"},"status_details":{"description":"Machine-readable outcome explanation, including failures and explained skips; null when no explanation was recorded or is needed.","example":null,"oneOf":[{"$ref":"#/components/schemas/SyncStatusDetails"},{"type":"null"}]},"updated_at":{"description":"Timestamp when the export was last updated.","example":"2025-06-20T14:45:00.123Z","format":"date-time","type":"string"}},"required":["branch_id","created_at","download_url","download_url_expires_at","git_result","id","language_codes","object_type","status","status_details","updated_at"],"type":"object"},"ExportCollection":{"description":"A list of exports with pagination capability.","properties":{"data":{"description":"The list of items in this page.","example":[{"branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","created_at":"2025-01-15T10:30:00.123Z","download_url":"https://storage.lingohub.com/exports/reg_0197c8f2-5a6b-7cde-8f12-3456789abcde?token=abc","download_url_expires_at":"2025-01-16T10:30:00.123Z","git_result":null,"id":"reg_0197c8f2-5a6b-7cde-8f12-3456789abcde","language_codes":["de","fr"],"object_type":"EXPORT","status":"SUCCEEDED","status_details":null,"updated_at":"2025-06-20T14:45:00.123Z"}],"items":{"$ref":"#/components/schemas/Export"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"ExportEntry":{"description":"One file of an export, in one language or in all of them.","properties":{"content_version":{"description":"Version of the translatable data of this file language when the entry was scheduled (the file's own content_version for a multi-language entry). Compare it with the resource's content_version for the same language: while they are equal, and the export settings are the same, the data behind the file is unchanged. Label assignments and removals can conservatively advance this version even for formats without labels. If inputs change while rendering, the scheduled version is retained as a lower bound. A LingoHub release can still change how a format is rendered; re-export after such a change when byte identity matters. Null for historical entries or entries without a single resource version.","example":42,"format":"int64","type":["integer","null"]},"created_at":{"description":"Timestamp when the entry was created.","example":"2025-01-15T10:30:00.123Z","format":"date-time","type":"string"},"download_url":{"description":"URL of the exported file, valid for 24 hours; reading the entry again gives a fresh one. Null unless the entry SUCCEEDED, which it can also do in a failed export.","example":"https://storage.lingohub.com/export-entries/ree_0197c8f2-5a6b-7cde-8f12-3456789abcde?token=abc","type":["string","null"]},"download_url_expires_at":{"description":"When `download_url` stops working; null when there is no URL.","example":"2026-01-02T10:40:00.123Z","format":"date-time","type":["string","null"]},"export_id":{"description":"Unique identifier of the export the entry belongs to.","example":"reg_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^reg_[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}$","type":"string"},"file_path":{"description":"The file path of the export entry.","example":"en.xliff","type":["string","null"]},"file_size_bytes":{"description":"Generated file byte length before outer archive compression; null for historical entries or entries without a file.","example":2048,"format":"int64","minimum":0,"type":["integer","null"]},"id":{"description":"Unique identifier of the export entry.","example":"ree_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^ree_[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}$","type":"string"},"key_count":{"description":"Selected logical keys in this successful file entry; bundled languages count each key once. Null when no count was recorded. Separate language files have separate counts.","example":500,"format":"int32","minimum":0,"type":["integer","null"]},"language_code":{"description":"Language of the file; null for a file that holds several languages.","example":"en","type":["string","null"]},"object_type":{"description":"Always `EXPORT_ENTRY`.","enum":["EXPORT_ENTRY"],"example":"EXPORT_ENTRY","type":"string"},"resource_id":{"description":"Unique identifier of the resource (file) this entry was exported from, to look up its current content_version. Null for entries without a single resource.","example":"rc_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^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}$","type":["string","null"]},"status":{"$ref":"#/components/schemas/ExportEntryStatus","description":"Current status of the export entry.","example":"SUCCEEDED"},"status_details":{"description":"Machine-readable outcome explanation, including failures and explained skips; null when no explanation was recorded or is needed.","example":null,"oneOf":[{"$ref":"#/components/schemas/SyncStatusDetails"},{"type":"null"}]},"updated_at":{"description":"Timestamp when the entry was last updated.","example":"2025-06-20T14:45:00.123Z","format":"date-time","type":"string"}},"required":["content_version","created_at","download_url","download_url_expires_at","export_id","file_path","file_size_bytes","id","key_count","language_code","object_type","resource_id","status","status_details","updated_at"],"type":"object"},"ExportEntryCollection":{"description":"A list of export entries with pagination capability.","properties":{"data":{"description":"The list of items in this page.","example":[{"content_version":42,"created_at":"2025-01-15T10:30:00.123Z","download_url":"https://storage.lingohub.com/export-entries/ree_0197c8f2-5a6b-7cde-8f12-3456789abcde?token=abc","download_url_expires_at":"2026-01-02T10:40:00.123Z","export_id":"reg_0197c8f2-5a6b-7cde-8f12-3456789abcde","file_path":"en.xliff","file_size_bytes":2048,"id":"ree_0197c8f2-5a6b-7cde-8f12-3456789abcde","key_count":500,"language_code":"en","object_type":"EXPORT_ENTRY","resource_id":"rc_0197c8f2-5a6b-7cde-8f12-3456789abcde","status":"SUCCEEDED","status_details":null,"updated_at":"2025-06-20T14:45:00.123Z"}],"items":{"$ref":"#/components/schemas/ExportEntry"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"ExportEntryFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return.","properties":{"where":{"$ref":"#/components/schemas/ExportEntryFilterGroup"}},"type":"object"},"ExportEntryFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/ExportEntryFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/ExportEntryFilterClause"},"minItems":1,"type":"array"},"export_entry[file_path]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"export_entry[file_size_bytes]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"_gt":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"_gte":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"_in":{"items":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"minItems":1,"type":"array"},"_lt":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"_lte":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"_ne":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"_nin":{"items":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"minItems":1,"type":"array"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"export_entry[key_count]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"_gt":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"_gte":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"_in":{"items":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"minItems":1,"type":"array"},"_lt":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"_lte":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"_ne":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"_nin":{"items":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"minItems":1,"type":"array"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"export_entry[language_code]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_gt":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_in":{"items":{"type":"string"},"minItems":1,"type":"array"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nin":{"items":{"type":"string"},"minItems":1,"type":"array"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"export_entry[resource_id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^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}$","type":"string"},"_in":{"items":{"pattern":"^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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^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}$","type":"string"},"_nin":{"items":{"pattern":"^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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"export_entry[status]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["QUEUED","PROCESSING","SUCCEEDED","FAILED","SKIPPED"],"type":"string"},"_in":{"items":{"enum":["QUEUED","PROCESSING","SUCCEEDED","FAILED","SKIPPED"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["QUEUED","PROCESSING","SUCCEEDED","FAILED","SKIPPED"],"type":"string"},"_nin":{"items":{"enum":["QUEUED","PROCESSING","SUCCEEDED","FAILED","SKIPPED"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"}},"type":"object"},"ExportEntryFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/ExportEntryFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/ExportEntryFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"ExportEntryStatus":{"description":"Status of a single file entry within an export job.","enum":["QUEUED","PROCESSING","SUCCEEDED","FAILED","SKIPPED"],"type":"string"},"ExportFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+export[created_at]","-export[created_at]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/ExportFilterGroup"}},"type":"object"},"ExportFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/ExportFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/ExportFilterClause"},"minItems":1,"type":"array"},"export[created_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"export[id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^reg_[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}$","type":"string"},"_in":{"items":{"pattern":"^reg_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^reg_[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}$","type":"string"},"_nin":{"items":{"pattern":"^reg_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"export[status]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["QUEUED","PROCESSING","SUCCEEDED","PARTIALLY_SUCCEEDED","FAILED","CANCELLED","SKIPPED"],"type":"string"},"_in":{"items":{"enum":["QUEUED","PROCESSING","SUCCEEDED","PARTIALLY_SUCCEEDED","FAILED","CANCELLED","SKIPPED"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["QUEUED","PROCESSING","SUCCEEDED","PARTIALLY_SUCCEEDED","FAILED","CANCELLED","SKIPPED"],"type":"string"},"_nin":{"items":{"enum":["QUEUED","PROCESSING","SUCCEEDED","PARTIALLY_SUCCEEDED","FAILED","CANCELLED","SKIPPED"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"}},"type":"object"},"ExportFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/ExportFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/ExportFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"ExportGitResult":{"description":"The persisted result of a confirmed Git push for this export.","properties":{"commit_sha":{"description":"Commit SHA returned by the Git provider for this export's successful push.","example":"0a1b2c3d4e5f0a1b2c3d4e5f0a1b2c3d4e5f0a1b","type":"string"},"git_branch":{"description":"Actual destination Git branch; for a pull-request push this is the normalized head branch, not the base branch.","example":"lingohub/main","type":"string"},"pull_request_reference":{"description":"Repository-local pull-request reference confirmed by the provider for this export. Null for direct pushes, older exports or a confirmed pull request whose provider response lacks a usable reference. This is a provider reference, not a LingoHub entity ID.","example":"42","type":["string","null"]},"pull_request_url":{"description":"Provider-returned web link for the confirmed pull request, or null when unavailable. No URL is inferred from a branch or credential-bearing connection.","example":"https://github.com/example/translations/pull/42","type":["string","null"]}},"required":["commit_sha","git_branch","pull_request_reference","pull_request_url"],"type":"object"},"ExportJob":{"description":"An export scheduled for asynchronous processing.","properties":{"data":{"$ref":"#/components/schemas/Export","description":"The export this job is processing."},"job_type":{"description":"Always `EXPORT`.","enum":["EXPORT"],"example":"EXPORT","type":"string"},"object_type":{"description":"Always `JOB`.","enum":["JOB"],"example":"JOB","type":"string"}},"required":["data","job_type","object_type"],"type":"object"},"ExportLog":{"description":"A log entry for an export job.","properties":{"content":{"description":"The log message content.","example":"Export started successfully.","type":"string"},"created_at":{"description":"Timestamp when the log entry was created.","example":"2025-01-15T10:30:00.123Z","format":"date-time","type":"string"},"entry_id":{"description":"Unique identifier of the export entry, the file, the line is about; null for a line about the whole export.","example":"ree_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^ree_[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}$","type":["string","null"]},"level":{"$ref":"#/components/schemas/ExportLogLevel","description":"The log level.","example":"INFO"},"object_type":{"description":"Always `EXPORT_LOG`.","enum":["EXPORT_LOG"],"example":"EXPORT_LOG","type":"string"}},"required":["content","created_at","entry_id","level","object_type"],"type":"object"},"ExportLogCollection":{"description":"A list of export log entries with pagination capability.","properties":{"data":{"description":"The list of items in this page.","example":[{"content":"Export started successfully.","created_at":"2025-01-15T10:30:00.123Z","entry_id":"ree_0197c8f2-5a6b-7cde-8f12-3456789abcde","level":"INFO","object_type":"EXPORT_LOG"}],"items":{"$ref":"#/components/schemas/ExportLog"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"ExportLogFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+export_log[created_at]","-export_log[created_at]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/ExportLogFilterGroup"}},"type":"object"},"ExportLogFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/ExportLogFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/ExportLogFilterClause"},"minItems":1,"type":"array"},"export_log[content]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"export_log[created_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"export_log[entry_id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^ree_[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}$","type":"string"},"_in":{"items":{"pattern":"^ree_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^ree_[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}$","type":"string"},"_nin":{"items":{"pattern":"^ree_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"export_log[level]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["INFO","WARN","ERROR"],"type":"string"},"_in":{"items":{"enum":["INFO","WARN","ERROR"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["INFO","WARN","ERROR"],"type":"string"},"_nin":{"items":{"enum":["INFO","WARN","ERROR"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"}},"type":"object"},"ExportLogFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/ExportLogFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/ExportLogFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"ExportLogLevel":{"description":"Severity of an export job log entry.","enum":["INFO","WARN","ERROR"],"type":"string"},"ExportStatus":{"description":"Status of an export. `QUEUED` and `PROCESSING` are pending; the others are final. `SUCCEEDED`: every file was exported and the zip can be downloaded. `PARTIALLY_SUCCEEDED`: a git or content-platform push in which some items failed. `FAILED`: a file failed and the export stopped; `status_details` says why. `CANCELLED`: the project was deleted before the export ran. `SKIPPED`: an integration push found nothing to do.","enum":["QUEUED","PROCESSING","SUCCEEDED","PARTIALLY_SUCCEEDED","FAILED","CANCELLED","SKIPPED"],"type":"string"},"FieldError":{"description":"A rejected field or parameter. `pointer` locates a body field (RFC 6901 JSON Pointer), `parameter` a query, path or header parameter or a field of a multipart upload; both are set for a position inside a JSON-valued parameter such as `filter`.","properties":{"code":{"$ref":"#/components/schemas/FieldErrorCode","description":"Why the field or parameter was rejected.","example":"minLength"},"detail":{"description":"Human-readable description of the problem.","example":"must be at least 2 characters long","type":"string"},"parameter":{"description":"Name of the offending query, path or header parameter, or of the multipart form field.","example":"limit","type":["string","null"]},"pointer":{"description":"JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.","example":"#/name","type":["string","null"]}},"required":["code","detail","parameter","pointer"],"type":"object"},"FieldErrorCode":{"description":"Why a field or parameter was rejected: the JSON Schema keyword of the violated rule, or one of the documented rules that no schema can express.","enum":["required","type","enum","minLength","maxLength","minimum","maximum","pattern","format","additionalProperties","minItems","maxItems","uniqueItems","already_exists","not_found","not_supported","unsupported_file_extension","file_too_large","file_empty","invalid_archive","empty_archive"],"type":"string"},"FileCharset":{"description":"The character encoding of exported files.","enum":["UTF_8","UTF_16"],"type":"string"},"FileNameLanguages":{"description":"Which exported files carry their language code in the file name or path: `ALL` every file, `TARGETS` only the files of the target languages, `NONE` no file.","enum":["ALL","TARGETS","NONE"],"type":"string"},"FileProjectType":{"description":"The file format of a project created with createProject. Integration projects (Contentful, Zendesk, …) are created with their own endpoints.","enum":["ANDROID_XML","IOS_STRINGS","IOS_STRINGS_CATALOG","STANDARD_PROPERTIES","GETTEXT_PO","WINDOWS_RESX","QT_LINGUIST_TS","DEFINE_PHP","STANDARD_INI","STANDARD_ARB","RAILS_YAML","SYMFONY_YAML","STANDARD_JSON","ANGULAR_TRANSLATE_JSON","CHROME_I18N_JSON","GO_I18N_JSON","I18NEXT_JSON","REACT_INTL_JSON","STANDARD_CSV","SINGLE_LANGUAGE_CSV","KEY_VALUE_CSV","STANDARD_XLIFF","STANDARD_XLIFF_2","STANDARD_TXT","TWINE_TXT","STANDARD_MARKDOWN","STANDARD_HTML","STORYBLOK_JSON","SUBTITLE_SRT","SUBTITLE_VTT","DOCUMENT","VUE_I18N_JSON"],"type":"string"},"FormatCapabilities":{"description":"File-format support in this deployment; does not guarantee that a particular file is valid.","properties":{"extensions":{"description":"Accepted filename extensions with leading dots, matched case-insensitively. Empty for formats without a file reader.","example":[".xml"],"items":{"type":"string"},"type":"array"},"format":{"$ref":"#/components/schemas/ResourceFormat","description":"Resource format."},"is_segment_creation_available":{"description":"Whether createKey and createKeysBulk can create independent source segments in this format. False for single-language CSV, which requires complete rows; existing imported-cell text edits remain supported. The current project and permissions must also permit creation.","example":true,"type":"boolean"},"is_standalone_creation_available":{"description":"Whether an empty native file can be created without an uploaded original. The selected project must also allow this format. This does not assert manual source editing support for every format.","example":true,"type":"boolean"}},"required":["extensions","format","is_segment_creation_available","is_standalone_creation_available"],"type":"object"},"GeneralFileFormatConfiguration":{"description":"Options every file format uses.","properties":{"charset":{"description":"The character encoding of exported files. Null on older projects that never stored one.","example":"UTF_8","oneOf":[{"$ref":"#/components/schemas/FileCharset"},{"type":"null"}]},"comment_languages":{"description":"Which exported files carry comments; null: no file does.","example":"SOURCE","oneOf":[{"$ref":"#/components/schemas/CommentLanguages"},{"type":"null"}]},"file_name_languages":{"description":"Which exported files carry their language code in the file name or path. Null on older projects that never stored one.","example":"ALL","oneOf":[{"$ref":"#/components/schemas/FileNameLanguages"},{"type":"null"}]},"indentation":{"description":"Spaces per indentation level, in the formats that indent.","example":2,"format":"int32","type":"integer"},"is_final_newline_enabled":{"description":"Whether output ends in a newline.","example":true,"type":"boolean"},"is_source_used_when_missing":{"description":"Whether to use source content when missing in supported file processing.","example":true,"type":"boolean"}},"required":["charset","comment_languages","file_name_languages","indentation","is_final_newline_enabled","is_source_used_when_missing"],"type":"object"},"GitAutoPushType":{"description":"Automatic completion push behavior for a branch kind.","enum":["NONE","PUSH","PULL_REQUEST"],"type":"string"},"GitBranchType":{"description":"Origin of the stored Git branch binding.","enum":["DEFAULT","USER","SYSTEM"],"type":"string"},"GitConnectionStatus":{"description":"Stored provider authentication lifecycle; not a live connectivity check.","enum":["ACTIVE","SUSPENDED","REVOKED"],"type":"string"},"GitDirectoryEntry":{"description":"A direct child of a provider directory at an explicit commit. Format and language hints inspect only the path, not file contents or other entries.","properties":{"detected_language_codes":{"description":"Language hints detected from this file path alone. Empty means unknown or not an ordinary file. Does not select a source language or inspect multilingual content.","example":["en"],"items":{"description":"Language code that uniquely identifies a locale. Valid examples would be 'en', 'en-GB', 'de', 'de-DE' etc. according to [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).","type":"string"},"type":"array"},"object_type":{"description":"Always `GIT_DIRECTORY_ENTRY`.","enum":["GIT_DIRECTORY_ENTRY"],"example":"GIT_DIRECTORY_ENTRY","type":"string"},"path":{"description":"Path relative to the repository root.","example":"locales/en.json","type":"string"},"possible_project_types":{"description":"Project type candidates based on the file extension. This does not establish importability or inspect content; non-files have no candidates.","example":["STANDARD_JSON","I18NEXT_JSON"],"items":{"$ref":"#/components/schemas/ProjectType"},"type":"array"},"type":{"$ref":"#/components/schemas/GitDirectoryEntryType","description":"Provider-reported entry kind.","example":"FILE"}},"required":["detected_language_codes","object_type","path","possible_project_types","type"],"type":"object"},"GitDirectoryEntryCollection":{"description":"One bounded page of direct directory children at the requested commit.","properties":{"data":{"description":"The list of items in this page.","example":[{"detected_language_codes":["en"],"object_type":"GIT_DIRECTORY_ENTRY","path":"locales/en.json","possible_project_types":["STANDARD_JSON","I18NEXT_JSON"],"type":"FILE"}],"items":{"$ref":"#/components/schemas/GitDirectoryEntry"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"GitDirectoryEntryType":{"description":"Git entry kind; links and submodules are not inspected as ordinary files.","enum":["FILE","DIRECTORY","SYMLINK","SUBMODULE","OTHER"],"type":"string"},"GitExportMode":{"description":"Configured automatic repository export mode.","enum":["NONE","PERIODIC","ON_COMPLETION"],"type":"string"},"GitFilter":{"description":"A glob that includes or excludes repository paths or branches.","properties":{"type":{"$ref":"#/components/schemas/GitFilterType","description":"Whether matching paths or branches are included or excluded.","example":"INCLUDE"},"value":{"description":"The glob.","example":"locales/**","type":"string"}},"required":["type","value"],"type":"object"},"GitFilterType":{"description":"Stored repository filter inclusion or exclusion.","enum":["INCLUDE","EXCLUDE"],"type":"string"},"GitHubInstallationLink":{"description":"The link that installs the LingoHub GitHub App for a workspace. Opening it does not complete the installation; a person finishes it on GitHub.","properties":{"object_type":{"description":"Always `GITHUB_INSTALLATION_LINK`.","enum":["GITHUB_INSTALLATION_LINK"],"example":"GITHUB_INSTALLATION_LINK","type":"string"},"url":{"description":"URL to open in a browser. Never add an API key to it.","example":"https://github.com/apps/lingohub/installations/new","type":"string"}},"required":["object_type","url"],"type":"object"},"GitImportMode":{"description":"Configured automatic repository import mode.","enum":["NONE","AUTOMATIC","PERIODIC"],"type":"string"},"GitProvider":{"description":"Repository provider.","enum":["GITHUB","BITBUCKET","GITLAB","AZURE","AWS_CODE_COMMIT"],"type":"string"},"GitProviderBranch":{"description":"A provider-discovered Git setup item.","properties":{"commit_sha":{"description":"Observed branch head when reported by the provider.","example":"e89d9270a7c0b3f1d2e4f5a6b7c8d9e0f1a2b3c4","type":["string","null"]},"git_branch":{"description":"Branch name in the external repository.","example":"main","type":"string"},"is_protected":{"description":"Provider-reported protection; null when this listing does not report it.","example":true,"type":["boolean","null"]},"object_type":{"description":"Always `GIT_PROVIDER_BRANCH`.","enum":["GIT_PROVIDER_BRANCH"],"example":"GIT_PROVIDER_BRANCH","type":"string"}},"required":["commit_sha","git_branch","is_protected","object_type"],"type":"object"},"GitProviderBranchCollection":{"description":"One bounded provider discovery page.","properties":{"data":{"description":"The list of items in this page.","example":[{"commit_sha":"e89d9270a7c0b3f1d2e4f5a6b7c8d9e0f1a2b3c4","git_branch":"main","is_protected":true,"object_type":"GIT_PROVIDER_BRANCH"}],"items":{"$ref":"#/components/schemas/GitProviderBranch"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"GitPush":{"description":"How LingoHub pushes: as a commit or a pull request, with these message templates. A push that names none of them uses these.","properties":{"auto_push_default_branch_type":{"$ref":"#/components/schemas/GitAutoPushType","description":"How the default branch is pushed when its translations are complete.","example":"PULL_REQUEST"},"auto_push_other_branches_type":{"$ref":"#/components/schemas/GitAutoPushType","description":"How other branches are pushed when their translations are complete.","example":"PUSH"},"commit_description":{"description":"Commit description template; may be empty.","example":"Translations from LingoHub","type":"string"},"commit_message":{"description":"Commit message template.","example":"Update translations","type":"string"},"pull_request_branch":{"description":"Template of the branch a pull request comes from.","example":"lingohub/translations","type":"string"},"pull_request_description":{"description":"Pull request description template; may be empty.","example":"Translations from LingoHub","type":"string"},"pull_request_title":{"description":"Pull request title template.","example":"Update translations","type":"string"},"push_type":{"$ref":"#/components/schemas/PushType","description":"Whether a push commits to the branch or opens a pull request.","example":"PULL_REQUEST"}},"required":["auto_push_default_branch_type","auto_push_other_branches_type","commit_description","commit_message","pull_request_branch","pull_request_description","pull_request_title","push_type"],"type":"object"},"GitRepository":{"description":"A repository the connection can reach. Its `namespace` and `name` name it in createProjectGitIntegration and in the branch and folder lookups.","properties":{"name":{"description":"Repository path name.","example":"app","type":"string"},"namespace":{"description":"The repository's namespace: its owner or workspace, an Azure organization/project, or a GitLab group path (`group/subgroup`); empty for CodeCommit.","example":"company","type":"string"},"object_type":{"description":"Always `GIT_REPOSITORY`.","enum":["GIT_REPOSITORY"],"example":"GIT_REPOSITORY","type":"string"},"url":{"description":"Repository URL where supplied; null for CodeCommit. Connection setup accepts namespace/name.","example":"https://github.com/company/app","type":["string","null"]}},"required":["name","namespace","object_type","url"],"type":"object"},"GitRepositoryCollection":{"description":"One bounded provider discovery page.","properties":{"data":{"description":"The list of items in this page.","example":[{"name":"app","namespace":"company","object_type":"GIT_REPOSITORY","url":"https://github.com/company/app"}],"items":{"$ref":"#/components/schemas/GitRepository"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"GitSchedule":{"description":"Persisted periodic schedule. Missing configuration is represented by null, without inventing a schedule.","properties":{"day_of_week":{"description":"Stored weekday, or null for a daily schedule.","example":"MONDAY","oneOf":[{"$ref":"#/components/schemas/GitScheduleWeekday"},{"type":"null"}]},"period":{"$ref":"#/components/schemas/GitSchedulePeriod","description":"Daily or weekly schedule.","example":"DAILY"},"time":{"description":"Stored execution time of day in UTC.","example":"10:30","type":"string"}},"required":["day_of_week","period","time"],"type":"object"},"GitSchedulePeriod":{"description":"Period of a persisted repository schedule.","enum":["DAILY","WEEKLY"],"type":"string"},"GitScheduleWeekday":{"description":"Weekday of a weekly repository schedule.","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"type":"string"},"GitSelection":{"description":"Which files and branches LingoHub syncs.","properties":{"branch_filters":{"description":"The remote branches LingoHub keeps a branch for while branching, sorted by type and value; empty when not branching.","example":[{"type":"INCLUDE","value":"locales/**"}],"items":{"$ref":"#/components/schemas/GitFilter"},"type":"array"},"is_branching":{"description":"Whether LingoHub keeps a branch for every remote branch `branch_filters` select, besides the default branch.","example":true,"type":"boolean"},"path_filters":{"description":"The files LingoHub syncs, sorted by type and value; empty for none.","example":[{"type":"INCLUDE","value":"locales/**"}],"items":{"$ref":"#/components/schemas/GitFilter"},"type":"array"}},"required":["branch_filters","is_branching","path_filters"],"type":"object"},"GitSync":{"description":"When LingoHub pulls from and pushes to the repository by itself. A schedule exists only for a `PERIODIC` mode.","properties":{"export_mode":{"$ref":"#/components/schemas/GitExportMode","description":"`NONE`: only on request; `PERIODIC`: on `export_schedule`; `ON_COMPLETION`: when a branch's translations are complete, as the push settings' `auto_push_*` say.","example":"PERIODIC"},"export_schedule":{"description":"When LingoHub pushes, for `PERIODIC`; null otherwise.","oneOf":[{"$ref":"#/components/schemas/GitSchedule"},{"type":"null"}]},"import_mode":{"$ref":"#/components/schemas/GitImportMode","description":"`NONE`: only on request; `AUTOMATIC`: whenever the repository reports a push; `PERIODIC`: on `import_schedule`.","example":"AUTOMATIC"},"import_schedule":{"description":"When LingoHub pulls, for `PERIODIC`; null otherwise.","oneOf":[{"$ref":"#/components/schemas/GitSchedule"},{"type":"null"}]}},"required":["export_mode","export_schedule","import_mode","import_schedule"],"type":"object"},"Glossary":{"description":"A glossary: terms with their forms per language, which LINA uses for translation and the terminology check.","properties":{"created_at":{"description":"Timestamp when the glossary was created.","example":"2025-01-15T10:30:00.123Z","format":"date-time","type":"string"},"id":{"description":"Unique identifier of the glossary.","example":"gls_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^gls_[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}$","type":"string"},"language_codes":{"description":"Languages the glossary covers, sorted.","example":["de","en"],"items":{"type":"string"},"type":"array"},"name":{"description":"Name of the glossary.","example":"My Glossary","maxLength":1000,"minLength":0,"type":"string"},"object_type":{"description":"Always `GLOSSARY`.","enum":["GLOSSARY"],"example":"GLOSSARY","type":"string"},"updated_at":{"description":"Timestamp when the glossary was last updated.","example":"2025-06-20T14:45:00.123Z","format":"date-time","type":"string"}},"required":["created_at","id","language_codes","name","object_type","updated_at"],"type":"object"},"GlossaryCollection":{"description":"A list of glossaries.","properties":{"data":{"description":"The list of items in this page.","example":[{"created_at":"2025-01-15T10:30:00.123Z","id":"gls_0197c8f2-5a6b-7cde-8f12-3456789abcde","language_codes":["de","en"],"name":"My Glossary","object_type":"GLOSSARY","updated_at":"2025-06-20T14:45:00.123Z"}],"items":{"$ref":"#/components/schemas/Glossary"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"GlossaryFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+glossary[created_at]","-glossary[created_at]","+glossary[name]","-glossary[name]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/GlossaryFilterGroup"}},"type":"object"},"GlossaryFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/GlossaryFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/GlossaryFilterClause"},"minItems":1,"type":"array"},"glossary[created_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"glossary[id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^gls_[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}$","type":"string"},"_in":{"items":{"pattern":"^gls_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^gls_[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}$","type":"string"},"_nin":{"items":{"pattern":"^gls_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"glossary[name]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"}},"type":"object"},"GlossaryFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/GlossaryFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/GlossaryFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"GrammaticalGender":{"description":"Grammatical gender of the term form.","enum":["MASCULINE","FEMININE","NEUTER","OTHER"],"type":"string"},"GrammaticalNumber":{"description":"Grammatical number of the term form.","enum":["SINGULAR","PLURAL","MASS","DUAL","OTHER"],"type":"string"},"HtmlEncoding":{"description":"HTML handling when a format supports encoding: RAW embeds content unescaped, ESCAPE escapes XML characters, CDATA wraps content.","enum":["RAW","ESCAPE","CDATA"],"type":"string"},"HttpMethod":{"description":"HTTP method of the logged request; OTHER for a non-standard method.","enum":["GET","HEAD","POST","PUT","PATCH","DELETE","OPTIONS","TRACE","OTHER"],"type":"string"},"HubSpotContentType":{"description":"Public values of the existing HubSpotContentType configuration.","enum":["SITE_PAGE","LANDING_PAGE","BLOG_POST","BLOG_TAG","BLOG_AUTHOR","THEME_STRINGS","EMAIL"],"type":"string"},"I18nextFileFormatConfiguration":{"description":"How i18next JSON files are read and written.","properties":{"is_base_plural_exported":{"description":"Whether exports include base plural keys.","example":false,"type":"boolean"},"version":{"description":"The i18next JSON version of the files. Null on older projects that never stored one.","example":"VERSION_4","oneOf":[{"$ref":"#/components/schemas/I18nextVersion"},{"type":"null"}]}},"required":["is_base_plural_exported","version"],"type":"object"},"I18nextVersion":{"description":"The i18next JSON version, which decides how plural keys are named: `VERSION_3` adds `_plural` (or `_0`, `_1`, …), `VERSION_4` adds the plural category, such as `_one` and `_other`.","enum":["VERSION_3","VERSION_4"],"type":"string"},"Import":{"description":"An import of files, or of content from an integration, into a branch.","properties":{"branch_id":{"description":"Unique identifier of the branch the import belongs to.","example":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"},"created_at":{"description":"Timestamp when the import was created.","example":"2025-01-15T10:30:00.123Z","format":"date-time","type":"string"},"git_source":{"description":"The git branch and commit a git pull read its files from; null for other imports.","example":null,"oneOf":[{"$ref":"#/components/schemas/ImportGitSource"},{"type":"null"}]},"id":{"description":"Unique identifier of the import.","example":"rin_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^rin_[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}$","type":"string"},"keys_deactivated":{"description":"Number of keys the import deactivated because their file no longer contains them. 0 until the import finishes, and 0 when it failed.","example":3,"format":"int32","type":"integer"},"keys_reactivated":{"description":"Number of deactivated keys the import reactivated because their file contains them again. 0 until the import finishes, and 0 when it failed.","example":5,"format":"int32","type":"integer"},"keys_renamed":{"description":"Number of keys the import renamed or moved to another file. 0 until the import finishes, and 0 when it failed.","example":2,"format":"int32","type":"integer"},"object_type":{"description":"Always `IMPORT`.","enum":["IMPORT"],"example":"IMPORT","type":"string"},"status":{"$ref":"#/components/schemas/ImportStatus","description":"Status of the import. SKIPPED means an integration found nothing to import.","example":"SUCCEEDED"},"status_details":{"description":"Why the import failed, was partly successful or was skipped; null when there is nothing to explain.","example":null,"oneOf":[{"$ref":"#/components/schemas/SyncStatusDetails"},{"type":"null"}]},"texts_created":{"description":"Number of texts the import created: one for each imported language of each new segment. 0 until the import finishes, and 0 when it failed.","example":42,"format":"int32","type":"integer"},"texts_updated":{"description":"Number of texts whose content or status the import changed, in every language, including target texts marked outdated because their source changed. 0 until the import finishes, and 0 when it failed.","example":17,"format":"int32","type":"integer"},"updated_at":{"description":"Timestamp when the import was last updated.","example":"2025-06-20T14:45:00.123Z","format":"date-time","type":"string"}},"required":["branch_id","created_at","git_source","id","keys_deactivated","keys_reactivated","keys_renamed","object_type","status","status_details","texts_created","texts_updated","updated_at"],"type":"object"},"ImportChange":{"description":"What an import changed of one segment in one file: its key and its texts.","properties":{"created_at":{"description":"When the import made the change.","example":"2026-01-15T10:30:00.123Z","format":"date-time","type":"string"},"entry_id":{"description":"Unique identifier of the import entry, the file, the change was made by.","example":"rie_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^rie_[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}$","type":"string"},"key":{"description":"What the import did with the key; null when it changed only texts.","oneOf":[{"$ref":"#/components/schemas/ImportKeyChange"},{"type":"null"}]},"object_type":{"description":"Always `IMPORT_CHANGE`.","enum":["IMPORT_CHANGE"],"example":"IMPORT_CHANGE","type":"string"},"segment_id":{"description":"Unique identifier of the segment; null once the segment no longer exists.","example":"seg_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^seg_[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}$","type":["string","null"]},"texts":{"description":"What the import did with the segment's texts, one per language you can read; empty when it changed only the key.","example":[{"change":"CONTENT_CHANGED","language_code":"en","previous_status":"APPROVED","status":"APPROVED","variants":[{"content":"Welcome back!","device":"OTHER","plural_form":"OTHER","position":0,"previous_content":"Welcome!"}]},{"change":"STATUS_CHANGED_BY_SOURCE","language_code":"de","previous_status":"APPROVED","status":"STALE","variants":[]}],"items":{"$ref":"#/components/schemas/ImportTextChange"},"type":"array"}},"required":["created_at","entry_id","key","object_type","segment_id","texts"],"type":"object"},"ImportChangeCollection":{"description":"A page of an import's changes.","properties":{"data":{"description":"The list of items in this page.","example":[{"created_at":"2026-01-15T10:30:00.123Z","entry_id":"rie_0197c8f2-5a6b-7cde-8f12-3456789abcde","key":{"change":"RENAMED","key":"home.title","key_id":"ress_0197c8f2-5a6b-7cde-8f12-3456789abcde","path":"locales/en.json","previous_key":"welcome.title","previous_path":"locales/en.json"},"object_type":"IMPORT_CHANGE","segment_id":"seg_0197c8f2-5a6b-7cde-8f12-3456789abcde","texts":[{"change":"CONTENT_CHANGED","language_code":"en","previous_status":"APPROVED","status":"APPROVED","variants":[{"content":"Welcome back!","device":"OTHER","plural_form":"OTHER","position":0,"previous_content":"Welcome!"}]},{"change":"STATUS_CHANGED_BY_SOURCE","language_code":"de","previous_status":"APPROVED","status":"STALE","variants":[]}]}],"items":{"$ref":"#/components/schemas/ImportChange"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"ImportChangeFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return.","properties":{"where":{"$ref":"#/components/schemas/ImportChangeFilterGroup"}},"type":"object"},"ImportChangeFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/ImportChangeFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/ImportChangeFilterClause"},"minItems":1,"type":"array"},"import_change[entry_id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^rie_[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}$","type":"string"},"_in":{"items":{"pattern":"^rie_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^rie_[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}$","type":"string"},"_nin":{"items":{"pattern":"^rie_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"import_change[key_change]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["CREATED","RENAMED","MOVED","REACTIVATED","DEACTIVATED"],"type":"string"},"_in":{"items":{"enum":["CREATED","RENAMED","MOVED","REACTIVATED","DEACTIVATED"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["CREATED","RENAMED","MOVED","REACTIVATED","DEACTIVATED"],"type":"string"},"_nin":{"items":{"enum":["CREATED","RENAMED","MOVED","REACTIVATED","DEACTIVATED"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"import_change[language_code]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"type":"string"},"_in":{"items":{"type":"string"},"minItems":1,"type":"array"},"_ne":{"type":"string"},"_nin":{"items":{"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"import_change[segment_id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^seg_[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}$","type":"string"},"_in":{"items":{"pattern":"^seg_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^seg_[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}$","type":"string"},"_nin":{"items":{"pattern":"^seg_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"}},"type":"object"},"ImportChangeFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/ImportChangeFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/ImportChangeFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"ImportCollection":{"description":"A list of imports with pagination capability.","properties":{"data":{"description":"The list of items in this page.","example":[{"branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","created_at":"2025-01-15T10:30:00.123Z","git_source":null,"id":"rin_0197c8f2-5a6b-7cde-8f12-3456789abcde","keys_deactivated":3,"keys_reactivated":5,"keys_renamed":2,"object_type":"IMPORT","status":"SUCCEEDED","status_details":null,"texts_created":42,"texts_updated":17,"updated_at":"2025-06-20T14:45:00.123Z"}],"items":{"$ref":"#/components/schemas/Import"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"ImportEntry":{"description":"A single file entry within an import job.","properties":{"created_at":{"description":"Timestamp when the entry was created.","example":"2025-01-15T10:30:00.123Z","format":"date-time","type":"string"},"file_path":{"description":"The file path of the import entry.","example":"en.xliff","type":["string","null"]},"file_size_bytes":{"description":"Input file byte length, including document packages. Retained for unchanged imports when known; null when unavailable.","example":2048,"format":"int64","minimum":0,"type":["integer","null"]},"id":{"description":"Unique identifier of the import entry.","example":"rie_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^rie_[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}$","type":"string"},"import_id":{"description":"Unique identifier of the import the entry belongs to.","example":"rin_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^rin_[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}$","type":"string"},"language_code":{"description":"Language of the file.","example":"en","type":"string"},"object_type":{"description":"Always `IMPORT_ENTRY`.","enum":["IMPORT_ENTRY"],"example":"IMPORT_ENTRY","type":"string"},"resource_id":{"description":"Unique identifier of the resource the entry imported into, or null while it is not known yet.","example":"rc_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^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}$","type":["string","null"]},"status":{"$ref":"#/components/schemas/ImportEntryStatus","description":"Current status of the import entry.","example":"SUCCEEDED"},"status_details":{"description":"Machine-readable outcome explanation, including failures and explained skips; null when no explanation was recorded or is needed.","example":null,"oneOf":[{"$ref":"#/components/schemas/SyncStatusDetails"},{"type":"null"}]},"updated_at":{"description":"Timestamp when the entry was last updated.","example":"2025-06-20T14:45:00.123Z","format":"date-time","type":"string"}},"required":["created_at","file_path","file_size_bytes","id","import_id","language_code","object_type","resource_id","status","status_details","updated_at"],"type":"object"},"ImportEntryCollection":{"description":"A list of import entries with pagination capability.","properties":{"data":{"description":"The list of items in this page.","example":[{"created_at":"2025-01-15T10:30:00.123Z","file_path":"en.xliff","file_size_bytes":2048,"id":"rie_0197c8f2-5a6b-7cde-8f12-3456789abcde","import_id":"rin_0197c8f2-5a6b-7cde-8f12-3456789abcde","language_code":"en","object_type":"IMPORT_ENTRY","resource_id":"rc_0197c8f2-5a6b-7cde-8f12-3456789abcde","status":"SUCCEEDED","status_details":null,"updated_at":"2025-06-20T14:45:00.123Z"}],"items":{"$ref":"#/components/schemas/ImportEntry"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"ImportEntryFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return.","properties":{"where":{"$ref":"#/components/schemas/ImportEntryFilterGroup"}},"type":"object"},"ImportEntryFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/ImportEntryFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/ImportEntryFilterClause"},"minItems":1,"type":"array"},"import_entry[file_path]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"import_entry[file_size_bytes]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"_gt":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"_gte":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"_in":{"items":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"minItems":1,"type":"array"},"_lt":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"_lte":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"_ne":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"_nin":{"items":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"minItems":1,"type":"array"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"import_entry[language_code]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_gt":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_in":{"items":{"type":"string"},"minItems":1,"type":"array"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nin":{"items":{"type":"string"},"minItems":1,"type":"array"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"import_entry[resource_id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^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}$","type":"string"},"_in":{"items":{"pattern":"^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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^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}$","type":"string"},"_nin":{"items":{"pattern":"^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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"import_entry[status]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["QUEUED","PROCESSING","SUCCEEDED","FAILED","SKIPPED","UNCHANGED"],"type":"string"},"_in":{"items":{"enum":["QUEUED","PROCESSING","SUCCEEDED","FAILED","SKIPPED","UNCHANGED"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["QUEUED","PROCESSING","SUCCEEDED","FAILED","SKIPPED","UNCHANGED"],"type":"string"},"_nin":{"items":{"enum":["QUEUED","PROCESSING","SUCCEEDED","FAILED","SKIPPED","UNCHANGED"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"}},"type":"object"},"ImportEntryFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/ImportEntryFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/ImportEntryFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"ImportEntryStatus":{"description":"Status of a single file entry within an import job.","enum":["QUEUED","PROCESSING","SUCCEEDED","FAILED","SKIPPED","UNCHANGED"],"type":"string"},"ImportFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+import[created_at]","-import[created_at]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/ImportFilterGroup"}},"type":"object"},"ImportFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/ImportFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/ImportFilterClause"},"minItems":1,"type":"array"},"import[created_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"import[id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^rin_[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}$","type":"string"},"_in":{"items":{"pattern":"^rin_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^rin_[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}$","type":"string"},"_nin":{"items":{"pattern":"^rin_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"import[status]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["QUEUED","PROCESSING","SUCCEEDED","PARTIALLY_SUCCEEDED","FAILED","CANCELLED","SKIPPED"],"type":"string"},"_in":{"items":{"enum":["QUEUED","PROCESSING","SUCCEEDED","PARTIALLY_SUCCEEDED","FAILED","CANCELLED","SKIPPED"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["QUEUED","PROCESSING","SUCCEEDED","PARTIALLY_SUCCEEDED","FAILED","CANCELLED","SKIPPED"],"type":"string"},"_nin":{"items":{"enum":["QUEUED","PROCESSING","SUCCEEDED","PARTIALLY_SUCCEEDED","FAILED","CANCELLED","SKIPPED"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"}},"type":"object"},"ImportFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/ImportFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/ImportFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"ImportGitSource":{"description":"Repository head observed before this pull listed its files. Files are fetched through a mutable branch, so this is not an exact content-snapshot guarantee or a success flag. Imports without a complete retained observation, including ordinary uploads and historical jobs, have null git_source. Processing, partial and failed imports can retain an observation; inspect status and entries. A retry can replace the observation after another head read, or retain a previous observation if it fails earlier. Separate jobs retain independent observations. Reads never contact the provider or infer metadata from the current branch binding.","properties":{"git_branch":{"description":"Resolved remote branch used by this pull; independent of the LingoHub branch display name.","example":"main","type":"string"},"observed_head_commit_sha":{"description":"Head SHA returned by the provider before the pull listed files.","example":"0a1b2c3d4e5f0a1b2c3d4e5f0a1b2c3d4e5f0a1b","type":"string"}},"required":["git_branch","observed_head_commit_sha"],"type":"object"},"ImportJob":{"description":"An import scheduled for asynchronous processing.","properties":{"data":{"$ref":"#/components/schemas/Import","description":"The import this job is processing."},"job_type":{"description":"Always `IMPORT`.","enum":["IMPORT"],"example":"IMPORT","type":"string"},"object_type":{"description":"Always `JOB`.","enum":["JOB"],"example":"JOB","type":"string"}},"required":["data","job_type","object_type"],"type":"object"},"ImportKeyChange":{"description":"What an import did with a key.","properties":{"change":{"$ref":"#/components/schemas/ImportKeyChangeType","description":"What the import did with the key.","example":"RENAMED"},"key":{"description":"The key after the import.","example":"home.title","type":"string"},"key_id":{"description":"Unique identifier of the key; null once the key no longer exists.","example":"ress_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^ress_[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}$","type":["string","null"]},"path":{"description":"Path of the key's file after the import.","example":"locales/en.json","type":"string"},"previous_key":{"description":"The key before the import; null for a created key.","example":"welcome.title","type":["string","null"]},"previous_path":{"description":"Path of the key's file before the import; null for a new file.","example":"locales/en.json","type":["string","null"]}},"required":["change","key","key_id","path","previous_key","previous_path"],"type":"object"},"ImportKeyChangeType":{"description":"What the import did with a key: `CREATED` it, `RENAMED` it, `MOVED` it here from another file, `REACTIVATED` it because its file contains it again, or `DEACTIVATED` it because its file no longer contains it.","enum":["CREATED","RENAMED","MOVED","REACTIVATED","DEACTIVATED"],"type":"string"},"ImportLog":{"description":"A log entry for an import job.","properties":{"content":{"description":"The log message content.","example":"Import started successfully.","type":"string"},"created_at":{"description":"Timestamp when the log entry was created.","example":"2025-01-15T10:30:00.123Z","format":"date-time","type":"string"},"entry_id":{"description":"Unique identifier of the import entry, the file, the line is about; null for a line about the whole import.","example":"rie_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^rie_[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}$","type":["string","null"]},"level":{"$ref":"#/components/schemas/ImportLogLevel","description":"The log level.","example":"INFO"},"object_type":{"description":"Always `IMPORT_LOG`.","enum":["IMPORT_LOG"],"example":"IMPORT_LOG","type":"string"}},"required":["content","created_at","entry_id","level","object_type"],"type":"object"},"ImportLogCollection":{"description":"A list of import log entries with pagination capability.","properties":{"data":{"description":"The list of items in this page.","example":[{"content":"Import started successfully.","created_at":"2025-01-15T10:30:00.123Z","entry_id":"rie_0197c8f2-5a6b-7cde-8f12-3456789abcde","level":"INFO","object_type":"IMPORT_LOG"}],"items":{"$ref":"#/components/schemas/ImportLog"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"ImportLogFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+import_log[created_at]","-import_log[created_at]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/ImportLogFilterGroup"}},"type":"object"},"ImportLogFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/ImportLogFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/ImportLogFilterClause"},"minItems":1,"type":"array"},"import_log[content]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"import_log[created_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"import_log[entry_id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^rie_[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}$","type":"string"},"_in":{"items":{"pattern":"^rie_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^rie_[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}$","type":"string"},"_nin":{"items":{"pattern":"^rie_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"import_log[level]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["INFO","WARN","ERROR"],"type":"string"},"_in":{"items":{"enum":["INFO","WARN","ERROR"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["INFO","WARN","ERROR"],"type":"string"},"_nin":{"items":{"enum":["INFO","WARN","ERROR"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"}},"type":"object"},"ImportLogFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/ImportLogFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/ImportLogFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"ImportLogLevel":{"description":"Severity of an import job log entry.","enum":["INFO","WARN","ERROR"],"type":"string"},"ImportStatus":{"description":"Status of an import. `QUEUED` and `PROCESSING` are pending; the others are final. `SUCCEEDED`: everything was imported. `PARTIALLY_SUCCEEDED`: some files were imported before one failed; the entries say which. `FAILED`: nothing was imported; `status_details` says why. `CANCELLED`: the project was deleted before the import ran. `SKIPPED`: an integration found nothing to import.","enum":["QUEUED","PROCESSING","SUCCEEDED","PARTIALLY_SUCCEEDED","FAILED","CANCELLED","SKIPPED"],"type":"string"},"ImportTextChange":{"description":"What an import did with the text of a segment in one language.","properties":{"change":{"$ref":"#/components/schemas/ImportTextChangeType","description":"What the import did with the text.","example":"CONTENT_CHANGED"},"language_code":{"description":"Language of the text.","example":"en","type":"string"},"previous_status":{"$ref":"#/components/schemas/TextStatus","description":"Status of the text before the import."},"status":{"$ref":"#/components/schemas/TextStatus","description":"Status of the text after the import."},"variants":{"description":"The variants whose content the import set; empty when it changed only the status.","example":[{"content":"Welcome back!","device":"OTHER","plural_form":"OTHER","position":0,"previous_content":"Welcome!"}],"items":{"$ref":"#/components/schemas/ImportVariantChange"},"type":"array"}},"required":["change","language_code","previous_status","status","variants"],"type":"object"},"ImportTextChangeType":{"description":"What the import did with a text: `CREATED` it, changed its `STATUS`, its `CONTENT` or both, or changed the status of a target text because its source changed (`STATUS_CHANGED_BY_SOURCE`).","enum":["CREATED","STATUS_CHANGED","CONTENT_CHANGED","STATUS_AND_CONTENT_CHANGED","STATUS_CHANGED_BY_SOURCE"],"type":"string"},"ImportVariantChange":{"description":"One variant of a text the import changed, by plural form and device.","properties":{"content":{"description":"Content after the import.","example":"Welcome back!","type":"string"},"device":{"$ref":"#/components/schemas/VariantDevice","description":"Device of the variant.","example":"OTHER"},"plural_form":{"$ref":"#/components/schemas/VariantPluralForm","description":"Plural form of the variant.","example":"OTHER"},"position":{"description":"Position of the variant in the text.","example":0,"format":"int32","type":"integer"},"previous_content":{"description":"Content before the import.","example":"Welcome!","type":"string"}},"required":["content","device","plural_form","position","previous_content"],"type":"object"},"IntegrationAuthentication":{"description":"Stored authentication of a Git host or content system, without credentials or external account and installation identifiers. Its status is the stored lifecycle, not a live provider-access or token-validity check.","example":{"created_at":"2025-01-15T10:30:00.123Z","id":"iau_0197c8f2-5a6b-7cde-8f12-3456789abcde","is_self_hosted":false,"name":"Company GitHub installation","object_type":"INTEGRATION_AUTHENTICATION","provider":"GITHUB","provider_origin":"https://github.com","provider_region":null,"status":"ACTIVE","type":"INSTALLATION","updated_at":"2025-06-20T14:45:00.123Z"},"properties":{"created_at":{"description":"Creation time of the stored authentication.","example":"2025-01-15T10:30:00.123Z","format":"date-time","type":"string"},"id":{"description":"Public identity of the stored authentication.","example":"iau_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^iau_[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}$","type":"string"},"is_self_hosted":{"description":"Whether the authentication uses a self-hosted provider.","example":false,"type":"boolean"},"name":{"description":"Stored display name.","example":"Company GitHub installation","type":"string"},"object_type":{"description":"Always `INTEGRATION_AUTHENTICATION`.","enum":["INTEGRATION_AUTHENTICATION"],"example":"INTEGRATION_AUTHENTICATION","type":"string"},"provider":{"$ref":"#/components/schemas/IntegrationProvider","description":"Provider.","example":"GITHUB"},"provider_origin":{"description":"HTTP(S) scheme, host and optional port of a Git host. Null for CodeCommit, content systems and invalid stored URLs; never credentials, path, query or fragment.","example":"https://github.com","type":["string","null"]},"provider_region":{"description":"Stored CodeCommit region; null for other providers or invalid regions.","example":"us-east-1","type":["string","null"]},"status":{"$ref":"#/components/schemas/IntegrationAuthenticationStatus","description":"Stored lifecycle, not live connectivity.","example":"ACTIVE"},"type":{"$ref":"#/components/schemas/IntegrationAuthenticationType","description":"How this authentication was provisioned.","example":"INSTALLATION"},"updated_at":{"description":"Metadata update time of the stored authentication.","example":"2025-06-20T14:45:00.123Z","format":"date-time","type":"string"}},"required":["created_at","id","is_self_hosted","name","object_type","provider","provider_origin","provider_region","status","type","updated_at"],"type":"object"},"IntegrationAuthenticationCollection":{"description":"A cursor-paginated collection of stored integration authentications.","properties":{"data":{"description":"The list of items in this page.","example":[{"created_at":"2025-01-15T10:30:00.123Z","id":"iau_0197c8f2-5a6b-7cde-8f12-3456789abcde","is_self_hosted":false,"name":"Company GitHub installation","object_type":"INTEGRATION_AUTHENTICATION","provider":"GITHUB","provider_origin":"https://github.com","provider_region":null,"status":"ACTIVE","type":"INSTALLATION","updated_at":"2025-06-20T14:45:00.123Z"}],"items":{"$ref":"#/components/schemas/IntegrationAuthentication"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"IntegrationAuthenticationFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+integration_authentication[created_at]","-integration_authentication[created_at]","+integration_authentication[is_self_hosted]","-integration_authentication[is_self_hosted]","+integration_authentication[name]","-integration_authentication[name]","+integration_authentication[updated_at]","-integration_authentication[updated_at]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/IntegrationAuthenticationFilterGroup"}},"type":"object"},"IntegrationAuthenticationFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/IntegrationAuthenticationFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/IntegrationAuthenticationFilterClause"},"minItems":1,"type":"array"},"integration_authentication[created_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"integration_authentication[id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^iau_[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}$","type":"string"},"_in":{"items":{"pattern":"^iau_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^iau_[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}$","type":"string"},"_nin":{"items":{"pattern":"^iau_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"integration_authentication[is_self_hosted]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_false":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_true":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"}},"type":"object"},"integration_authentication[name]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"integration_authentication[provider]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["GITHUB","BITBUCKET","GITLAB","AZURE","AWS_CODE_COMMIT","STORYBLOK","CONTENTFUL","ZENDESK","HUBSPOT","STRIPO","CRISP_HELPDESK"],"type":"string"},"_in":{"items":{"enum":["GITHUB","BITBUCKET","GITLAB","AZURE","AWS_CODE_COMMIT","STORYBLOK","CONTENTFUL","ZENDESK","HUBSPOT","STRIPO","CRISP_HELPDESK"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["GITHUB","BITBUCKET","GITLAB","AZURE","AWS_CODE_COMMIT","STORYBLOK","CONTENTFUL","ZENDESK","HUBSPOT","STRIPO","CRISP_HELPDESK"],"type":"string"},"_nin":{"items":{"enum":["GITHUB","BITBUCKET","GITLAB","AZURE","AWS_CODE_COMMIT","STORYBLOK","CONTENTFUL","ZENDESK","HUBSPOT","STRIPO","CRISP_HELPDESK"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"integration_authentication[status]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["ACTIVE","SUSPENDED","REVOKED"],"type":"string"},"_in":{"items":{"enum":["ACTIVE","SUSPENDED","REVOKED"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["ACTIVE","SUSPENDED","REVOKED"],"type":"string"},"_nin":{"items":{"enum":["ACTIVE","SUSPENDED","REVOKED"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"integration_authentication[type]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["MANUAL","OAUTH","INSTALLATION"],"type":"string"},"_in":{"items":{"enum":["MANUAL","OAUTH","INSTALLATION"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["MANUAL","OAUTH","INSTALLATION"],"type":"string"},"_nin":{"items":{"enum":["MANUAL","OAUTH","INSTALLATION"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"integration_authentication[updated_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"}},"type":"object"},"IntegrationAuthenticationFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/IntegrationAuthenticationFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/IntegrationAuthenticationFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"IntegrationAuthenticationStatus":{"description":"`SUSPENDED` or `REVOKED` when the GitHub App was suspended or uninstalled on GitHub; other connections are always `ACTIVE`.","enum":["ACTIVE","SUSPENDED","REVOKED"],"type":"string"},"IntegrationAuthenticationType":{"description":"`INSTALLATION` for the LingoHub GitHub App, `OAUTH` when signed in through the provider, `MANUAL` for a token or keys entered by hand.","enum":["MANUAL","OAUTH","INSTALLATION"],"type":"string"},"IntegrationProvider":{"description":"Provider of a stored integration authentication: a Git host or a content system.","enum":["GITHUB","BITBUCKET","GITLAB","AZURE","AWS_CODE_COMMIT","STORYBLOK","CONTENTFUL","ZENDESK","HUBSPOT","STRIPO","CRISP_HELPDESK"],"type":"string"},"Invitation":{"description":"Retained email-invitation metadata without its bearer token, acceptance URL or private assignment payload. LINK invitations are excluded.","properties":{"accepted_at":{"description":"Stored email acceptance time, if accepted.","example":"2026-09-29T10:00:00.123Z","format":"date-time","type":["string","null"]},"created_at":{"description":"Time the invitation was created.","example":"2026-09-29T10:00:00.123Z","format":"date-time","type":"string"},"declined_at":{"description":"Stored email decline time, if declined.","example":"2026-09-29T10:00:00.123Z","format":"date-time","type":["string","null"]},"email":{"description":"Invited email address, if retained.","example":"alex@example.com","type":["string","null"]},"expires_at":{"description":"Stored expiry time; pending invitations expire after this instant.","example":"2026-09-29T10:00:00.123Z","format":"date-time","type":"string"},"id":{"description":"Public identity of the email invitation.","example":"svi_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^svi_[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}$","type":"string"},"invitee_name":{"description":"Display name of the LingoHub account the invited email belonged to when the invitation was created; null when the email had no account. It is never supplied by the inviter.","example":"Alex","type":["string","null"]},"inviter_email":{"description":"Email address of who sent the invitation: the inviting user, or the owner of the personal (`USER_OWNED`) API key it was sent with. Null when a workspace-managed API key or LingoHub sent it, and once that user or key no longer exists.","example":"owner@example.com","type":["string","null"]},"is_stack_assignment_configured":{"description":"Whether a stack assignment was configured; its details and current validity are outside this metadata resource.","example":false,"type":"boolean"},"message":{"description":"Message stored with the invitation, if supplied.","example":"Welcome to the translation team.","type":["string","null"]},"object_type":{"description":"Always `INVITATION`.","enum":["INVITATION"],"example":"INVITATION","type":"string"},"status":{"$ref":"#/components/schemas/InvitationStatus","description":"Computed current state. Expiration can change the state without changing updated_at.","example":"PENDING"},"updated_at":{"description":"Stored invitation metadata update time; elapsed expiry does not update it.","example":"2026-09-29T10:00:00.123Z","format":"date-time","type":"string"},"workspace_role_id":{"description":"Workspace role requested by the invitation.","example":"rol_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^rol_[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}$","type":"string"}},"required":["accepted_at","created_at","declined_at","email","expires_at","id","invitee_name","inviter_email","is_stack_assignment_configured","message","object_type","status","updated_at","workspace_role_id"],"type":"object"},"InvitationAssignmentAvailability":{"description":"Whether the complete stored stack assignment is currently readable.","enum":["NOT_CONFIGURED","AVAILABLE","UNAVAILABLE"],"type":"string"},"InvitationCollection":{"description":"A cursor-paginated collection of retained email invitations.","properties":{"data":{"description":"The list of items in this page.","example":[{"accepted_at":"2026-09-29T10:00:00.123Z","created_at":"2026-09-29T10:00:00.123Z","declined_at":"2026-09-29T10:00:00.123Z","email":"alex@example.com","expires_at":"2026-09-29T10:00:00.123Z","id":"svi_0197c8f2-5a6b-7cde-8f12-3456789abcde","invitee_name":"Alex","inviter_email":"owner@example.com","is_stack_assignment_configured":false,"message":"Welcome to the translation team.","object_type":"INVITATION","status":"PENDING","updated_at":"2026-09-29T10:00:00.123Z","workspace_role_id":"rol_0197c8f2-5a6b-7cde-8f12-3456789abcde"}],"items":{"$ref":"#/components/schemas/Invitation"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"InvitationFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+invitation[created_at]","-invitation[created_at]","+invitation[expires_at]","-invitation[expires_at]","+invitation[updated_at]","-invitation[updated_at]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/InvitationFilterGroup"}},"type":"object"},"InvitationFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/InvitationFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/InvitationFilterClause"},"minItems":1,"type":"array"},"invitation[accepted_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"invitation[created_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"invitation[declined_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"invitation[email]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"invitation[expires_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"invitation[id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^svi_[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}$","type":"string"},"_in":{"items":{"pattern":"^svi_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^svi_[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}$","type":"string"},"_nin":{"items":{"pattern":"^svi_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"invitation[invitee_name]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"invitation[is_stack_assignment_configured]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_false":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_true":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"}},"type":"object"},"invitation[message]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"invitation[status]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["ACCEPTED","DECLINED","EXPIRED","PENDING"],"type":"string"},"_in":{"items":{"enum":["ACCEPTED","DECLINED","EXPIRED","PENDING"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["ACCEPTED","DECLINED","EXPIRED","PENDING"],"type":"string"},"_nin":{"items":{"enum":["ACCEPTED","DECLINED","EXPIRED","PENDING"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"invitation[updated_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"invitation[workspace_role_id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^rol_[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}$","type":"string"},"_in":{"items":{"pattern":"^rol_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^rol_[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}$","type":"string"},"_nin":{"items":{"pattern":"^rol_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"}},"type":"object"},"InvitationFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/InvitationFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/InvitationFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"InvitationStackAssignment":{"description":"Complete currently readable stored stack assignment. This is requested configuration, not effective access or proof of acceptance.","properties":{"language_permissions":{"additionalProperties":{"$ref":"#/components/schemas/StackMemberLanguagePermission"},"description":"Language permissions the person gets in the assigned stacks that contain the language; empty when none are set. These do not describe effective access.","example":{"de":"READ_ACCESS"},"type":"object"},"stack_ids":{"description":"Public identities of the stored target stacks in stored order.","example":["stack_0197c8f2-5a6b-7cde-8f12-3456789abcde"],"items":{"pattern":"^stack_[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}$","type":"string"},"type":"array"},"stack_role_id":{"description":"Current public identity of the stored stack role.","example":"stackr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stackr_[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}$","type":"string"}},"required":["language_permissions","stack_ids","stack_role_id"],"type":"object"},"InvitationStackAssignmentDetails":{"description":"Computed availability of a retained email invitation's stored stack assignment, without invented timestamps.","properties":{"assignment":{"description":"Complete requested assignment when AVAILABLE, otherwise null. Never a partial assignment.","oneOf":[{"$ref":"#/components/schemas/InvitationStackAssignment"},{"type":"null"}]},"availability":{"$ref":"#/components/schemas/InvitationAssignmentAvailability","description":"NOT_CONFIGURED when absent; UNAVAILABLE when any reference or required target-stack access is unavailable; AVAILABLE when the whole configuration can be read.","example":"AVAILABLE"},"id":{"description":"Public identity of the retained email invitation.","example":"svi_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^svi_[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}$","type":"string"},"object_type":{"description":"Always `INVITATION_STACK_ASSIGNMENT`.","enum":["INVITATION_STACK_ASSIGNMENT"],"example":"INVITATION_STACK_ASSIGNMENT","type":"string"}},"required":["assignment","availability","id","object_type"],"type":"object"},"InvitationStatus":{"description":"Email invitation state, derived from stored acceptance/decline and expiration timestamps. Acceptance takes precedence over decline and expiration.","enum":["ACCEPTED","DECLINED","EXPIRED","PENDING"],"example":"PENDING","type":"string"},"JsonFileFormatConfiguration":{"description":"How JSON files are laid out.","properties":{"is_array_indentation_enabled":{"description":"Whether JSON arrays are indented.","example":false,"type":"boolean"},"is_plural_order_alphabetical":{"description":"Whether plural forms are ordered alphabetically.","example":false,"type":"boolean"}},"required":["is_array_indentation_enabled","is_plural_order_alphabetical"],"type":"object"},"Key":{"description":"Where a segment appears in a file: one entry of the file, with its key and position. `segment_id` leads to the segment and its texts; renaming or removing a key leaves the segment and its other keys unchanged.","properties":{"branch_id":{"description":"Public identifier of the branch containing the file.","example":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"},"created_at":{"description":"Timestamp when the key was created.","example":"2026-09-29T00:00:00.123Z","format":"date-time","type":"string"},"group_key":{"description":"The group of the key in formats with one group (`key_type` REQUIRED_KEY_WITH_GROUP: PO, Qt TS, INI, Twine). Null otherwise, and for a key without a group.","example":null,"type":["string","null"]},"id":{"description":"Public identifier of this key.","example":"ress_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^ress_[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}$","type":"string"},"is_delete_allowed":{"description":"Whether the project and the file's format allow removing the key (deleteKey). Single-language CSV, document, subtitle, Storyblok and integration projects don't. API permissions are checked separately.","example":true,"type":"boolean"},"is_rename_allowed":{"description":"Whether the project and the file's format allow renaming the key (updateKey). Single-language CSV, document, subtitle, Storyblok and integration projects don't. API permissions are checked separately.","example":true,"type":"boolean"},"key":{"description":"The key, exactly as createKey and updateKey take it. In nested formats (`key_type` REQUIRED_KEY_WITH_MULTIPLE_GROUPS) its parts are joined by dots, and a part that is empty or contains a dot, a double quote or a backslash is in double quotes, with quotes and backslashes escaped by a backslash. In formats with one group the group is in `group_key`. Entries a format groups on its own, such as the cells of a single-language CSV row (`cell_B3`), show their own key.","example":"navigation.sign_in","type":"string"},"key_type":{"description":"How keys of the file's format are written: OPTIONAL_KEY (TXT, Markdown, HTML: the key is optional), REQUIRED_KEY (flat keys), REQUIRED_KEY_WITH_GROUP (a key and its `group_key`), REQUIRED_KEY_WITH_MULTIPLE_GROUPS (nested keys, their parts joined by dots). Null for a file without a format.","example":"REQUIRED_KEY_WITH_MULTIPLE_GROUPS","oneOf":[{"$ref":"#/components/schemas/KeyType"},{"type":"null"}]},"object_type":{"description":"Always `KEY`.","enum":["KEY"],"example":"KEY","type":"string"},"position":{"description":"Position of the key within its group of the file, starting at 1. Keys are listed in file order.","example":1,"format":"int32","type":"integer"},"project_id":{"description":"Public identifier of the project containing the file.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"},"resource_id":{"description":"Public identifier of the file containing this key.","example":"rc_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^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}$","type":"string"},"segment_id":{"description":"Public identifier of the segment that holds the texts of this key.","example":"seg_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^seg_[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}$","type":"string"},"updated_at":{"description":"Timestamp when the key, its position or its file last changed.","example":"2026-09-29T00:00:00.123Z","format":"date-time","type":"string"}},"required":["branch_id","created_at","group_key","id","is_delete_allowed","is_rename_allowed","key","key_type","object_type","position","project_id","resource_id","segment_id","updated_at"],"type":"object"},"KeyCollection":{"description":"A cursor-paginated list of ResourceSegment objects.","properties":{"data":{"description":"The list of items in this page.","example":[{"branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","created_at":"2026-09-29T00:00:00.123Z","group_key":null,"id":"ress_0197c8f2-5a6b-7cde-8f12-3456789abcde","is_delete_allowed":true,"is_rename_allowed":true,"key":"navigation.sign_in","key_type":"REQUIRED_KEY_WITH_MULTIPLE_GROUPS","object_type":"KEY","position":1,"project_id":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","resource_id":"rc_0197c8f2-5a6b-7cde-8f12-3456789abcde","segment_id":"seg_0197c8f2-5a6b-7cde-8f12-3456789abcde","updated_at":"2026-09-29T00:00:00.123Z"}],"items":{"$ref":"#/components/schemas/Key"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"KeyList":{"description":"The keys created, in the order of the request.","properties":{"data":{"description":"The created keys.","example":[{"branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","created_at":"2026-09-29T00:00:00.123Z","group_key":null,"id":"ress_0197c8f2-5a6b-7cde-8f12-3456789abcde","is_delete_allowed":true,"is_rename_allowed":true,"key":"navigation.sign_in","key_type":"REQUIRED_KEY_WITH_MULTIPLE_GROUPS","object_type":"KEY","position":1,"project_id":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","resource_id":"rc_0197c8f2-5a6b-7cde-8f12-3456789abcde","segment_id":"seg_0197c8f2-5a6b-7cde-8f12-3456789abcde","updated_at":"2026-09-29T00:00:00.123Z"}],"items":{"$ref":"#/components/schemas/Key"},"type":"array"},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","object_type"],"type":"object"},"KeyNormalizationStrategy":{"description":"How keys are normalised when they are imported, created or renamed: `FORMAT_SPECIFIC` as the file format requires, `ALL` always, `NONE` never. Existing keys aren't renamed.","enum":["FORMAT_SPECIFIC","ALL","NONE"],"type":"string"},"KeyType":{"description":"How the keys of a file's format are written: OPTIONAL_KEY (TXT, Markdown, HTML: the key is optional), REQUIRED_KEY (flat keys), REQUIRED_KEY_WITH_GROUP (a key and its `group_key`: PO, Qt TS, INI, Twine), REQUIRED_KEY_WITH_MULTIPLE_GROUPS (nested keys, their parts joined by dots).","enum":["OPTIONAL_KEY","REQUIRED_KEY","REQUIRED_KEY_WITH_GROUP","REQUIRED_KEY_WITH_MULTIPLE_GROUPS"],"type":"string"},"Label":{"description":"A workspace label used to tag segments, so content can be categorised and filtered.","properties":{"ai_context":{"description":"Tells LINA what segments with this label are about. A LINA with an AI engine reads it when its `context.is_labels_enabled` is on; LingoHub-managed LINAs always do.","example":"Short, catchy texts for marketing campaigns","maxLength":256,"minLength":0,"type":["string","null"]},"color":{"description":"Hex color code of the label (e.g., #FF5733).","example":"#FF5733","maxLength":7,"minLength":7,"pattern":"#[0-9a-fA-F]{6}","type":"string"},"created_at":{"description":"Timestamp when the label was created.","example":"2025-01-15T10:30:00.123Z","format":"date-time","type":"string"},"id":{"description":"Unique identifier of the label.","example":"la_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^la_[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}$","type":"string"},"name":{"description":"Display name of the label.","example":"Marketing","maxLength":255,"minLength":0,"type":"string"},"object_type":{"description":"Always `LABEL`.","enum":["LABEL"],"example":"LABEL","type":"string"},"updated_at":{"description":"Timestamp when the label was last updated.","example":"2025-06-20T14:45:00.123Z","format":"date-time","type":"string"}},"required":["ai_context","color","created_at","id","name","object_type","updated_at"],"type":"object"},"LabelCollection":{"description":"A cursor-paginated list of labels.","properties":{"data":{"description":"The list of items in this page.","example":[{"ai_context":"Short, catchy texts for marketing campaigns","color":"#FF5733","created_at":"2025-01-15T10:30:00.123Z","id":"la_0197c8f2-5a6b-7cde-8f12-3456789abcde","name":"Marketing","object_type":"LABEL","updated_at":"2025-06-20T14:45:00.123Z"}],"items":{"$ref":"#/components/schemas/Label"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"LabelFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+label[created_at]","-label[created_at]","+label[name]","-label[name]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/LabelFilterGroup"}},"type":"object"},"LabelFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/LabelFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/LabelFilterClause"},"minItems":1,"type":"array"},"label[created_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"label[id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^la_[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}$","type":"string"},"_in":{"items":{"pattern":"^la_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^la_[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}$","type":"string"},"_nin":{"items":{"pattern":"^la_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"label[name]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"}},"type":"object"},"LabelFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/LabelFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/LabelFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"LanguageLinaRole":{"description":"ASSISTANT runs on demand, TRANSLATOR translates/checks with human approval, AGENT also approves when the existing quality workflow permits. Inert without a stack LINA.","enum":["ASSISTANT","TRANSLATOR","AGENT"],"type":"string"},"LanguageVariant":{"description":"The regional variant a style guide sets for a general language.","properties":{"language_code":{"description":"General language the variant is set for.","example":"de","type":"string"},"variant_language_code":{"description":"Regional variant that texts in the general language are written in.","example":"de-AT","type":"string"}},"required":["language_code","variant_language_code"],"type":"object"},"Lina":{"description":"A LINA: an AI translator with its engines, the context it translates with and the stacks it may work in.","properties":{"color":{"description":"Color of the LINA's icon, as a hexadecimal RGB value.","example":"#C084FC","type":"string"},"context":{"$ref":"#/components/schemas/LinaContext","description":"Which context the LINA sends along with each text it translates.","example":{"is_glossary_enabled":true,"is_labels_enabled":true,"is_segments_enabled":true,"is_style_guide_enabled":true,"is_translation_memory_enabled":true}},"created_at":{"description":"Timestamp when the LINA was created.","example":"2026-09-29T10:00:00.123Z","format":"date-time","type":"string"},"description":{"description":"Description of the LINA.","example":"Product localization","type":["string","null"]},"engine_mode":{"$ref":"#/components/schemas/LinaEngineMode","description":"Who chooses the LINA's engines.","example":"CUSTOMER_MANAGED"},"glossary_id":{"description":"Glossary the LINA uses for translation and for the terminology check; null for none.","example":"gls_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^gls_[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}$","type":["string","null"]},"id":{"description":"Unique identifier of the LINA.","example":"lina_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^lina_[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}$","type":"string"},"is_tm_match_enabled":{"description":"Whether the LINA reuses a translation-memory match with exactly the same source text instead of translating it.","example":false,"type":"boolean"},"language_engine_overrides":{"description":"Engines the LINA uses for single target languages instead of `linguistic_engine_id`, sorted by language code.","example":[{"language_code":"de","linguistic_engine_id":"engine_0197c8f2-5a6b-7cde-8f12-3456789abcde"}],"items":{"$ref":"#/components/schemas/LinaLanguageEngine"},"type":"array"},"linguistic_engine_id":{"description":"Engine the LINA translates with. For a LingoHub-managed LINA it is the default engine; LingoHub may choose another one for each translation.","example":"engine_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^engine_[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}$","type":"string"},"name":{"description":"Name of the LINA, unique in the workspace ignoring case.","example":"Localization assistant","type":"string"},"object_type":{"description":"Always `LINA`.","enum":["LINA"],"example":"LINA","type":"string"},"restricted_stack_ids":{"description":"Stacks the LINA may work in, sorted by ID; null when it may work in every stack. An empty list means it may work in none.","example":["stack_0197c8f2-5a6b-7cde-8f12-3456789abcde"],"items":{"example":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stack_[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}$","type":"string"},"type":["array","null"]},"style_guide_id":{"description":"Style guide the LINA follows when translating and for the style checks; null for none.","example":"sg_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^sg_[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}$","type":["string","null"]},"updated_at":{"description":"Timestamp when the LINA was last updated.","example":"2026-09-29T10:00:00.123Z","format":"date-time","type":"string"}},"required":["color","context","created_at","description","engine_mode","glossary_id","id","is_tm_match_enabled","language_engine_overrides","linguistic_engine_id","name","object_type","restricted_stack_ids","style_guide_id","updated_at"],"type":"object"},"LinaCollection":{"description":"A cursor-paginated collection of Lina resources.","properties":{"data":{"description":"The list of items in this page.","example":[{"color":"#C084FC","context":{"is_glossary_enabled":true,"is_labels_enabled":true,"is_segments_enabled":true,"is_style_guide_enabled":true,"is_translation_memory_enabled":true},"created_at":"2026-09-29T10:00:00.123Z","description":"Product localization","engine_mode":"CUSTOMER_MANAGED","glossary_id":"gls_0197c8f2-5a6b-7cde-8f12-3456789abcde","id":"lina_0197c8f2-5a6b-7cde-8f12-3456789abcde","is_tm_match_enabled":false,"language_engine_overrides":[{"language_code":"de","linguistic_engine_id":"engine_0197c8f2-5a6b-7cde-8f12-3456789abcde"}],"linguistic_engine_id":"engine_0197c8f2-5a6b-7cde-8f12-3456789abcde","name":"Localization assistant","object_type":"LINA","restricted_stack_ids":["stack_0197c8f2-5a6b-7cde-8f12-3456789abcde"],"style_guide_id":"sg_0197c8f2-5a6b-7cde-8f12-3456789abcde","updated_at":"2026-09-29T10:00:00.123Z"}],"items":{"$ref":"#/components/schemas/Lina"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"LinaContext":{"description":"The context a LINA sends along with each text it translates.","properties":{"is_glossary_enabled":{"description":"Whether the LINA sends the terms of its glossary.","example":true,"type":"boolean"},"is_labels_enabled":{"description":"Whether the LINA sends the labels of the segment.","example":true,"type":"boolean"},"is_segments_enabled":{"description":"Whether the LINA sends the description of the segment.","example":true,"type":"boolean"},"is_style_guide_enabled":{"description":"Whether the LINA sends the rules of its style guide.","example":true,"type":"boolean"},"is_translation_memory_enabled":{"description":"Whether the LINA sends similar translations from the translation memory.","example":true,"type":"boolean"}},"required":["is_glossary_enabled","is_labels_enabled","is_segments_enabled","is_style_guide_enabled","is_translation_memory_enabled"],"type":"object"},"LinaEngineMode":{"description":"Who chooses a LINA's engines:\n  - CUSTOMER_MANAGED: you choose the engine and per-language engines.\n  - LINGOHUB_MANAGED: LingoHub chooses them for each translation; these fields show the defaults and can't be changed.\n","enum":["CUSTOMER_MANAGED","LINGOHUB_MANAGED"],"type":"string"},"LinaExecution":{"description":"A LINA pre-translation of the selected texts of one language in a branch, started through the API. Every batch LINA finishes is saved right away, so a run that doesn't succeed may still have translated texts.","properties":{"branch_id":{"description":"Branch whose texts the run translates.","example":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"},"created_at":{"description":"Timestamp when the run was started.","example":"2026-10-07T00:00:00.123Z","format":"date-time","type":"string"},"failure":{"description":"Why the run didn't translate everything: set when `status` is `PARTIALLY_SUCCEEDED`, `FAILED` or `CANCELLED`, null otherwise.","oneOf":[{"$ref":"#/components/schemas/LinaExecutionFailure"},{"type":"null"}]},"id":{"description":"Unique identifier of the run.","example":"tp_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^tp_[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}$","type":"string"},"object_type":{"description":"Always `LINA_EXECUTION`.","enum":["LINA_EXECUTION"],"example":"LINA_EXECUTION","type":"string"},"selected_segment_count":{"description":"Number of selected texts the run was to translate: translatable, with a source text and, with `only_empty`, without a translation. Counted when the run was started; it doesn't change while the run works.","example":10,"format":"int32","type":"integer"},"status":{"$ref":"#/components/schemas/LinaExecutionStatus","description":"Where the run stands.","example":"SUCCEEDED"},"target_language_code":{"description":"Language the run translates into.","example":"de","type":"string"},"updated_at":{"description":"Timestamp when the run's status last changed.","example":"2026-10-07T00:00:00.123Z","format":"date-time","type":"string"}},"required":["branch_id","created_at","failure","id","object_type","selected_segment_count","status","target_language_code","updated_at"],"type":"object"},"LinaExecutionCollection":{"description":"LINA runs started through the API on a branch.","properties":{"data":{"description":"The list of items in this page.","example":[{"branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","created_at":"2026-10-07T00:00:00.000Z","failure":null,"id":"tp_0197c8f2-5a6b-7cde-8f12-3456789abcde","object_type":"LINA_EXECUTION","selected_segment_count":10,"status":"SUCCEEDED","target_language_code":"de","updated_at":"2026-10-07T00:00:00.000Z"}],"items":{"$ref":"#/components/schemas/LinaExecution"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"LinaExecutionFailure":{"description":"Why a LINA run did not translate everything it was asked to:\n  - INCOMPLETE_TRANSLATION: LINA could not translate some of the selected texts.\n  - INTERRUPTED: the run was interrupted and not repeated, because the engine may already have been called.\n  - SELECTION_CHANGED: the selected segments left the branch, or the project moved to another stack; select the segments again.\n  - EXECUTION_FAILED: an unexpected error stopped the run.\n","enum":["INCOMPLETE_TRANSLATION","INTERRUPTED","SELECTION_CHANGED","EXECUTION_FAILED"],"type":"string"},"LinaExecutionFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+lina_execution[created_at]","-lina_execution[created_at]","+lina_execution[updated_at]","-lina_execution[updated_at]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/LinaExecutionFilterGroup"}},"type":"object"},"LinaExecutionFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/LinaExecutionFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/LinaExecutionFilterClause"},"minItems":1,"type":"array"},"lina_execution[created_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"lina_execution[id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^tp_[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}$","type":"string"},"_in":{"items":{"pattern":"^tp_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^tp_[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}$","type":"string"},"_nin":{"items":{"pattern":"^tp_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"lina_execution[status]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["QUEUED","PROCESSING","SUCCEEDED","PARTIALLY_SUCCEEDED","FAILED","CANCELLED","SKIPPED"],"type":"string"},"_in":{"items":{"enum":["QUEUED","PROCESSING","SUCCEEDED","PARTIALLY_SUCCEEDED","FAILED","CANCELLED","SKIPPED"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["QUEUED","PROCESSING","SUCCEEDED","PARTIALLY_SUCCEEDED","FAILED","CANCELLED","SKIPPED"],"type":"string"},"_nin":{"items":{"enum":["QUEUED","PROCESSING","SUCCEEDED","PARTIALLY_SUCCEEDED","FAILED","CANCELLED","SKIPPED"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"lina_execution[updated_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"}},"type":"object"},"LinaExecutionFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/LinaExecutionFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/LinaExecutionFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"LinaExecutionJob":{"description":"The LINA runs a pre-translation started, one per target language.","properties":{"data":{"description":"The runs in the order of `target_language_codes`, in their initial state. Poll each at `/v2/lina-executions/{linaExecutionId}` until it reaches a final status, waiting two seconds between polls; `Location` names the first.","example":[{"branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","created_at":"2026-10-07T00:00:00.000Z","failure":null,"id":"tp_0197c8f2-5a6b-7cde-8f12-3456789abcde","object_type":"LINA_EXECUTION","selected_segment_count":10,"status":"QUEUED","target_language_code":"de","updated_at":"2026-10-07T00:00:00.000Z"}],"items":{"$ref":"#/components/schemas/LinaExecution"},"type":"array"},"job_type":{"description":"Always `LINA_EXECUTION`.","enum":["LINA_EXECUTION"],"example":"LINA_EXECUTION","type":"string"},"object_type":{"description":"Always `JOB`.","enum":["JOB"],"example":"JOB","type":"string"}},"required":["data","job_type","object_type"],"type":"object"},"LinaExecutionStatus":{"description":"Where a LINA run stands. QUEUED and PROCESSING are pending; the others are final.\n  - SUCCEEDED: every selected text was translated.\n  - PARTIALLY_SUCCEEDED: part of the selection was translated; `failure` says why the rest wasn't.\n  - FAILED: nothing was translated, or the run stopped on an error; `failure` says why.\n  - CANCELLED: the queued run was cancelled because its selection changed; `failure` says so.\n  - SKIPPED: there was nothing to translate.\n","enum":["QUEUED","PROCESSING","SUCCEEDED","PARTIALLY_SUCCEEDED","FAILED","CANCELLED","SKIPPED"],"type":"string"},"LinaFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+lina[created_at]","-lina[created_at]","+lina[name]","-lina[name]","+lina[updated_at]","-lina[updated_at]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/LinaFilterGroup"}},"type":"object"},"LinaFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/LinaFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/LinaFilterClause"},"minItems":1,"type":"array"},"lina[created_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"lina[engine_mode]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["CUSTOMER_MANAGED","LINGOHUB_MANAGED"],"type":"string"},"_in":{"items":{"enum":["CUSTOMER_MANAGED","LINGOHUB_MANAGED"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["CUSTOMER_MANAGED","LINGOHUB_MANAGED"],"type":"string"},"_nin":{"items":{"enum":["CUSTOMER_MANAGED","LINGOHUB_MANAGED"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"lina[id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^lina_[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}$","type":"string"},"_in":{"items":{"pattern":"^lina_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^lina_[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}$","type":"string"},"_nin":{"items":{"pattern":"^lina_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"lina[name]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"lina[updated_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"}},"type":"object"},"LinaFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/LinaFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/LinaFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"LinaLanguageEngine":{"description":"The engine a LINA uses for one target language.","properties":{"language_code":{"description":"Target language the engine is used for.","example":"de","type":"string"},"linguistic_engine_id":{"description":"Engine used for this language.","example":"engine_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^engine_[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}$","type":"string"}},"required":["language_code","linguistic_engine_id"],"type":"object"},"LinaQualityRuleSettings":{"description":"Whether one quality-check rule runs and how severe its findings are.","properties":{"is_enabled":{"description":"Whether this rule runs.","example":true,"type":"boolean"},"severity":{"$ref":"#/components/schemas/QualityCheckSeverity","description":"How severe the rule's findings are.","example":"WARNING"}},"required":["is_enabled","severity"],"type":"object"},"LinaQualityRules":{"description":"The ten quality-check rules: whether each runs and how severe its findings are.","properties":{"duplication":{"$ref":"#/components/schemas/LinaQualityRuleSettings","description":"Configuration for the duplication rule.","example":{"is_enabled":true,"severity":"WARNING"}},"length_constraints":{"$ref":"#/components/schemas/LinaQualityRuleSettings","description":"Configuration for the length constraints rule.","example":{"is_enabled":true,"severity":"WARNING"}},"locale_formatting":{"$ref":"#/components/schemas/LinaQualityRuleSettings","description":"Configuration for the locale formatting rule.","example":{"is_enabled":true,"severity":"WARNING"}},"markup":{"$ref":"#/components/schemas/LinaQualityRuleSettings","description":"Configuration for the markup rule.","example":{"is_enabled":true,"severity":"WARNING"}},"placeholders":{"$ref":"#/components/schemas/LinaQualityRuleSettings","description":"Configuration for the placeholders rule.","example":{"is_enabled":true,"severity":"WARNING"}},"punctuation":{"$ref":"#/components/schemas/LinaQualityRuleSettings","description":"Configuration for the punctuation rule.","example":{"is_enabled":true,"severity":"WARNING"}},"quotes_and_delimiters":{"$ref":"#/components/schemas/LinaQualityRuleSettings","description":"Configuration for the quotes and delimiters rule.","example":{"is_enabled":true,"severity":"WARNING"}},"terminology":{"$ref":"#/components/schemas/LinaQualityRuleSettings","description":"Configuration for the terminology rule.","example":{"is_enabled":true,"severity":"WARNING"}},"untranslated":{"$ref":"#/components/schemas/LinaQualityRuleSettings","description":"Configuration for the untranslated rule.","example":{"is_enabled":true,"severity":"WARNING"}},"whitespace":{"$ref":"#/components/schemas/LinaQualityRuleSettings","description":"Configuration for the whitespace rule.","example":{"is_enabled":true,"severity":"WARNING"}}},"required":["duplication","length_constraints","locale_formatting","markup","placeholders","punctuation","quotes_and_delimiters","terminology","untranslated","whitespace"],"type":"object"},"LinaQualitySettings":{"description":"A LINA's quality-check settings: which rules run, how severe their findings are and how HTML attributes are checked. They apply to every stack that uses the LINA.","properties":{"created_at":{"description":"Timestamp when the settings were created, together with the LINA.","example":"2026-10-07T00:00:00.123Z","format":"date-time","type":"string"},"id":{"description":"Unique identifier of the LINA the settings belong to.","example":"lina_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^lina_[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}$","type":"string"},"is_html_attribute_check_enabled":{"description":"Whether the markup checks inspect the values of HTML attributes.","example":true,"type":"boolean"},"object_type":{"description":"Always `LINA_QUALITY_SETTINGS`.","enum":["LINA_QUALITY_SETTINGS"],"example":"LINA_QUALITY_SETTINGS","type":"string"},"rules":{"$ref":"#/components/schemas/LinaQualityRules","description":"The ten quality-check rules.","example":{"duplication":{"is_enabled":true,"severity":"WARNING"},"length_constraints":{"is_enabled":true,"severity":"WARNING"},"locale_formatting":{"is_enabled":true,"severity":"WARNING"},"markup":{"is_enabled":true,"severity":"WARNING"},"placeholders":{"is_enabled":true,"severity":"WARNING"},"punctuation":{"is_enabled":true,"severity":"WARNING"},"quotes_and_delimiters":{"is_enabled":true,"severity":"WARNING"},"terminology":{"is_enabled":true,"severity":"WARNING"},"untranslated":{"is_enabled":true,"severity":"WARNING"},"whitespace":{"is_enabled":true,"severity":"WARNING"}}},"translatable_html_attributes":{"description":"Names of the HTML attributes whose values are translated.","example":["alt","title"],"items":{"type":"string"},"type":"array"},"updated_at":{"description":"Timestamp when the settings were last changed.","example":"2026-10-07T00:00:00.123Z","format":"date-time","type":"string"}},"required":["created_at","id","is_html_attribute_check_enabled","object_type","rules","translatable_html_attributes","updated_at"],"type":"object"},"LinaTranslateResult":{"description":"The translations of the texts of one translateLina call. Nothing of it is stored.","properties":{"failure":{"description":"Why not every text was translated; null when `status` is `SUCCEEDED`.","oneOf":[{"$ref":"#/components/schemas/LinaTranslateResultFailure"},{"type":"null"}]},"lina_id":{"description":"LINA that translated the texts.","example":"lina_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^lina_[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}$","type":"string"},"object_type":{"description":"Always `LINA_TRANSLATE_RESULT`.","enum":["LINA_TRANSLATE_RESULT"],"example":"LINA_TRANSLATE_RESULT","type":"string"},"results":{"description":"The translations in the order of `texts`: `results[i]` belongs to `texts[i]`. Check `is_translated` on every item.","example":[{"is_reused":false,"is_translated":true,"linguistic_engine_id":"engine_0197c8f2-5a6b-7cde-8f12-3456789abcde","text":"Hallo"}],"items":{"$ref":"#/components/schemas/LinaTranslateResultText"},"type":"array"},"source_language_code":{"description":"Language of the texts.","example":"en","type":"string"},"status":{"$ref":"#/components/schemas/LinaTranslateResultStatus","description":"Whether every, some or none of the texts were translated.","example":"SUCCEEDED"},"target_language_code":{"description":"Language the texts were translated into.","example":"de","type":"string"}},"required":["failure","lina_id","object_type","results","source_language_code","status","target_language_code"],"type":"object"},"LinaTranslateResultFailure":{"description":"Why not every text was translated:\n  - CREDIT_LIMIT_REACHED: the workspace has no AI credits left.\n  - CONFIGURATION_REQUIRED: the LINA or its engine has to be set up first.\n  - PROVIDER_ACTION_REQUIRED: the engine's provider needs action on your account, e.g. a key or billing.\n  - PROVIDER_UNAVAILABLE: the engine's provider is unavailable for now; try again later.\n  - LANGUAGE_PAIR_UNSUPPORTED: the engine doesn't translate between these languages.\n  - EXECUTION_FAILED: an unexpected error.\n","enum":["CREDIT_LIMIT_REACHED","CONFIGURATION_REQUIRED","PROVIDER_ACTION_REQUIRED","PROVIDER_UNAVAILABLE","LANGUAGE_PAIR_UNSUPPORTED","EXECUTION_FAILED"],"type":"string"},"LinaTranslateResultStatus":{"description":"Whether every text (SUCCEEDED), some (PARTIALLY_SUCCEEDED) or none (FAILED) were translated; check each result.","enum":["SUCCEEDED","PARTIALLY_SUCCEEDED","FAILED"],"type":"string"},"LinaTranslateResultText":{"description":"The translation of one text, at the position of the text in the request.","properties":{"is_reused":{"description":"Whether the translation was reused (from LINA's cache or an exact translation-memory match) instead of produced by the engine.","example":false,"type":"boolean"},"is_translated":{"description":"Whether the text was translated.","example":true,"type":"boolean"},"linguistic_engine_id":{"description":"Engine the translation is attributed to, also for a reused translation; null when the text wasn't translated.","example":"engine_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^engine_[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}$","type":["string","null"]},"text":{"description":"The translation; null when the text wasn't translated.","example":"Hallo","type":["string","null"]}},"required":["is_reused","is_translated","linguistic_engine_id","text"],"type":"object"},"LinguisticEngine":{"description":"A workspace-visible engine and its safe translation capabilities.","properties":{"created_at":{"description":"Stored engine creation time.","example":"2026-09-29T10:00:00.123Z","format":"date-time","type":"string"},"id":{"description":"Unique engine identity.","example":"engine_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^engine_[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}$","type":"string"},"is_enabled":{"description":"Current engine availability including workspace and connection status.","example":true,"type":"boolean"},"is_glossary_context_supported":{"description":"Whether glossary context is supported.","example":true,"type":"boolean"},"is_labels_context_supported":{"description":"Whether labels context is supported.","example":true,"type":"boolean"},"is_segments_context_supported":{"description":"Whether segments context is supported.","example":true,"type":"boolean"},"is_style_guide_context_supported":{"description":"Whether style guide context is supported.","example":true,"type":"boolean"},"is_translation_memory_context_supported":{"description":"Whether translation memory context is supported.","example":true,"type":"boolean"},"linguistic_credits_multiplier_basis_points":{"description":"Credit multiplier in basis points; 10000 is 1.0x.","example":10000,"format":"int32","type":"integer"},"model":{"$ref":"#/components/schemas/LinguisticEngineModel","description":"Configured engine model.","example":"AI_GPT_5_4"},"object_type":{"description":"Always `LINGUISTIC_ENGINE`.","enum":["LINGUISTIC_ENGINE"],"example":"LINGUISTIC_ENGINE","type":"string"},"ownership":{"$ref":"#/components/schemas/LinguisticEngineOwnership","description":"Who provides the engine: LingoHub, or the workspace with its own provider connection. A workspace engine has the model, provider and context support of the LingoHub engine it was added from.","example":"LINGOHUB"},"provider":{"$ref":"#/components/schemas/LinguisticEngineProvider","description":"Model provider.","example":"OPENAI"},"type":{"$ref":"#/components/schemas/LinguisticEngineType","description":"AI or machine translation engine.","example":"AI"},"updated_at":{"description":"Stored engine metadata update time; availability may also change with workspace or connection settings.","example":"2026-09-29T10:00:00.123Z","format":"date-time","type":"string"}},"required":["created_at","id","is_enabled","is_glossary_context_supported","is_labels_context_supported","is_segments_context_supported","is_style_guide_context_supported","is_translation_memory_context_supported","linguistic_credits_multiplier_basis_points","model","object_type","ownership","provider","type","updated_at"],"type":"object"},"LinguisticEngineCollection":{"description":"A cursor-paginated collection of LinguisticEngine resources.","properties":{"data":{"description":"The list of items in this page.","example":[{"created_at":"2026-09-29T10:00:00.123Z","id":"engine_0197c8f2-5a6b-7cde-8f12-3456789abcde","is_enabled":true,"is_glossary_context_supported":true,"is_labels_context_supported":true,"is_segments_context_supported":true,"is_style_guide_context_supported":true,"is_translation_memory_context_supported":true,"linguistic_credits_multiplier_basis_points":10000,"model":"AI_GPT_5_4","object_type":"LINGUISTIC_ENGINE","ownership":"LINGOHUB","provider":"OPENAI","type":"AI","updated_at":"2026-09-29T10:00:00.123Z"}],"items":{"$ref":"#/components/schemas/LinguisticEngine"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"LinguisticEngineFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+linguistic_engine[created_at]","-linguistic_engine[created_at]","+linguistic_engine[updated_at]","-linguistic_engine[updated_at]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/LinguisticEngineFilterGroup"}},"type":"object"},"LinguisticEngineFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/LinguisticEngineFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/LinguisticEngineFilterClause"},"minItems":1,"type":"array"},"linguistic_engine[created_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"linguistic_engine[id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^engine_[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}$","type":"string"},"_in":{"items":{"pattern":"^engine_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^engine_[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}$","type":"string"},"_nin":{"items":{"pattern":"^engine_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"linguistic_engine[model]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["MT_GOOGLE_TRANSLATE_V3","MT_DEEPL_TRANSLATE_V1","MT_AWS_TRANSLATE","AI_GPT_5_4","AI_GPT_5_4_MINI","AI_GPT_5_4_NANO","AI_GPT_5_6_SOL","AI_GPT_5_6_TERRA","AI_GPT_5_6_LUNA","AI_GEMINI_2_5_FLASH","AI_GEMINI_2_5_PRO","AI_GEMINI_3_6_FLASH","AI_GEMINI_3_5_FLASH_LITE","AI_CLAUDE_OPUS_4_7","AI_CLAUDE_SONNET_4_6","AI_CLAUDE_HAIKU_4_5","AI_CLAUDE_OPUS_5","AI_CLAUDE_SONNET_5","AI_MISTRAL_LARGE_3","AI_MISTRAL_SMALL_4","AI_MISTRAL_MEDIUM_3_5","AI_MISTRAL_LARGE_4","AI_GPT_6_LUNA","AI_GPT_6_1_TERRA","AI_GPT_6_1_SOL","AI_GEMINI_3_8_FLASH","AI_CLAUDE_OPUS_5_5","AI_CLAUDE_SONNET_5_5","AI_CLAUDE_HAIKU_5_5"],"type":"string"},"_in":{"items":{"enum":["MT_GOOGLE_TRANSLATE_V3","MT_DEEPL_TRANSLATE_V1","MT_AWS_TRANSLATE","AI_GPT_5_4","AI_GPT_5_4_MINI","AI_GPT_5_4_NANO","AI_GPT_5_6_SOL","AI_GPT_5_6_TERRA","AI_GPT_5_6_LUNA","AI_GEMINI_2_5_FLASH","AI_GEMINI_2_5_PRO","AI_GEMINI_3_6_FLASH","AI_GEMINI_3_5_FLASH_LITE","AI_CLAUDE_OPUS_4_7","AI_CLAUDE_SONNET_4_6","AI_CLAUDE_HAIKU_4_5","AI_CLAUDE_OPUS_5","AI_CLAUDE_SONNET_5","AI_MISTRAL_LARGE_3","AI_MISTRAL_SMALL_4","AI_MISTRAL_MEDIUM_3_5","AI_MISTRAL_LARGE_4","AI_GPT_6_LUNA","AI_GPT_6_1_TERRA","AI_GPT_6_1_SOL","AI_GEMINI_3_8_FLASH","AI_CLAUDE_OPUS_5_5","AI_CLAUDE_SONNET_5_5","AI_CLAUDE_HAIKU_5_5"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["MT_GOOGLE_TRANSLATE_V3","MT_DEEPL_TRANSLATE_V1","MT_AWS_TRANSLATE","AI_GPT_5_4","AI_GPT_5_4_MINI","AI_GPT_5_4_NANO","AI_GPT_5_6_SOL","AI_GPT_5_6_TERRA","AI_GPT_5_6_LUNA","AI_GEMINI_2_5_FLASH","AI_GEMINI_2_5_PRO","AI_GEMINI_3_6_FLASH","AI_GEMINI_3_5_FLASH_LITE","AI_CLAUDE_OPUS_4_7","AI_CLAUDE_SONNET_4_6","AI_CLAUDE_HAIKU_4_5","AI_CLAUDE_OPUS_5","AI_CLAUDE_SONNET_5","AI_MISTRAL_LARGE_3","AI_MISTRAL_SMALL_4","AI_MISTRAL_MEDIUM_3_5","AI_MISTRAL_LARGE_4","AI_GPT_6_LUNA","AI_GPT_6_1_TERRA","AI_GPT_6_1_SOL","AI_GEMINI_3_8_FLASH","AI_CLAUDE_OPUS_5_5","AI_CLAUDE_SONNET_5_5","AI_CLAUDE_HAIKU_5_5"],"type":"string"},"_nin":{"items":{"enum":["MT_GOOGLE_TRANSLATE_V3","MT_DEEPL_TRANSLATE_V1","MT_AWS_TRANSLATE","AI_GPT_5_4","AI_GPT_5_4_MINI","AI_GPT_5_4_NANO","AI_GPT_5_6_SOL","AI_GPT_5_6_TERRA","AI_GPT_5_6_LUNA","AI_GEMINI_2_5_FLASH","AI_GEMINI_2_5_PRO","AI_GEMINI_3_6_FLASH","AI_GEMINI_3_5_FLASH_LITE","AI_CLAUDE_OPUS_4_7","AI_CLAUDE_SONNET_4_6","AI_CLAUDE_HAIKU_4_5","AI_CLAUDE_OPUS_5","AI_CLAUDE_SONNET_5","AI_MISTRAL_LARGE_3","AI_MISTRAL_SMALL_4","AI_MISTRAL_MEDIUM_3_5","AI_MISTRAL_LARGE_4","AI_GPT_6_LUNA","AI_GPT_6_1_TERRA","AI_GPT_6_1_SOL","AI_GEMINI_3_8_FLASH","AI_CLAUDE_OPUS_5_5","AI_CLAUDE_SONNET_5_5","AI_CLAUDE_HAIKU_5_5"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"linguistic_engine[updated_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"}},"type":"object"},"LinguisticEngineFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/LinguisticEngineFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/LinguisticEngineFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"LinguisticEngineModel":{"description":"The model an engine runs. New models are added over time, so clients must accept values they don't know.","enum":["MT_GOOGLE_TRANSLATE_V3","MT_DEEPL_TRANSLATE_V1","MT_AWS_TRANSLATE","AI_GPT_5_4","AI_GPT_5_4_MINI","AI_GPT_5_4_NANO","AI_GPT_5_6_SOL","AI_GPT_5_6_TERRA","AI_GPT_5_6_LUNA","AI_GEMINI_2_5_FLASH","AI_GEMINI_2_5_PRO","AI_GEMINI_3_6_FLASH","AI_GEMINI_3_5_FLASH_LITE","AI_CLAUDE_OPUS_4_7","AI_CLAUDE_SONNET_4_6","AI_CLAUDE_HAIKU_4_5","AI_CLAUDE_OPUS_5","AI_CLAUDE_SONNET_5","AI_MISTRAL_LARGE_3","AI_MISTRAL_SMALL_4","AI_MISTRAL_MEDIUM_3_5","AI_MISTRAL_LARGE_4","AI_GPT_6_LUNA","AI_GPT_6_1_TERRA","AI_GPT_6_1_SOL","AI_GEMINI_3_8_FLASH","AI_CLAUDE_OPUS_5_5","AI_CLAUDE_SONNET_5_5","AI_CLAUDE_HAIKU_5_5"],"type":"string"},"LinguisticEngineOwnership":{"description":"Who provides the engine. `LINGOHUB`: an engine LingoHub provides to every workspace. `WORKSPACE`: an engine the workspace added with its own provider connection (its own provider API key).","enum":["LINGOHUB","WORKSPACE"],"type":"string"},"LinguisticEngineProvider":{"description":"The company whose service runs the engine's model.","enum":["GOOGLE","DEEPL","AWS","OPENAI","ANTHROPIC","MISTRAL"],"type":"string"},"LinguisticEngineType":{"description":"`AI`: a large language model that can use context such as glossaries and style guides. `MT`: a machine translation service.","enum":["MT","AI"],"type":"string"},"Locale":{"description":"A locale supported by LingoHub. This is a read-only reference resource used to discover which target languages can be configured for a project or stack.","properties":{"direction":{"$ref":"#/components/schemas/TextDirection","description":"Writing direction of the locale.","example":"LTR"},"english_name":{"description":"Name of the locale in English.","example":"German (Austria)","type":"string"},"id":{"description":"Unique identifier of the locale.","example":"lo_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^lo_[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}$","type":"string"},"language_code":{"description":"Language code that uniquely identifies the locale.","example":"de-AT","type":"string"},"object_type":{"description":"Always `LOCALE`.","enum":["LOCALE"],"example":"LOCALE","type":"string"}},"required":["direction","english_name","id","language_code","object_type"],"type":"object"},"LocaleFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+locale[english_name]","-locale[english_name]","+locale[language_code]","-locale[language_code]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/LocaleFilterGroup"}},"type":"object"},"LocaleFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/LocaleFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/LocaleFilterClause"},"minItems":1,"type":"array"},"locale[direction]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["LTR","RTL"],"type":"string"},"_in":{"items":{"enum":["LTR","RTL"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["LTR","RTL"],"type":"string"},"_nin":{"items":{"enum":["LTR","RTL"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"locale[english_name]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"locale[language_code]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_in":{"items":{"type":"string"},"minItems":1,"type":"array"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nin":{"items":{"type":"string"},"minItems":1,"type":"array"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"}},"type":"object"},"LocaleFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/LocaleFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/LocaleFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"Matching":{"description":"Strategy used to match the term against translatable text.","enum":["AUTOMATIC","FUZZY","PREFIX","EXACT","CUSTOM"],"type":"string"},"Member":{"description":"A workspace membership with current public profile fields and role identity. Timestamps describe membership metadata; the ETag also covers current profile fields.","properties":{"created_at":{"description":"Time the membership was created (joined the workspace).","example":"2026-09-29T10:00:00.123Z","format":"date-time","type":"string"},"email":{"description":"Current account email, when available.","example":"translator@example.com","type":["string","null"]},"first_name":{"description":"Current first name, when provided.","example":"Alex","type":["string","null"]},"id":{"description":"Unique identifier of the membership. Anything that is only about the membership uses this id; it is gone once the member leaves the workspace.","example":"wsu_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^wsu_[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}$","type":"string"},"is_owner":{"description":"Whether the member has the workspace's owner role. Owners can't be changed or removed through the API (409 `owner_membership_protected`).","example":false,"type":"boolean"},"last_name":{"description":"Current last name, when provided.","example":"Muster","type":["string","null"]},"object_type":{"description":"Always `MEMBER`.","enum":["MEMBER"],"example":"MEMBER","type":"string"},"updated_at":{"description":"Stored membership metadata update time; account profile updates are independent.","example":"2026-09-29T10:00:00.123Z","format":"date-time","type":"string"},"user_id":{"description":"Id of the member's LingoHub user account. The same person has the same `user_id` in every workspace.","example":"usr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^usr_[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}$","type":"string"},"workspace_role_id":{"description":"Current role in this workspace.","example":"rol_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^rol_[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}$","type":"string"}},"required":["created_at","email","first_name","id","is_owner","last_name","object_type","updated_at","user_id","workspace_role_id"],"type":"object"},"MemberCollection":{"description":"A cursor-paginated collection of workspace members.","properties":{"data":{"description":"The list of items in this page.","example":[{"created_at":"2026-09-29T10:00:00.123Z","email":"translator@example.com","first_name":"Alex","id":"wsu_0197c8f2-5a6b-7cde-8f12-3456789abcde","is_owner":false,"last_name":"Muster","object_type":"MEMBER","updated_at":"2026-09-29T10:00:00.123Z","user_id":"usr_0197c8f2-5a6b-7cde-8f12-3456789abcde","workspace_role_id":"rol_0197c8f2-5a6b-7cde-8f12-3456789abcde"}],"items":{"$ref":"#/components/schemas/Member"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"MemberFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+member[created_at]","-member[created_at]","+member[updated_at]","-member[updated_at]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/MemberFilterGroup"}},"type":"object"},"MemberFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/MemberFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/MemberFilterClause"},"minItems":1,"type":"array"},"member[created_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"member[email]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"member[first_name]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"member[id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^wsu_[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}$","type":"string"},"_in":{"items":{"pattern":"^wsu_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^wsu_[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}$","type":"string"},"_nin":{"items":{"pattern":"^wsu_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"member[last_name]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"member[updated_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"member[workspace_role_id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^rol_[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}$","type":"string"},"_in":{"items":{"pattern":"^rol_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^rol_[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}$","type":"string"},"_nin":{"items":{"pattern":"^rol_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"}},"type":"object"},"MemberFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/MemberFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/MemberFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"MoveProject":{"additionalProperties":false,"description":"Request body to move a project into an existing stack.","properties":{"stack_id":{"description":"The destination stack: a stack of this workspace with the project's source language. A project in a shared stack can only move to another shared stack.","example":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stack_[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}$","type":"string"}},"required":["stack_id"],"type":"object"},"NotTranslatableReason":{"description":"Origin of a segment's not-translatable flag: file syntax or an editor/bulk action.","enum":["RESOURCE_FILE","EDITOR"],"type":"string"},"PartOfSpeech":{"description":"Part of speech of the term form.","enum":["NOUN","VERB","ADJECTIVE","ADVERB","PROPER_NOUN","OTHER"],"type":"string"},"Permission":{"description":"The access level the represented principal has to one area, in the vocabulary of `required_permission` in 403 responses.","properties":{"level":{"$ref":"#/components/schemas/PermissionLevel","description":"The access level granted.","example":"MANAGE"},"scope":{"$ref":"#/components/schemas/PermissionScope","description":"Where the permission applies.","example":"STACK"},"target":{"$ref":"#/components/schemas/PermissionTarget","description":"The area the permission governs.","example":"RESOURCES"}},"required":["level","scope","target"],"type":"object"},"PermissionLevel":{"description":"Access level of a permission: `MANAGE` includes `WRITE` and `VIEW`.","enum":["NO_ACCESS","VIEW","WRITE","MANAGE"],"type":"string"},"PermissionScope":{"description":"Where a permission applies: `WORKSPACE` permissions cover workspace-level resources, `STACK` permissions the resources of a stack (its projects, branches, resources, languages, ...).","enum":["WORKSPACE","STACK"],"type":"string"},"PermissionTarget":{"description":"The area a permission governs.","enum":["GENERAL","BILLING_SUBSCRIPTION","WORKSPACES","MEMBERS","PLUGINS_INTEGRATIONS","LOGS","API_ACCESS","STACKS","TRANSLATION_ORDERS","WORK_REPORTS","STYLE_GUIDES","GLOSSARIES","TRANSLATION_MEMORIES","LABELS","AI_TRANSLATION","QUICK_TRANSLATIONS","SETTINGS","ACTIVITIES","RESOURCES","CONTEXT_IMAGES","LANGUAGES","SEGMENT_KEYS","SEGMENTS","SEGMENT_TEXTS"],"type":"string"},"PlaceholderDefinition":{"description":"A supported placeholder-recognition profile. Array order defines recognition precedence; this is not a generic syntax-conversion capability.","enum":["DEFAULT_ICU","DEFAULT_PRINTF","IOS_PRINTF","ANDROID_PRINTF","TWINE_PRINTF","STRINGSDICT_VARIABLE_START_END","STRING_CATALOG_SUBSTITUTION_VARIABLE","RAILS_YAML_START_END","SYMFONY_YAML_START_END","JSON_TEMPLATE_START_END","JSON_REFERENCE_START_END","DEFAULT_REPEAT_CHARACTERS","CHROME_I18N_REPEAT_CHARACTERS","JSON_REPEAT_CHARACTERS","I18_NEXT_REPEAT_CHARACTERS","NQC_REPEAT_CHARACTERS","DOCUMENT_CODE_MARKUP","CHROME_I18N_NUMBERED","QT_LINGUIST_TS_NUMBERED","ANDROID_XLIFF_G","XLIFF_X","XLIFF_BPT","XLIFF_EPT","XLIFF_IT","XLIFF_PH","XLIFF_G","XLIFF_BX","XLIFF_EX"],"type":"string"},"Project":{"description":"A LingoHub localization project within a workspace.","properties":{"ai_context":{"description":"Context that tells LINA what the project is about; LINA gets it together with the stack's context.","example":"My app is a revolutionary new platform for...","maxLength":512,"minLength":0,"type":["string","null"]},"color":{"description":"Hex color code of the project icon.","example":"#FF5733","maxLength":7,"minLength":7,"pattern":"#[0-9a-fA-F]{6}","type":"string"},"created_at":{"description":"Timestamp when the project was created.","example":"2025-01-15T10:30:00.123Z","format":"date-time","type":"string"},"default_branch_id":{"description":"Unique identifier of the project's default branch. Null only while the project is being created.","example":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":["string","null"]},"id":{"description":"Unique identifier of the project.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^pr_[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}$","type":"string"},"name":{"description":"Display name of the project. createProject and updateProject set 2 to 255 characters; projects created by other clients can have longer names, up to 4096.","example":"My App","maxLength":4096,"minLength":0,"type":"string"},"object_type":{"description":"Always `PROJECT`.","enum":["PROJECT"],"example":"PROJECT","type":"string"},"stack_id":{"description":"Unique identifier of the stack assigned to this project.","example":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stack_[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}$","type":"string"},"type":{"$ref":"#/components/schemas/ProjectType","description":"The project's file format, or the platform it syncs with.","example":"GO_I18N_JSON"},"updated_at":{"description":"Timestamp when the project was last updated.","example":"2025-06-20T14:45:00.123Z","format":"date-time","type":"string"},"website":{"description":"Website belonging to the project, or null. updateProject sets at most 256 characters; other clients can set up to 4096.","example":"myapp.dev","maxLength":4096,"minLength":0,"type":["string","null"]}},"required":["ai_context","color","created_at","default_branch_id","id","name","object_type","stack_id","type","updated_at","website"],"type":"object"},"ProjectCollection":{"description":"A list of LingoHub projects with pagination capability.","properties":{"data":{"description":"The list of items in this page.","example":[{"ai_context":"My app is a revolutionary new platform for...","color":"#FF5733","created_at":"2025-01-15T10:30:00.123Z","default_branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","id":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","name":"My App","object_type":"PROJECT","stack_id":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","type":"GO_I18N_JSON","updated_at":"2025-06-20T14:45:00.123Z","website":"myapp.dev"}],"items":{"$ref":"#/components/schemas/Project"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"ProjectContentfulIntegration":{"description":"Stored Contentful configuration. Reading performs no external provider request.","properties":{"authentication_id":{"description":"Stored provider authentication identity. No credentials are returned.","example":"iau_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^iau_[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}$","type":"string"},"connection_status":{"$ref":"#/components/schemas/ContentConnectionStatus","description":"Stored authentication lifecycle, not a live provider connectivity test.","example":"ACTIVE"},"created_at":{"description":"Creation time of the persisted integration settings.","example":"2026-10-07T00:00:00.123Z","format":"date-time","type":"string"},"default_branch_id":{"description":"Current default branch used by the existing project-level provider workflows.","example":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"},"environment_key":{"description":"Provider environment, represented by the existing default branch name.","example":"master","type":"string"},"id":{"description":"Public project identity addressing this singleton configuration.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^pr_[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}$","type":"string"},"last_pull_at":{"description":"When a pull last succeeded; null before the first one.","example":"2026-10-07T00:00:00.123Z","format":"date-time","type":["string","null"]},"last_push_at":{"description":"When a push last succeeded; null before the first one.","example":"2026-10-07T00:00:00.123Z","format":"date-time","type":["string","null"]},"object_type":{"description":"Always `PROJECT_CONTENTFUL_INTEGRATION`.","enum":["PROJECT_CONTENTFUL_INTEGRATION"],"example":"PROJECT_CONTENTFUL_INTEGRATION","type":"string"},"path_filters":{"description":"Stored selection rules. Configuration values are not a separate paginated resource inventory.","example":[{"type":"INCLUDE","value":"**"}],"items":{"$ref":"#/components/schemas/ContentPathFilter"},"type":"array"},"space_key":{"description":"Stored Contentful space key. This is an external provider value, not a LingoHub identity.","example":"docs","type":["string","null"]},"space_name":{"description":"Stored Contentful space name.","example":"Documentation","type":["string","null"]},"updated_at":{"description":"Update time of the persisted integration settings. Related provider data and selection can change the ETag independently.","example":"2026-10-07T00:00:00.123Z","format":"date-time","type":"string"}},"required":["authentication_id","connection_status","created_at","default_branch_id","environment_key","id","last_pull_at","last_push_at","object_type","path_filters","space_key","space_name","updated_at"],"type":"object"},"ProjectCrispHelpdeskIntegration":{"description":"Stored Crisp Helpdesk configuration. Reading performs no external provider request.","properties":{"authentication_id":{"description":"Stored provider authentication identity. No credentials are returned.","example":"iau_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^iau_[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}$","type":"string"},"connection_status":{"$ref":"#/components/schemas/ContentConnectionStatus","description":"Stored authentication lifecycle, not a live provider connectivity test.","example":"ACTIVE"},"created_at":{"description":"Creation time of the persisted integration settings.","example":"2026-10-07T00:00:00.123Z","format":"date-time","type":"string"},"default_branch_id":{"description":"Current default branch used by the existing project-level provider workflows.","example":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"},"id":{"description":"Public project identity addressing this singleton configuration.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^pr_[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}$","type":"string"},"is_publish_on_push":{"description":"Whether translations are published by the existing push workflow.","example":false,"type":"boolean"},"last_pull_at":{"description":"When a pull last succeeded; null before the first one.","example":"2026-10-07T00:00:00.123Z","format":"date-time","type":["string","null"]},"last_push_at":{"description":"When a push last succeeded; null before the first one.","example":"2026-10-07T00:00:00.123Z","format":"date-time","type":["string","null"]},"object_type":{"description":"Always `PROJECT_CRISP_HELPDESK_INTEGRATION`.","enum":["PROJECT_CRISP_HELPDESK_INTEGRATION"],"example":"PROJECT_CRISP_HELPDESK_INTEGRATION","type":"string"},"updated_at":{"description":"Update time of the persisted integration settings. Related provider data and selection can change the ETag independently.","example":"2026-10-07T00:00:00.123Z","format":"date-time","type":"string"}},"required":["authentication_id","connection_status","created_at","default_branch_id","id","is_publish_on_push","last_pull_at","last_push_at","object_type","updated_at"],"type":"object"},"ProjectExportSettings":{"description":"Which texts exports write by default. An export can bring its own settings instead.","properties":{"html_encoding":{"$ref":"#/components/schemas/HtmlEncoding","description":"How exports write HTML in the formats that support it.","example":"CDATA"},"is_not_translatable_skipped":{"description":"Whether exports exclude not-translatable entries.","example":false,"type":"boolean"},"source_empty_content_handling":{"$ref":"#/components/schemas/BlankContentHandling","description":"What an export does with an empty source text.","example":"KEEP"},"source_statuses":{"description":"The statuses a source text needs to be exported. Null on older projects that never stored a selection.","example":["APPROVED"],"items":{"$ref":"#/components/schemas/TextStatus"},"type":["array","null"]},"target_empty_content_handling":{"$ref":"#/components/schemas/BlankContentHandling","description":"What an export does with an empty target text.","example":"KEEP"},"target_statuses":{"description":"The statuses a target text needs to be exported. Null on older projects that never stored a selection.","example":["APPROVED"],"items":{"$ref":"#/components/schemas/TextStatus"},"type":["array","null"]}},"required":["html_encoding","is_not_translatable_skipped","source_empty_content_handling","source_statuses","target_empty_content_handling","target_statuses"],"type":"object"},"ProjectFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+project[created_at]","-project[created_at]","+project[name]","-project[name]","+project[updated_at]","-project[updated_at]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/ProjectFilterGroup"}},"type":"object"},"ProjectFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/ProjectFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/ProjectFilterClause"},"minItems":1,"type":"array"},"project[created_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"project[id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^pr_[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}$","type":"string"},"_in":{"items":{"pattern":"^pr_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^pr_[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}$","type":"string"},"_nin":{"items":{"pattern":"^pr_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"project[name]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"project[stack_id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^stack_[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}$","type":"string"},"_in":{"items":{"pattern":"^stack_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^stack_[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}$","type":"string"},"_nin":{"items":{"pattern":"^stack_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"project[type]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["ANDROID_XML","IOS_STRINGS","IOS_STRINGS_CATALOG","STANDARD_PROPERTIES","GETTEXT_PO","WINDOWS_RESX","QT_LINGUIST_TS","DEFINE_PHP","STANDARD_INI","STANDARD_ARB","RAILS_YAML","SYMFONY_YAML","STANDARD_JSON","ANGULAR_TRANSLATE_JSON","CHROME_I18N_JSON","GO_I18N_JSON","I18NEXT_JSON","REACT_INTL_JSON","STANDARD_CSV","SINGLE_LANGUAGE_CSV","KEY_VALUE_CSV","STANDARD_XLIFF","STANDARD_XLIFF_2","STANDARD_TXT","TWINE_TXT","STANDARD_MARKDOWN","STANDARD_HTML","FIGMA","ZENDESK","STORYBLOK","STORYBLOK_JSON","CONTENTFUL","SUBTITLE_SRT","SUBTITLE_VTT","HUBSPOT","STRIPO","CRISP_HELPDESK","DOCUMENT","VUE_I18N_JSON"],"type":"string"},"_in":{"items":{"enum":["ANDROID_XML","IOS_STRINGS","IOS_STRINGS_CATALOG","STANDARD_PROPERTIES","GETTEXT_PO","WINDOWS_RESX","QT_LINGUIST_TS","DEFINE_PHP","STANDARD_INI","STANDARD_ARB","RAILS_YAML","SYMFONY_YAML","STANDARD_JSON","ANGULAR_TRANSLATE_JSON","CHROME_I18N_JSON","GO_I18N_JSON","I18NEXT_JSON","REACT_INTL_JSON","STANDARD_CSV","SINGLE_LANGUAGE_CSV","KEY_VALUE_CSV","STANDARD_XLIFF","STANDARD_XLIFF_2","STANDARD_TXT","TWINE_TXT","STANDARD_MARKDOWN","STANDARD_HTML","FIGMA","ZENDESK","STORYBLOK","STORYBLOK_JSON","CONTENTFUL","SUBTITLE_SRT","SUBTITLE_VTT","HUBSPOT","STRIPO","CRISP_HELPDESK","DOCUMENT","VUE_I18N_JSON"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["ANDROID_XML","IOS_STRINGS","IOS_STRINGS_CATALOG","STANDARD_PROPERTIES","GETTEXT_PO","WINDOWS_RESX","QT_LINGUIST_TS","DEFINE_PHP","STANDARD_INI","STANDARD_ARB","RAILS_YAML","SYMFONY_YAML","STANDARD_JSON","ANGULAR_TRANSLATE_JSON","CHROME_I18N_JSON","GO_I18N_JSON","I18NEXT_JSON","REACT_INTL_JSON","STANDARD_CSV","SINGLE_LANGUAGE_CSV","KEY_VALUE_CSV","STANDARD_XLIFF","STANDARD_XLIFF_2","STANDARD_TXT","TWINE_TXT","STANDARD_MARKDOWN","STANDARD_HTML","FIGMA","ZENDESK","STORYBLOK","STORYBLOK_JSON","CONTENTFUL","SUBTITLE_SRT","SUBTITLE_VTT","HUBSPOT","STRIPO","CRISP_HELPDESK","DOCUMENT","VUE_I18N_JSON"],"type":"string"},"_nin":{"items":{"enum":["ANDROID_XML","IOS_STRINGS","IOS_STRINGS_CATALOG","STANDARD_PROPERTIES","GETTEXT_PO","WINDOWS_RESX","QT_LINGUIST_TS","DEFINE_PHP","STANDARD_INI","STANDARD_ARB","RAILS_YAML","SYMFONY_YAML","STANDARD_JSON","ANGULAR_TRANSLATE_JSON","CHROME_I18N_JSON","GO_I18N_JSON","I18NEXT_JSON","REACT_INTL_JSON","STANDARD_CSV","SINGLE_LANGUAGE_CSV","KEY_VALUE_CSV","STANDARD_XLIFF","STANDARD_XLIFF_2","STANDARD_TXT","TWINE_TXT","STANDARD_MARKDOWN","STANDARD_HTML","FIGMA","ZENDESK","STORYBLOK","STORYBLOK_JSON","CONTENTFUL","SUBTITLE_SRT","SUBTITLE_VTT","HUBSPOT","STRIPO","CRISP_HELPDESK","DOCUMENT","VUE_I18N_JSON"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"project[updated_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"}},"type":"object"},"ProjectFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/ProjectFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/ProjectFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"ProjectFormatSettings":{"description":"The options of the project's file format, in sections. Which sections a project needs depends on its type: `general` for every file-based type except DOCUMENT; `csv` for STANDARD_CSV, SINGLE_LANGUAGE_CSV and KEY_VALUE_CSV; `escape` for STANDARD_PROPERTIES and STANDARD_INI; `json` for STANDARD_ARB, STANDARD_JSON, ANGULAR_TRANSLATE_JSON, CHROME_I18N_JSON, GO_I18N_JSON, I18NEXT_JSON, REACT_INTL_JSON and VUE_I18N_JSON; `i18next_json` for I18NEXT_JSON; `xliff` for STANDARD_XLIFF; `properties` for STANDARD_PROPERTIES. A section the type doesn't need has no effect.","properties":{"csv":{"description":"CSV options; required for the CSV project types.","example":{"delimiter":";","description_header":"description","is_import_detection_enabled":true,"is_status_exported":false,"key_header":"key","quote":"\""},"oneOf":[{"$ref":"#/components/schemas/CsvFileFormatConfiguration"},{"type":"null"}]},"escape":{"description":"Escaping options; required for STANDARD_PROPERTIES and STANDARD_INI.","example":{"is_character_escaping_enabled":true},"oneOf":[{"$ref":"#/components/schemas/EscapeFileFormatConfiguration"},{"type":"null"}]},"general":{"description":"Options every file format uses.","example":{"charset":"UTF_8","comment_languages":"SOURCE","file_name_languages":"ALL","indentation":2,"is_final_newline_enabled":true,"is_source_used_when_missing":true},"oneOf":[{"$ref":"#/components/schemas/GeneralFileFormatConfiguration"},{"type":"null"}]},"i18next_json":{"description":"i18next options; required for I18NEXT_JSON.","example":{"is_base_plural_exported":false,"version":"VERSION_4"},"oneOf":[{"$ref":"#/components/schemas/I18nextFileFormatConfiguration"},{"type":"null"}]},"json":{"description":"JSON options; required for the JSON and ARB project types.","example":{"is_array_indentation_enabled":false,"is_plural_order_alphabetical":false},"oneOf":[{"$ref":"#/components/schemas/JsonFileFormatConfiguration"},{"type":"null"}]},"properties":{"description":"Properties options; required for STANDARD_PROPERTIES.","example":{"plural_separator":"_"},"oneOf":[{"$ref":"#/components/schemas/PropertiesFileFormatConfiguration"},{"type":"null"}]},"xliff":{"description":"XLIFF options; required for STANDARD_XLIFF.","example":{"is_multi_language":false,"is_resname_identifier":false},"oneOf":[{"$ref":"#/components/schemas/XliffFileFormatConfiguration"},{"type":"null"}]}},"required":["csv","escape","general","i18next_json","json","properties","xliff"],"type":"object"},"ProjectGitIntegration":{"description":"A project's git integration: the repository and connection, when LingoHub pulls and pushes, how it pushes, and which files and branches it syncs. Its id is the project's.","example":{"connection_status":"ACTIVE","created_at":"2026-09-01T10:00:00.123Z","git_authentication_id":"iau_0197c8f2-5a6b-7cde-8f12-3456789abcde","git_branch":"main","id":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","is_self_hosted":false,"last_pull_at":"2026-09-30T08:15:00.123Z","last_push_at":"2026-09-30T09:30:00.123Z","name":"app","namespace":"company","object_type":"PROJECT_GIT_INTEGRATION","provider":"GITHUB","provider_origin":"https://github.com","provider_region":null,"push":{"auto_push_default_branch_type":"PULL_REQUEST","auto_push_other_branches_type":"PUSH","commit_description":"Translations from LingoHub","commit_message":"Update translations","pull_request_branch":"lingohub/translations","pull_request_description":"Translations from LingoHub","pull_request_title":"Update translations","push_type":"PULL_REQUEST"},"selection":{"branch_filters":[{"type":"INCLUDE","value":"release/*"}],"is_branching":true,"path_filters":[{"type":"INCLUDE","value":"locales/**"}]},"sync":{"export_mode":"PERIODIC","export_schedule":{"day_of_week":null,"period":"DAILY","time":"10:30"},"import_mode":"AUTOMATIC","import_schedule":null},"updated_at":"2026-09-15T12:00:00.123Z"},"properties":{"connection_status":{"$ref":"#/components/schemas/GitConnectionStatus","description":"The connection's status, as in listIntegrationAuthentications.","example":"ACTIVE"},"created_at":{"description":"When the project was connected to git.","example":"2026-09-01T10:00:00.123Z","format":"date-time","type":"string"},"git_authentication_id":{"description":"The git connection the integration uses, from listIntegrationAuthentications.","example":"iau_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^iau_[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}$","type":"string"},"git_branch":{"description":"The remote branch the project's default branch syncs with.","example":"main","type":"string"},"id":{"description":"The project's id.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^pr_[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}$","type":"string"},"is_self_hosted":{"description":"Whether the connection is to a self-hosted git server.","example":false,"type":"boolean"},"last_pull_at":{"description":"When a pull of any branch last succeeded; null before the first one.","example":"2026-09-30T08:15:00.123Z","format":"date-time","type":["string","null"]},"last_push_at":{"description":"When a push of any branch last succeeded; null before the first one.","example":"2026-09-30T09:30:00.123Z","format":"date-time","type":["string","null"]},"name":{"description":"The repository's name.","example":"app","type":"string"},"namespace":{"description":"The repository's namespace, as the repository lookups name it; empty for CodeCommit.","example":"company","type":"string"},"object_type":{"description":"Always `PROJECT_GIT_INTEGRATION`.","enum":["PROJECT_GIT_INTEGRATION"],"example":"PROJECT_GIT_INTEGRATION","type":"string"},"provider":{"$ref":"#/components/schemas/GitProvider","description":"The git host of the repository.","example":"GITHUB"},"provider_origin":{"description":"Scheme, host and port of the git host, without credentials or path; null for CodeCommit.","example":"https://github.com","type":["string","null"]},"provider_region":{"description":"The AWS region of a CodeCommit repository; null for other git hosts.","example":"us-east-1","type":["string","null"]},"push":{"$ref":"#/components/schemas/GitPush","description":"How LingoHub pushes."},"selection":{"$ref":"#/components/schemas/GitSelection","description":"Which files and branches LingoHub syncs."},"sync":{"$ref":"#/components/schemas/GitSync","description":"When LingoHub pulls and pushes by itself."},"updated_at":{"description":"When the git settings last changed.","example":"2026-09-15T12:00:00.123Z","format":"date-time","type":"string"}},"required":["connection_status","created_at","git_authentication_id","git_branch","id","is_self_hosted","last_pull_at","last_push_at","name","namespace","object_type","provider","provider_origin","provider_region","push","selection","sync","updated_at"],"type":"object"},"ProjectHubSpotIntegration":{"description":"Stored HubSpot configuration. Reading performs no external provider request.","properties":{"authentication_id":{"description":"Stored provider authentication identity. No credentials are returned.","example":"iau_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^iau_[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}$","type":"string"},"connection_status":{"$ref":"#/components/schemas/ContentConnectionStatus","description":"Stored authentication lifecycle, not a live provider connectivity test.","example":"ACTIVE"},"created_at":{"description":"Creation time of the persisted integration settings.","example":"2026-10-07T00:00:00.123Z","format":"date-time","type":"string"},"default_branch_id":{"description":"Current default branch used by the existing project-level provider workflows.","example":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"},"enabled_content_types":{"description":"Stored content categories enabled for synchronization.","example":["SITE_PAGE"],"items":{"$ref":"#/components/schemas/HubSpotContentType"},"type":"array"},"id":{"description":"Public project identity addressing this singleton configuration.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^pr_[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}$","type":"string"},"is_publish_on_push":{"description":"Whether approved translations are published by the existing push workflow rather than stored as drafts.","example":false,"type":"boolean"},"last_pull_at":{"description":"When a pull last succeeded; null before the first one.","example":"2026-10-07T00:00:00.123Z","format":"date-time","type":["string","null"]},"last_push_at":{"description":"When a push last succeeded; null before the first one.","example":"2026-10-07T00:00:00.123Z","format":"date-time","type":["string","null"]},"object_type":{"description":"Always `PROJECT_HUBSPOT_INTEGRATION`.","enum":["PROJECT_HUBSPOT_INTEGRATION"],"example":"PROJECT_HUBSPOT_INTEGRATION","type":"string"},"path_filters":{"description":"Stored selection rules. Configuration values are not a separate paginated resource inventory.","example":[{"type":"INCLUDE","value":"**"}],"items":{"$ref":"#/components/schemas/ContentPathFilter"},"type":"array"},"updated_at":{"description":"Update time of the persisted integration settings. Related provider data and selection can change the ETag independently.","example":"2026-10-07T00:00:00.123Z","format":"date-time","type":"string"}},"required":["authentication_id","connection_status","created_at","default_branch_id","enabled_content_types","id","is_publish_on_push","last_pull_at","last_push_at","object_type","path_filters","updated_at"],"type":"object"},"ProjectImportSettings":{"description":"What imports do by default with the source texts and the target texts (translations) of a file.","properties":{"is_source_creation_enabled":{"description":"Whether imports may create source text entries.","example":true,"type":"boolean"},"is_source_deactivation_enabled":{"description":"Whether imports may deactivate source entries missing from the input.","example":false,"type":"boolean"},"is_source_metadata_update_enabled":{"description":"Whether imports may update source metadata.","example":true,"type":"boolean"},"is_target_creation_enabled":{"description":"Whether imports may create target text entries.","example":true,"type":"boolean"},"is_target_deactivation_enabled":{"description":"Whether imports may deactivate target entries missing from the input.","example":false,"type":"boolean"},"is_target_metadata_update_enabled":{"description":"Whether imports may update target metadata.","example":true,"type":"boolean"},"source_text_update_mode":{"$ref":"#/components/schemas/TextUpdateMode","description":"When imports may update an existing source text.","example":"ALWAYS"},"target_text_update_mode":{"$ref":"#/components/schemas/TextUpdateMode","description":"When imports may update an existing target text.","example":"ALWAYS"}},"required":["is_source_creation_enabled","is_source_deactivation_enabled","is_source_metadata_update_enabled","is_target_creation_enabled","is_target_deactivation_enabled","is_target_metadata_update_enabled","source_text_update_mode","target_text_update_mode"],"type":"object"},"ProjectIntegrationSettings":{"description":"What a sync of the project's integration deletes; every integration type has them.","properties":{"is_removed_language_deletion_enabled":{"description":"Whether a sync deletes languages the integration no longer reports. The source language is never deleted. Only Contentful, HubSpot, Storyblok, Stripo and Zendesk integrations read this setting; Git and Crisp integrations never delete languages. Enabled by default for Contentful, Zendesk and Storyblok integrations.","example":false,"type":"boolean"},"is_removed_resource_deletion_enabled":{"description":"Whether a Git repository pull deletes files the repository no longer contains. Only Git integrations read this setting; the other integrations always delete resources a sync no longer reports. Enabled by default for Git integrations.","example":true,"type":"boolean"}},"required":["is_removed_language_deletion_enabled","is_removed_resource_deletion_enabled"],"type":"object"},"ProjectKeySettings":{"description":"How the project's keys are normalised.","properties":{"normalization_strategy":{"description":"How keys are normalised when they are imported, created or renamed. Null on older projects that never stored one.","example":"FORMAT_SPECIFIC","oneOf":[{"$ref":"#/components/schemas/KeyNormalizationStrategy"},{"type":"null"}]}},"required":["normalization_strategy"],"type":"object"},"ProjectLanguage":{"description":"A language of a project branch. `file_slug` is this project's own setting; `is_source`, `lina_role` and the fallback come from the stack language and are the same in every project of the stack.","properties":{"created_at":{"description":"Timestamp when the language was added to the branch.","example":"2025-01-15T10:30:00.123Z","format":"date-time","type":"string"},"fallback_language_code":{"description":"The language used when a translation in this language is missing, or null for none. Set on the stack language with updateStackLanguage; the same in every project of the stack.","example":"de","type":["string","null"]},"file_slug":{"description":"The language's name in this project's file names, used instead of the language code; null uses the language code. Set per project with updateProjectLanguage.","example":"de_at","type":["string","null"]},"id":{"description":"Unique identifier of the project language.","example":"prl_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^prl_[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}$","type":"string"},"is_source":{"description":"Whether this is the stack's source language. It comes from the stack language and can't be changed through the API.","example":false,"type":"boolean"},"language_code":{"description":"The language's code; unique in the branch.","example":"de-AT","type":"string"},"lina_role":{"$ref":"#/components/schemas/LanguageLinaRole","description":"What the stack's LINA does in this language. Set on the stack language with updateStackLanguage; the same in every project of the stack.","example":"ASSISTANT"},"object_type":{"description":"Always `PROJECT_LANGUAGE`.","enum":["PROJECT_LANGUAGE"],"example":"PROJECT_LANGUAGE","type":"string"},"updated_at":{"description":"Timestamp when the project language was last updated.","example":"2025-06-20T14:45:00.123Z","format":"date-time","type":"string"}},"required":["created_at","fallback_language_code","file_slug","id","is_source","language_code","lina_role","object_type","updated_at"],"type":"object"},"ProjectLanguageCollection":{"description":"A list of the languages of a branch.","properties":{"data":{"description":"The list of items in this page.","example":[{"created_at":"2025-01-15T10:30:00.123Z","fallback_language_code":"de","file_slug":"de_at","id":"prl_0197c8f2-5a6b-7cde-8f12-3456789abcde","is_source":false,"language_code":"de-AT","lina_role":"ASSISTANT","object_type":"PROJECT_LANGUAGE","updated_at":"2025-06-20T14:45:00.123Z"}],"items":{"$ref":"#/components/schemas/ProjectLanguage"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"ProjectLanguageFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return.","properties":{"where":{"$ref":"#/components/schemas/ProjectLanguageFilterGroup"}},"type":"object"},"ProjectLanguageFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/ProjectLanguageFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/ProjectLanguageFilterClause"},"minItems":1,"type":"array"},"project_language[is_source]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_false":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_true":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"}},"type":"object"},"project_language[language_code]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_gt":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_in":{"items":{"type":"string"},"minItems":1,"type":"array"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nin":{"items":{"type":"string"},"minItems":1,"type":"array"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"}},"type":"object"},"ProjectLanguageFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/ProjectLanguageFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/ProjectLanguageFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"ProjectMove":{"description":"A project move or detach and its status. Access follows the project's current stack.","properties":{"created_at":{"description":"Time the move was scheduled.","example":"2026-01-01T10:00:00.123Z","format":"date-time","type":"string"},"id":{"description":"Public move operation identity.","example":"rsy_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^rsy_[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}$","type":"string"},"object_type":{"description":"Always `PROJECT_MOVE`.","enum":["PROJECT_MOVE"],"example":"PROJECT_MOVE","type":"string"},"project_id":{"description":"Project being moved.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"},"source_stack_id":{"description":"The stack the project was in when the move was requested; null once that stack is deleted. A project's own private stack is removed when the project moves into another stack.","example":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stack_[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}$","type":["string","null"]},"status":{"$ref":"#/components/schemas/ProjectMoveStatus","description":"Stored lifecycle status.","example":"QUEUED"},"status_details":{"description":"Safe recorded outcome explanation, or null when none is recorded.","oneOf":[{"$ref":"#/components/schemas/SyncStatusDetails"},{"type":"null"}]},"target_stack_id":{"description":"The destination stack. For a detach it's the new private stack, null until the detach has created it. Null once the stack is deleted.","example":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcdf","pattern":"^stack_[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}$","type":["string","null"]},"type":{"$ref":"#/components/schemas/ProjectMoveType","description":"Requested move or detachment.","example":"MOVE"},"updated_at":{"description":"Stored metadata update time.","example":"2026-01-01T10:01:00.123Z","format":"date-time","type":"string"}},"required":["created_at","id","object_type","project_id","source_stack_id","status","status_details","target_stack_id","type","updated_at"],"type":"object"},"ProjectMoveJob":{"description":"A project move or detachment scheduled for asynchronous processing.","properties":{"data":{"$ref":"#/components/schemas/ProjectMove","description":"The move operation whose stored metadata can be polled at the Location URL."},"job_type":{"description":"Always `PROJECT_MOVE`.","enum":["PROJECT_MOVE"],"example":"PROJECT_MOVE","type":"string"},"object_type":{"description":"Always `JOB`.","enum":["JOB"],"example":"JOB","type":"string"}},"required":["data","job_type","object_type"],"type":"object"},"ProjectMoveStatus":{"description":"Stored move lifecycle. QUEUED and PROCESSING are pending; SUCCEEDED, PARTIALLY_SUCCEEDED, FAILED, CANCELLED and SKIPPED are terminal. Only SUCCEEDED confirms that the move completed.","enum":["QUEUED","PROCESSING","SUCCEEDED","PARTIALLY_SUCCEEDED","FAILED","CANCELLED","SKIPPED"],"type":"string"},"ProjectMoveType":{"description":"MOVE joins an existing stack; DETACH creates a private stack for the project.","enum":["MOVE","DETACH"],"type":"string"},"ProjectPlaceholderSettings":{"description":"Which placeholders are recognised in the project's texts, for quality checks, LINA and machine translation.","properties":{"default_definitions":{"description":"The placeholder kinds of the project's type; read-only. Send them as `definitions` to go back to the defaults.","example":["DEFAULT_ICU","DEFAULT_PRINTF"],"items":{"$ref":"#/components/schemas/PlaceholderDefinition"},"type":"array"},"definitions":{"description":"The placeholder kinds recognised in texts; the first that matches wins. Empty: none. Null on older projects that never stored a list.","example":["DEFAULT_ICU","DEFAULT_PRINTF"],"items":{"$ref":"#/components/schemas/PlaceholderDefinition"},"type":["array","null"]},"is_default":{"description":"`definitions` equals `default_definitions`; read-only.","example":true,"type":"boolean"}},"required":["default_definitions","definitions","is_default"],"type":"object"},"ProjectSettings":{"description":"All settings of a project: export and import defaults, file-format options, key normalisation, placeholder recognition and, if the project has an integration, the integration settings.","properties":{"export":{"$ref":"#/components/schemas/ProjectExportSettings","description":"Export defaults."},"format":{"description":"File-format options; null for documents and integration projects, which have none.","oneOf":[{"$ref":"#/components/schemas/ProjectFormatSettings"},{"type":"null"}]},"id":{"description":"The project these settings belong to.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^pr_[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}$","type":"string"},"import":{"$ref":"#/components/schemas/ProjectImportSettings","description":"Import defaults."},"integrations":{"description":"Integration settings; null when the project has no integration.","oneOf":[{"$ref":"#/components/schemas/ProjectIntegrationSettings"},{"type":"null"}]},"keys":{"$ref":"#/components/schemas/ProjectKeySettings","description":"Key normalisation."},"object_type":{"description":"Always `PROJECT_SETTINGS`.","enum":["PROJECT_SETTINGS"],"example":"PROJECT_SETTINGS","type":"string"},"placeholders":{"$ref":"#/components/schemas/ProjectPlaceholderSettings","description":"Placeholder recognition."}},"required":["export","format","id","import","integrations","keys","object_type","placeholders"],"type":"object"},"ProjectStoryblokIntegration":{"description":"Stored Storyblok configuration. Reading performs no external provider request.","properties":{"authentication_id":{"description":"Stored provider authentication identity. No credentials are returned.","example":"iau_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^iau_[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}$","type":"string"},"connection_status":{"$ref":"#/components/schemas/ContentConnectionStatus","description":"Stored authentication lifecycle, not a live provider connectivity test.","example":"ACTIVE"},"created_at":{"description":"Creation time of the persisted integration settings.","example":"2026-10-07T00:00:00.123Z","format":"date-time","type":"string"},"default_branch_id":{"description":"Current default branch used by the existing project-level provider workflows.","example":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"},"id":{"description":"Public project identity addressing this singleton configuration.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^pr_[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}$","type":"string"},"last_pull_at":{"description":"When a pull last succeeded; null before the first one.","example":"2026-10-07T00:00:00.123Z","format":"date-time","type":["string","null"]},"last_push_at":{"description":"When a push last succeeded; null before the first one.","example":"2026-10-07T00:00:00.123Z","format":"date-time","type":["string","null"]},"object_type":{"description":"Always `PROJECT_STORYBLOK_INTEGRATION`.","enum":["PROJECT_STORYBLOK_INTEGRATION"],"example":"PROJECT_STORYBLOK_INTEGRATION","type":"string"},"path_filters":{"description":"Stored selection rules. Configuration values are not a separate paginated resource inventory.","example":[{"type":"INCLUDE","value":"**"}],"items":{"$ref":"#/components/schemas/ContentPathFilter"},"type":"array"},"space_key":{"description":"Stored Storyblok space key. This is an external provider value, not a LingoHub identity.","example":"12345","type":["string","null"]},"space_name":{"description":"Stored Storyblok space name.","example":"Documentation","type":["string","null"]},"updated_at":{"description":"Update time of the persisted integration settings. Related provider data and selection can change the ETag independently.","example":"2026-10-07T00:00:00.123Z","format":"date-time","type":"string"}},"required":["authentication_id","connection_status","created_at","default_branch_id","id","last_pull_at","last_push_at","object_type","path_filters","space_key","space_name","updated_at"],"type":"object"},"ProjectStripoIntegration":{"description":"Stored Stripo configuration. Reading performs no external provider request.","properties":{"authentication_id":{"description":"Stored provider authentication identity. No credentials are returned.","example":"iau_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^iau_[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}$","type":"string"},"connection_status":{"$ref":"#/components/schemas/ContentConnectionStatus","description":"Stored authentication lifecycle, not a live provider connectivity test.","example":"ACTIVE"},"created_at":{"description":"Creation time of the persisted integration settings.","example":"2026-10-07T00:00:00.123Z","format":"date-time","type":"string"},"default_branch_id":{"description":"Current default branch used by the existing project-level provider workflows.","example":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"},"id":{"description":"Public project identity addressing this singleton configuration.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^pr_[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}$","type":"string"},"last_pull_at":{"description":"When a pull last succeeded; null before the first one.","example":"2026-10-07T00:00:00.123Z","format":"date-time","type":["string","null"]},"last_push_at":{"description":"When a push last succeeded; null before the first one.","example":"2026-10-07T00:00:00.123Z","format":"date-time","type":["string","null"]},"object_type":{"description":"Always `PROJECT_STRIPO_INTEGRATION`.","enum":["PROJECT_STRIPO_INTEGRATION"],"example":"PROJECT_STRIPO_INTEGRATION","type":"string"},"path_filters":{"description":"Stored selection rules. Configuration values are not a separate paginated resource inventory.","example":[{"type":"INCLUDE","value":"**"}],"items":{"$ref":"#/components/schemas/ContentPathFilter"},"type":"array"},"updated_at":{"description":"Update time of the persisted integration settings. Related provider data and selection can change the ETag independently.","example":"2026-10-07T00:00:00.123Z","format":"date-time","type":"string"}},"required":["authentication_id","connection_status","created_at","default_branch_id","id","last_pull_at","last_push_at","object_type","path_filters","updated_at"],"type":"object"},"ProjectType":{"description":"The project's file format, or the platform it syncs with (for example `CONTENTFUL` or `ZENDESK`). It decides which files the project accepts and can't be changed after creation.","enum":["ANDROID_XML","IOS_STRINGS","IOS_STRINGS_CATALOG","STANDARD_PROPERTIES","GETTEXT_PO","WINDOWS_RESX","QT_LINGUIST_TS","DEFINE_PHP","STANDARD_INI","STANDARD_ARB","RAILS_YAML","SYMFONY_YAML","STANDARD_JSON","ANGULAR_TRANSLATE_JSON","CHROME_I18N_JSON","GO_I18N_JSON","I18NEXT_JSON","REACT_INTL_JSON","STANDARD_CSV","SINGLE_LANGUAGE_CSV","KEY_VALUE_CSV","STANDARD_XLIFF","STANDARD_XLIFF_2","STANDARD_TXT","TWINE_TXT","STANDARD_MARKDOWN","STANDARD_HTML","FIGMA","ZENDESK","STORYBLOK","STORYBLOK_JSON","CONTENTFUL","SUBTITLE_SRT","SUBTITLE_VTT","HUBSPOT","STRIPO","CRISP_HELPDESK","DOCUMENT","VUE_I18N_JSON"],"example":"STANDARD_JSON","type":"string"},"ProjectZendeskIntegration":{"description":"Stored Zendesk configuration. Reading performs no external provider request.","properties":{"authentication_id":{"description":"Stored provider authentication identity. No credentials are returned.","example":"iau_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^iau_[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}$","type":"string"},"connection_status":{"$ref":"#/components/schemas/ContentConnectionStatus","description":"Stored authentication lifecycle, not a live provider connectivity test.","example":"ACTIVE"},"created_at":{"description":"Creation time of the persisted integration settings.","example":"2026-10-07T00:00:00.123Z","format":"date-time","type":"string"},"default_branch_id":{"description":"Current default branch used by the existing project-level provider workflows.","example":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"},"id":{"description":"Public project identity addressing this singleton configuration.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^pr_[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}$","type":"string"},"last_pull_at":{"description":"When a pull last succeeded; null before the first one.","example":"2026-10-07T00:00:00.123Z","format":"date-time","type":["string","null"]},"last_push_at":{"description":"When a push last succeeded; null before the first one.","example":"2026-10-07T00:00:00.123Z","format":"date-time","type":["string","null"]},"object_type":{"description":"Always `PROJECT_ZENDESK_INTEGRATION`.","enum":["PROJECT_ZENDESK_INTEGRATION"],"example":"PROJECT_ZENDESK_INTEGRATION","type":"string"},"path_filters":{"description":"Stored selection rules. Configuration values are not a separate paginated resource inventory.","example":[{"type":"INCLUDE","value":"**"}],"items":{"$ref":"#/components/schemas/ContentPathFilter"},"type":"array"},"updated_at":{"description":"Update time of the persisted integration settings. Related provider data and selection can change the ETag independently.","example":"2026-10-07T00:00:00.123Z","format":"date-time","type":"string"}},"required":["authentication_id","connection_status","created_at","default_branch_id","id","last_pull_at","last_push_at","object_type","path_filters","updated_at"],"type":"object"},"PropertiesFileFormatConfiguration":{"description":"How properties files name plural forms.","properties":{"plural_separator":{"description":"The text between a key and its plural form, such as `_` in `apples_one`. Null on older projects that never stored one.","example":"_","type":["string","null"]}},"required":["plural_separator"],"type":"object"},"PullFromGit":{"additionalProperties":false,"description":"Request body to schedule a pull from the connected git repository.","properties":{"git_branch":{"description":"The repository branch to pull from. If left empty, LingoHub pulls from the connected branch.","example":"feature/checkout","type":["string","null"]}},"type":"object"},"PushToGit":{"additionalProperties":false,"description":"Request body to schedule a push to the connected git repository.","properties":{"commit_description":{"description":"The commit description to use. If left empty the default commit description is used.","example":"Latest translations from LingoHub","type":["string","null"]},"commit_message":{"description":"The commit message to use. If left empty the default commit message is used.","example":"Update translations","type":["string","null"]},"git_branch":{"description":"The repository branch to push to. If left empty, LingoHub pushes to the connected branch.","example":"feature/checkout","type":["string","null"]},"pull_request_branch":{"description":"Name of the branch which is used to create the pull request. Required for push type PULL_REQUEST when the git integration has no default pull request branch.","example":"lingohub/translations","type":["string","null"]},"pull_request_description":{"description":"The description of the pull request.","example":"Latest translations from LingoHub","type":["string","null"]},"pull_request_title":{"description":"The title of the pull request.","example":"Update translations","type":["string","null"]},"push_type":{"description":"The type of push you want to perform. It can be a push or a pull request. If left empty the default push type of the git integration is used.","example":"PULL_REQUEST","oneOf":[{"$ref":"#/components/schemas/PushType"},{"type":"null"}]}},"type":"object"},"PushType":{"description":"How files should be pushed to git repositories.","enum":["PUSH","PULL_REQUEST"],"type":"string"},"QualityCheckSeverity":{"description":"Severity of a deterministic quality-check finding.","enum":["INFO","WARNING","ERROR"],"type":"string"},"RequiredPermission":{"description":"The permission the API key lacks, in the vocabulary of the API key permission settings.","properties":{"level":{"$ref":"#/components/schemas/PermissionLevel","description":"The access level required.","example":"MANAGE"},"scope":{"$ref":"#/components/schemas/PermissionScope","description":"Where the permission applies.","example":"STACK"},"target":{"$ref":"#/components/schemas/PermissionTarget","description":"The area the permission governs.","example":"SETTINGS"}},"required":["level","scope","target"],"type":"object"},"Resource":{"description":"A resource file or folder (container) within a project branch, exposing its format and path metadata and per-language status counts.","properties":{"branch_id":{"description":"Unique identifier of the project branch this resource belongs to.","example":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"},"content_version":{"description":"Version of this resource's exported content. A file's number moves whenever any of its languages moves and when a language is\nadded to or removed from it; a folder's number combines the numbers of the files below it and moves whenever any of them does. It increases whenever anything changes that could alter an export of the file (its segments, their texts and\nstatuses, keys, order, the file itself, the languages, the export settings, the branch). Compare it with the content_version of\nyour last export entry for the same file, language and export settings, and export again only when it moved. It tracks the\ntranslatable data: a LingoHub release can still change how a format is rendered, and ARB embeds a generation timestamp -\nre-export after a release when byte identity matters. Null for a file\nwithout languages.","example":42,"format":"int64","type":["integer","null"]},"created_at":{"description":"When the resource file or folder was created.","example":"2026-01-01T10:40:00.123Z","format":"date-time","type":"string"},"format":{"description":"File format of the resource. Null for folders.","example":"ANDROID_XML","oneOf":[{"$ref":"#/components/schemas/ResourceFormat"},{"type":"null"}]},"id":{"description":"Unique identifier of the resource.","example":"rc_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^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}$","type":"string"},"language_code_separator":{"description":"Separator between the file name and the language code (defaults to \"_\").","example":"-","maxLength":256,"minLength":0,"type":"string"},"language_status_counts":{"description":"Per-language segment metrics, grouped by workflow stage and status.","example":[{"content_version":42,"language_code":"de-DE","stages":[{"counts":{"character_count":1890,"segment_count":42,"source_word_count":305,"suggestion_count":7,"word_count":318},"stage":"NEEDS_REVIEW","statuses":[{"counts":{"character_count":1890,"segment_count":42,"source_word_count":305,"suggestion_count":7,"word_count":318},"status":"TRANSLATED"}]}]}],"items":{"$ref":"#/components/schemas/ResourceLanguageStatusCount"},"type":"array"},"name":{"description":"Name of the resource (the last path segment).","example":"strings.xml","type":"string"},"object_type":{"description":"Always `RESOURCE`.","enum":["RESOURCE"],"example":"RESOURCE","type":"string"},"path":{"description":"Full path within the branch. File paths contain language placeholders that are resolved for each exported language.","example":"app/src/main/res/%{locale}/strings.xml","type":"string"},"type":{"$ref":"#/components/schemas/ResourceType","description":"FILE holds keys; FOLDER groups other resources.","example":"FILE"},"updated_at":{"description":"Stored resource metadata update time. Text and other export-input changes are tracked by content_version, not this timestamp.","example":"2026-01-02T10:40:00.123Z","format":"date-time","type":"string"}},"required":["branch_id","content_version","created_at","format","id","language_code_separator","language_status_counts","name","object_type","path","type","updated_at"],"type":"object"},"ResourceCollection":{"description":"A list of resources with pagination capability.","properties":{"data":{"description":"The list of items in this page.","example":[{"branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","content_version":42,"created_at":"2026-01-01T10:40:00.123Z","format":"ANDROID_XML","id":"rc_0197c8f2-5a6b-7cde-8f12-3456789abcde","language_code_separator":"-","language_status_counts":[{"content_version":42,"language_code":"de-DE","stages":[{"counts":{"character_count":1890,"segment_count":42,"source_word_count":305,"suggestion_count":7,"word_count":318},"stage":"NEEDS_REVIEW","statuses":[{"counts":{"character_count":1890,"segment_count":42,"source_word_count":305,"suggestion_count":7,"word_count":318},"status":"TRANSLATED"}]}]}],"name":"strings.xml","object_type":"RESOURCE","path":"app/src/main/res/%{locale}/strings.xml","type":"FILE","updated_at":"2026-01-02T10:40:00.123Z"}],"items":{"$ref":"#/components/schemas/Resource"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"ResourceCounts":{"description":"Aggregated segment metrics, scoped to a single text status or stage.","properties":{"character_count":{"description":"Number of characters in the target text.","example":1890,"format":"int64","type":"integer"},"segment_count":{"description":"Number of segments.","example":42,"format":"int64","type":"integer"},"source_word_count":{"description":"Number of words in the source text.","example":305,"format":"int64","type":"integer"},"suggestion_count":{"description":"Number of translation-memory suggestions.","example":7,"format":"int64","type":"integer"},"word_count":{"description":"Number of words in the target text.","example":318,"format":"int64","type":"integer"}},"required":["character_count","segment_count","source_word_count","suggestion_count","word_count"],"type":"object"},"ResourceFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+resource[name]","-resource[name]","+resource[path]","-resource[path]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/ResourceFilterGroup"}},"type":"object"},"ResourceFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/ResourceFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/ResourceFilterClause"},"minItems":1,"type":"array"},"resource[format]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["ANDROID_XML","IOS_STRINGS","IOS_STRINGSDICT","IOS_STRINGS_CATALOG","STANDARD_PROPERTIES","GETTEXT_PO","WINDOWS_RESX","QT_LINGUIST_TS","DEFINE_PHP","STANDARD_INI","STANDARD_ARB","RAILS_YAML","SYMFONY_YAML","STANDARD_JSON","STORYBLOK_JSON","ANGULAR_TRANSLATE_JSON","CHROME_I18N_JSON","GO_I18N_JSON","I18NEXT_JSON","REACT_INTL_JSON","STANDARD_CSV","SINGLE_LANGUAGE_CSV","KEY_VALUE_CSV","STANDARD_XLIFF","STANDARD_XLIFF_2","STANDARD_TXT","TWINE_TXT","STANDARD_MARKDOWN","STANDARD_HTML","FIGMA","ZENDESK","STORYBLOK","CONTENTFUL","SUBTITLE_SRT","SUBTITLE_VTT","HUBSPOT","STRIPO","CRISP_HELPDESK","DOCX","PPTX","ODT","ODP","VUE_I18N_JSON"],"type":"string"},"_in":{"items":{"enum":["ANDROID_XML","IOS_STRINGS","IOS_STRINGSDICT","IOS_STRINGS_CATALOG","STANDARD_PROPERTIES","GETTEXT_PO","WINDOWS_RESX","QT_LINGUIST_TS","DEFINE_PHP","STANDARD_INI","STANDARD_ARB","RAILS_YAML","SYMFONY_YAML","STANDARD_JSON","STORYBLOK_JSON","ANGULAR_TRANSLATE_JSON","CHROME_I18N_JSON","GO_I18N_JSON","I18NEXT_JSON","REACT_INTL_JSON","STANDARD_CSV","SINGLE_LANGUAGE_CSV","KEY_VALUE_CSV","STANDARD_XLIFF","STANDARD_XLIFF_2","STANDARD_TXT","TWINE_TXT","STANDARD_MARKDOWN","STANDARD_HTML","FIGMA","ZENDESK","STORYBLOK","CONTENTFUL","SUBTITLE_SRT","SUBTITLE_VTT","HUBSPOT","STRIPO","CRISP_HELPDESK","DOCX","PPTX","ODT","ODP","VUE_I18N_JSON"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["ANDROID_XML","IOS_STRINGS","IOS_STRINGSDICT","IOS_STRINGS_CATALOG","STANDARD_PROPERTIES","GETTEXT_PO","WINDOWS_RESX","QT_LINGUIST_TS","DEFINE_PHP","STANDARD_INI","STANDARD_ARB","RAILS_YAML","SYMFONY_YAML","STANDARD_JSON","STORYBLOK_JSON","ANGULAR_TRANSLATE_JSON","CHROME_I18N_JSON","GO_I18N_JSON","I18NEXT_JSON","REACT_INTL_JSON","STANDARD_CSV","SINGLE_LANGUAGE_CSV","KEY_VALUE_CSV","STANDARD_XLIFF","STANDARD_XLIFF_2","STANDARD_TXT","TWINE_TXT","STANDARD_MARKDOWN","STANDARD_HTML","FIGMA","ZENDESK","STORYBLOK","CONTENTFUL","SUBTITLE_SRT","SUBTITLE_VTT","HUBSPOT","STRIPO","CRISP_HELPDESK","DOCX","PPTX","ODT","ODP","VUE_I18N_JSON"],"type":"string"},"_nin":{"items":{"enum":["ANDROID_XML","IOS_STRINGS","IOS_STRINGSDICT","IOS_STRINGS_CATALOG","STANDARD_PROPERTIES","GETTEXT_PO","WINDOWS_RESX","QT_LINGUIST_TS","DEFINE_PHP","STANDARD_INI","STANDARD_ARB","RAILS_YAML","SYMFONY_YAML","STANDARD_JSON","STORYBLOK_JSON","ANGULAR_TRANSLATE_JSON","CHROME_I18N_JSON","GO_I18N_JSON","I18NEXT_JSON","REACT_INTL_JSON","STANDARD_CSV","SINGLE_LANGUAGE_CSV","KEY_VALUE_CSV","STANDARD_XLIFF","STANDARD_XLIFF_2","STANDARD_TXT","TWINE_TXT","STANDARD_MARKDOWN","STANDARD_HTML","FIGMA","ZENDESK","STORYBLOK","CONTENTFUL","SUBTITLE_SRT","SUBTITLE_VTT","HUBSPOT","STRIPO","CRISP_HELPDESK","DOCX","PPTX","ODT","ODP","VUE_I18N_JSON"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"resource[id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^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}$","type":"string"},"_in":{"items":{"pattern":"^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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^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}$","type":"string"},"_nin":{"items":{"pattern":"^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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"resource[name]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"resource[path]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"resource[type]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["FILE","FOLDER"],"type":"string"},"_in":{"items":{"enum":["FILE","FOLDER"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["FILE","FOLDER"],"type":"string"},"_nin":{"items":{"enum":["FILE","FOLDER"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"}},"type":"object"},"ResourceFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/ResourceFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/ResourceFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"ResourceFormat":{"description":"The file format of a resource. Determines how the file is parsed on import and rendered on export. Folders have no format.","enum":["ANDROID_XML","IOS_STRINGS","IOS_STRINGSDICT","IOS_STRINGS_CATALOG","STANDARD_PROPERTIES","GETTEXT_PO","WINDOWS_RESX","QT_LINGUIST_TS","DEFINE_PHP","STANDARD_INI","STANDARD_ARB","RAILS_YAML","SYMFONY_YAML","STANDARD_JSON","STORYBLOK_JSON","ANGULAR_TRANSLATE_JSON","CHROME_I18N_JSON","GO_I18N_JSON","I18NEXT_JSON","REACT_INTL_JSON","STANDARD_CSV","SINGLE_LANGUAGE_CSV","KEY_VALUE_CSV","STANDARD_XLIFF","STANDARD_XLIFF_2","STANDARD_TXT","TWINE_TXT","STANDARD_MARKDOWN","STANDARD_HTML","FIGMA","ZENDESK","STORYBLOK","CONTENTFUL","SUBTITLE_SRT","SUBTITLE_VTT","HUBSPOT","STRIPO","CRISP_HELPDESK","DOCX","PPTX","ODT","ODP","VUE_I18N_JSON"],"type":"string"},"ResourceKeyFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+key[created_at]","-key[created_at]","+key[position]","-key[position]","+key[updated_at]","-key[updated_at]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/ResourceKeyFilterGroup"}},"type":"object"},"ResourceKeyFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/ResourceKeyFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/ResourceKeyFilterClause"},"minItems":1,"type":"array"},"key[created_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"key[id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^ress_[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}$","type":"string"},"_in":{"items":{"pattern":"^ress_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^ress_[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}$","type":"string"},"_nin":{"items":{"pattern":"^ress_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"key[key]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"key[position]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"_gt":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"_gte":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"_in":{"items":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"minItems":1,"type":"array"},"_lt":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"_lte":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"_ne":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"_nin":{"items":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"minItems":1,"type":"array"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"key[segment_id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^seg_[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}$","type":"string"},"_in":{"items":{"pattern":"^seg_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^seg_[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}$","type":"string"},"_nin":{"items":{"pattern":"^seg_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"key[updated_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"}},"type":"object"},"ResourceKeyFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/ResourceKeyFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/ResourceKeyFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"ResourceLanguageStatusCount":{"description":"Per-language segment metrics for a resource, grouped by workflow `stage` and broken down by text status within each stage.","properties":{"content_version":{"description":"Version of this language of the file. It increases whenever anything changes that could alter the export of this language (its texts and statuses, the source texts, the file's segments and keys, the languages, the export settings).","example":42,"format":"int64","type":["integer","null"]},"language_code":{"description":"The language code these metrics belong to.","example":"de-DE","type":"string"},"stages":{"description":"Per-stage metrics, ordered by workflow stage (NOT_READY → NEEDS_EDIT → NEEDS_REVIEW → DONE).","example":[{"counts":{"character_count":1890,"segment_count":42,"source_word_count":305,"suggestion_count":7,"word_count":318},"stage":"NEEDS_REVIEW","statuses":[{"counts":{"character_count":1890,"segment_count":42,"source_word_count":305,"suggestion_count":7,"word_count":318},"status":"TRANSLATED"}]}],"items":{"$ref":"#/components/schemas/ResourceStageStatusCount"},"type":"array"}},"required":["content_version","language_code","stages"],"type":"object"},"ResourceStageStatusCount":{"description":"Segment metrics for a single workflow stage within a language: the `counts` are the stage total across its statuses, and `statuses` lists the per-status breakdown.","properties":{"counts":{"$ref":"#/components/schemas/ResourceCounts","description":"Stage total, summed across all statuses in this stage."},"stage":{"$ref":"#/components/schemas/TextStage","description":"The workflow stage these metrics belong to.","example":"NEEDS_REVIEW"},"statuses":{"description":"Per-status metric breakdown within this stage, ordered by status.","example":[{"counts":{"character_count":1890,"segment_count":42,"source_word_count":305,"suggestion_count":7,"word_count":318},"status":"TRANSLATED"}],"items":{"$ref":"#/components/schemas/ResourceStatusCount"},"type":"array"}},"required":["counts","stage","statuses"],"type":"object"},"ResourceStatusCount":{"description":"Segment metrics for a single text status within a language.","properties":{"counts":{"$ref":"#/components/schemas/ResourceCounts","description":"Aggregated metrics for this status."},"status":{"$ref":"#/components/schemas/TextStatus","description":"The text status these metrics belong to.","example":"TRANSLATED"}},"required":["counts","status"],"type":"object"},"ResourceType":{"description":"What a resource is:\n  - FILE: holds keys (a file, or a page, article or entry of a connected tool)\n  - FOLDER: groups other resources and holds no keys\n","enum":["FILE","FOLDER"],"type":"string"},"Segment":{"description":"A source text and its translations, with the notes and labels they share. Every key of the segment shows these texts; its keys are listed by listSegmentKeys.","properties":{"created_at":{"description":"Timestamp when the segment was created.","example":"2026-09-29T00:00:00.123Z","format":"date-time","type":"string"},"description":{"description":"Note for translators. A LINA with an AI engine reads it too when its `context.is_segments_enabled` is on; LingoHub-managed LINAs always do.","example":"Label on the sign-in button","type":["string","null"]},"id":{"description":"Public identifier of the segment.","example":"seg_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^seg_[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}$","type":"string"},"is_not_translatable":{"description":"Whether the segment is excluded from translation.","example":false,"type":"boolean"},"is_plural":{"description":"Whether the segment has plural forms.","example":false,"type":"boolean"},"label_ids":{"description":"Public identifiers of the segment's labels.","example":["la_0197c8f2-5a6b-7cde-8f12-3456789abcde"],"items":{"example":"la_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^la_[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}$","type":"string"},"type":"array"},"not_translatable_reason":{"description":"Why the segment is not translatable: `RESOURCE_FILE` when the imported file marks it (Android XML, Rails YAML, iOS String Catalog, XLIFF 2), `EDITOR` when someone marked it in LingoHub. Null when it is translatable.","oneOf":[{"$ref":"#/components/schemas/NotTranslatableReason"},{"type":"null"}]},"object_type":{"description":"Always `SEGMENT`.","enum":["SEGMENT"],"example":"SEGMENT","type":"string"},"stack_id":{"description":"Public identifier of the stack the segment belongs to.","example":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stack_[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}$","type":"string"},"texts":{"additionalProperties":{"$ref":"#/components/schemas/SegmentText"},"description":"The segment's texts by language code, the source first. A read can limit them to the languages named by `language_codes`.","example":{"de":{"content_updated_at":"2026-09-29T00:00:00.000Z","is_source":false,"stage":"NEEDS_REVIEW","status":"TRANSLATED","updated_at":"2026-09-29T00:00:00.000Z","variants":[{"content":"Anmelden","device":"OTHER","plural_form":"OTHER"}]},"en":{"content_updated_at":"2026-09-29T00:00:00.000Z","is_source":true,"stage":"DONE","status":"APPROVED","updated_at":"2026-09-29T00:00:00.000Z","variants":[{"content":"Sign in","device":"OTHER","plural_form":"OTHER"}]}},"type":"object"},"updated_at":{"description":"Timestamp when the segment's description, flags or labels last changed. Each text has its own timestamps.","example":"2026-09-29T00:00:00.123Z","format":"date-time","type":"string"}},"required":["created_at","description","id","is_not_translatable","is_plural","label_ids","not_translatable_reason","object_type","stack_id","texts","updated_at"],"type":"object"},"SegmentCollection":{"description":"A cursor-paginated list of Segment objects.","properties":{"data":{"description":"The list of items in this page.","example":[{"created_at":"2026-09-29T00:00:00.123Z","description":"Label on the sign-in button","id":"seg_0197c8f2-5a6b-7cde-8f12-3456789abcde","is_not_translatable":false,"is_plural":false,"label_ids":["la_0197c8f2-5a6b-7cde-8f12-3456789abcde"],"not_translatable_reason":"RESOURCE_FILE","object_type":"SEGMENT","stack_id":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","texts":{"de":{"content_updated_at":"2026-09-29T00:00:00.000Z","is_source":false,"stage":"NEEDS_REVIEW","status":"TRANSLATED","updated_at":"2026-09-29T00:00:00.000Z","variants":[{"content":"Anmelden","device":"OTHER","plural_form":"OTHER"}]},"en":{"content_updated_at":"2026-09-29T00:00:00.000Z","is_source":true,"stage":"DONE","status":"APPROVED","updated_at":"2026-09-29T00:00:00.000Z","variants":[{"content":"Sign in","device":"OTHER","plural_form":"OTHER"}]}},"updated_at":"2026-09-29T00:00:00.123Z"}],"items":{"$ref":"#/components/schemas/Segment"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"SegmentFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+segment[created_at]","-segment[created_at]","+segment[updated_at]","-segment[updated_at]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/SegmentFilterGroup"}},"type":"object"},"SegmentFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/SegmentFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/SegmentFilterClause"},"minItems":1,"type":"array"},"key[key]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"key[resource_id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^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}$","type":"string"},"_in":{"items":{"pattern":"^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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^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}$","type":"string"},"_nin":{"items":{"pattern":"^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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"segment[created_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"segment[description]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"segment[id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^seg_[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}$","type":"string"},"_in":{"items":{"pattern":"^seg_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^seg_[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}$","type":"string"},"_nin":{"items":{"pattern":"^seg_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"segment[is_plural]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_false":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_true":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"}},"type":"object"},"segment[label_ids]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^la_[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}$","type":"string"},"_in":{"items":{"pattern":"^la_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^la_[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}$","type":"string"},"_nin":{"items":{"pattern":"^la_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"segment[updated_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"text[content]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"text[content_updated_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"text[stage]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["NOT_READY","NEEDS_EDIT","NEEDS_REVIEW","DONE"],"type":"string"},"_in":{"items":{"enum":["NOT_READY","NEEDS_EDIT","NEEDS_REVIEW","DONE"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["NOT_READY","NEEDS_EDIT","NEEDS_REVIEW","DONE"],"type":"string"},"_nin":{"items":{"enum":["NOT_READY","NEEDS_EDIT","NEEDS_REVIEW","DONE"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"text[status]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["BLOCKED","NEW","STALE","REJECTED","DRAFT","AI_TRANSLATED","TRANSLATED","QA_PASSED","QA_FLAGGED","APPROVED","NOT_TRANSLATABLE"],"type":"string"},"_in":{"items":{"enum":["BLOCKED","NEW","STALE","REJECTED","DRAFT","AI_TRANSLATED","TRANSLATED","QA_PASSED","QA_FLAGGED","APPROVED","NOT_TRANSLATABLE"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["BLOCKED","NEW","STALE","REJECTED","DRAFT","AI_TRANSLATED","TRANSLATED","QA_PASSED","QA_FLAGGED","APPROVED","NOT_TRANSLATABLE"],"type":"string"},"_nin":{"items":{"enum":["BLOCKED","NEW","STALE","REJECTED","DRAFT","AI_TRANSLATED","TRANSLATED","QA_PASSED","QA_FLAGGED","APPROVED","NOT_TRANSLATABLE"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"text[updated_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"}},"type":"object"},"SegmentFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/SegmentFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/SegmentFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"SegmentKeyFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+key[created_at]","-key[created_at]","+key[updated_at]","-key[updated_at]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/SegmentKeyFilterGroup"}},"type":"object"},"SegmentKeyFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/SegmentKeyFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/SegmentKeyFilterClause"},"minItems":1,"type":"array"},"key[branch_id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^prb_[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}$","type":"string"},"_in":{"items":{"pattern":"^prb_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^prb_[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}$","type":"string"},"_nin":{"items":{"pattern":"^prb_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"key[created_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"key[id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^ress_[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}$","type":"string"},"_in":{"items":{"pattern":"^ress_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^ress_[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}$","type":"string"},"_nin":{"items":{"pattern":"^ress_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"key[key]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"key[resource_id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^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}$","type":"string"},"_in":{"items":{"pattern":"^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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^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}$","type":"string"},"_nin":{"items":{"pattern":"^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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"key[updated_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"}},"type":"object"},"SegmentKeyFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/SegmentKeyFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/SegmentKeyFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"SegmentList":{"description":"The segments after the change, one per item of the request and in its order, with their texts in the branch's languages.","properties":{"data":{"description":"The segments.","example":[{"created_at":"2026-09-29T00:00:00.123Z","description":"Label on the sign-in button","id":"seg_0197c8f2-5a6b-7cde-8f12-3456789abcde","is_not_translatable":false,"is_plural":false,"label_ids":["la_0197c8f2-5a6b-7cde-8f12-3456789abcde"],"not_translatable_reason":"RESOURCE_FILE","object_type":"SEGMENT","stack_id":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","texts":{"de":{"content_updated_at":"2026-09-29T00:00:00.000Z","is_source":false,"stage":"NEEDS_REVIEW","status":"TRANSLATED","updated_at":"2026-09-29T00:00:00.000Z","variants":[{"content":"Anmelden","device":"OTHER","plural_form":"OTHER"}]},"en":{"content_updated_at":"2026-09-29T00:00:00.000Z","is_source":true,"stage":"DONE","status":"APPROVED","updated_at":"2026-09-29T00:00:00.000Z","variants":[{"content":"Sign in","device":"OTHER","plural_form":"OTHER"}]}},"updated_at":"2026-09-29T00:00:00.123Z"}],"items":{"$ref":"#/components/schemas/Segment"},"type":"array"},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","object_type"],"type":"object"},"SegmentText":{"description":"The text of a segment in one language, the source included: its variants and its workflow status.","example":{"content_updated_at":"2026-09-29T00:00:00.000Z","is_source":true,"stage":"DONE","status":"APPROVED","updated_at":"2026-09-29T00:00:00.000Z","variants":[{"content":"Sign in","device":"OTHER","plural_form":"OTHER"}]},"properties":{"content_updated_at":{"description":"When the variants last changed. Null before the text ever had content.","example":"2026-09-29T00:00:00.123Z","format":"date-time","type":["string","null"]},"is_source":{"description":"Whether this is the stack's source language.","example":true,"type":"boolean"},"stage":{"$ref":"#/components/schemas/TextStage","description":"Workflow stage of the status.","example":"DONE"},"status":{"$ref":"#/components/schemas/TextStatus","description":"Workflow status of the text.","example":"APPROVED"},"updated_at":{"description":"When the text, its status or its counts last changed.","example":"2026-09-29T00:00:00.123Z","format":"date-time","type":"string"},"variants":{"description":"The variants of the text in their order: one per device and plural form. Empty when the text is empty.","example":[{"content":"Sign in","device":"OTHER","plural_form":"OTHER"}],"items":{"$ref":"#/components/schemas/TextVariant"},"type":"array"}},"required":["content_updated_at","is_source","stage","status","updated_at","variants"],"type":"object"},"SetAutomationAction":{"description":"Request body to set what the rule does and to which texts. `type` selects the shape and must follow from the rule's `type`: `TEXT` rules take `REPLACE_TEXT`, `STATUS` rules `SET_STATUS` and `LABEL` rules `ADD_LABEL`.","discriminator":{"mapping":{"ADD_LABEL":"#/components/schemas/SetAutomationAddLabelAction","REPLACE_TEXT":"#/components/schemas/SetAutomationReplaceTextAction","SET_STATUS":"#/components/schemas/SetAutomationSetStatusAction"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/SetAutomationReplaceTextAction"},{"$ref":"#/components/schemas/SetAutomationSetStatusAction"},{"$ref":"#/components/schemas/SetAutomationAddLabelAction"}],"type":"object"},"SetAutomationAddLabelAction":{"additionalProperties":false,"description":"Request body to add a label to the segment.","properties":{"label_id":{"description":"A label of this workspace.","example":"la_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^la_[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}$","type":"string"},"target":{"$ref":"#/components/schemas/SetAutomationTarget","description":"The texts the action changes; a label rule changes the triggering text."},"type":{"description":"Selects this shape of the body.","enum":["ADD_LABEL"],"example":"ADD_LABEL","type":"string"}},"required":["label_id","target","type"],"type":"object"},"SetAutomationCondition":{"additionalProperties":false,"description":"Request body to replace the corresponding automation rule configuration.","properties":{"mode":{"$ref":"#/components/schemas/AutomationMatchMode","description":"Plain-text matching mode, never a regular expression.","example":"CONTAINS"},"subject":{"$ref":"#/components/schemas/AutomationConditionSubject","description":"Subject inspected by the condition.","example":"TEXT"},"value":{"description":"Condition text; absent or null when the mode needs no text.","example":"draft","maxLength":1024,"minLength":0,"type":["string","null"]}},"required":["mode","subject"],"type":"object"},"SetAutomationReplaceTextAction":{"additionalProperties":false,"description":"Request body to replace every occurrence of `search` in the text with `replace`.","properties":{"is_placeholder_excluded":{"description":"Whether placeholders in the text are left unchanged.","example":true,"type":"boolean"},"replace":{"description":"The replacement; an empty string deletes the found text.","example":"color","maxLength":1024,"minLength":0,"type":"string"},"search":{"description":"The plain text to search for, case-sensitively.","example":"colour","maxLength":1024,"minLength":0,"type":"string"},"target":{"$ref":"#/components/schemas/SetAutomationTarget","description":"The texts the action changes; a text rule changes the triggering text."},"type":{"description":"Selects this shape of the body.","enum":["REPLACE_TEXT"],"example":"REPLACE_TEXT","type":"string"}},"required":["is_placeholder_excluded","replace","search","target","type"],"type":"object"},"SetAutomationScope":{"additionalProperties":false,"description":"Request body to replace the corresponding automation rule configuration.","properties":{"language_codes":{"description":"Empty selects every language; only meaningful for text-level triggers.","example":[],"items":{"description":"Language code that uniquely identifies a locale. Valid examples would be 'en', 'en-GB', 'de', 'de-DE' etc. according to [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).","type":"string"},"maxItems":1000,"minItems":0,"type":"array"},"origin":{"$ref":"#/components/schemas/AutomationOrigin","description":"Incoming change origin.","example":"ANY"},"role":{"$ref":"#/components/schemas/AutomationRole","description":"Source or target text role.","example":"ANY"}},"required":["language_codes","origin","role"],"type":"object"},"SetAutomationSetStatusAction":{"additionalProperties":false,"description":"Request body to set the status of the texts.","properties":{"status":{"$ref":"#/components/schemas/TextStatus","description":"The status to set. A rule that changes a source text can only set a status for source texts.","example":"APPROVED"},"target":{"$ref":"#/components/schemas/SetAutomationTarget","description":"The texts the action changes."},"type":{"description":"Selects this shape of the body.","enum":["SET_STATUS"],"example":"SET_STATUS","type":"string"}},"required":["status","target","type"],"type":"object"},"SetAutomationTarget":{"additionalProperties":false,"description":"Request body to replace the corresponding automation rule configuration.","properties":{"conditions":{"description":"Conditions applied independently to each acted-on text.","example":[{"mode":"CONTAINS","subject":"TEXT","value":"draft"}],"items":{"$ref":"#/components/schemas/SetAutomationCondition"},"maxItems":10,"minItems":0,"type":"array"},"language_codes":{"description":"Empty selects every target language; meaningful for SEGMENT_TARGET_TEXTS only.","example":[],"items":{"description":"Language code that uniquely identifies a locale. Valid examples would be 'en', 'en-GB', 'de', 'de-DE' etc. according to [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).","type":"string"},"maxItems":1000,"minItems":0,"type":"array"},"selector":{"$ref":"#/components/schemas/AutomationTargetSelector","description":"Act on the triggering text or matching target texts.","example":"TRIGGERING_TEXT"}},"required":["conditions","language_codes","selector"],"type":"object"},"SetBackupSchedule":{"additionalProperties":false,"description":"Automatic backup schedule in UTC.","properties":{"day_of_week":{"description":"Required for WEEKLY; null for DAILY.","example":"MONDAY","oneOf":[{"$ref":"#/components/schemas/BackupScheduleWeekday"},{"type":"null"}]},"period":{"$ref":"#/components/schemas/BackupSchedulePeriod","description":"Daily or weekly repetition.","example":"WEEKLY"},"time":{"description":"Execution time in UTC, HH:mm.","example":"10:30","pattern":"(?:[01][0-9]|2[0-3]):[0-5][0-9]","type":"string"}},"required":["period","time"],"type":"object"},"SetBackupSettings":{"additionalProperties":false,"description":"Enable or replace the complete schedule and branch selection. Use DELETE to disable.","properties":{"branch_ids":{"description":"Nonempty selection of branches in this project; duplicates are normalized.","example":["prb_0197c8f2-5a6b-7cde-8f12-3456789abcde"],"items":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project branch, a valid value would be : prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"},"maxItems":1000,"minItems":1,"type":"array"},"schedule":{"$ref":"#/components/schemas/SetBackupSchedule","description":"Complete UTC execution schedule."}},"required":["branch_ids","schedule"],"type":"object"},"SetCodeCommitCredentials":{"additionalProperties":false,"description":"Request body to replace the credentials of a manual AWS CodeCommit authentication. Stored without a remote check.","properties":{"access_token":{"description":"Write-only provider credential. Saved without a remote validity check. Format: accessKey:secretKey or accessKey:secretKey:sessionToken.","example":"provider-credential","maxLength":8192,"minLength":1,"type":"string"},"provider":{"description":"Selects this shape of the body.","enum":["AWS_CODE_COMMIT"],"example":"AWS_CODE_COMMIT","type":"string"},"region":{"description":"Existing CodeCommit region setting.","example":"us-east-1","maxLength":255,"minLength":1,"type":"string"}},"required":["access_token","provider","region"],"type":"object"},"SetContentFilter":{"additionalProperties":false,"description":"Request body to select provider paths with existing include/exclude patterns.","properties":{"type":{"$ref":"#/components/schemas/ContentFilterType","description":"Whether matching provider values are included or excluded.","example":"INCLUDE"},"value":{"description":"Provider selection pattern. Leading slashes are removed; the remaining pattern must not be blank.","example":"**","maxLength":4096,"minLength":0,"pattern":"^(?!/*\\s*$)[^\\x00]*$","type":"string"}},"required":["type","value"],"type":"object"},"SetCrispHelpdeskCredentials":{"additionalProperties":false,"description":"Request body to replace the credentials of a manual Crisp Helpdesk authentication. Name and identity are preserved; the credentials are validated and never returned.","properties":{"identifier":{"description":"Crisp plugin identifier.","example":"plugin-identifier","maxLength":255,"minLength":1,"type":"string"},"key":{"description":"Crisp plugin key. Never returned.","example":"provider-key","maxLength":8192,"minLength":1,"type":"string"},"provider":{"description":"Selects this shape of the body.","enum":["CRISP_HELPDESK"],"example":"CRISP_HELPDESK","type":"string"},"website_key":{"description":"External Crisp website key, not a LingoHub identity.","example":"website-key","maxLength":255,"minLength":1,"type":"string"}},"required":["identifier","key","provider","website_key"],"type":"object"},"SetGitFilter":{"additionalProperties":false,"description":"Request body to select repository paths or branches with the existing include/exclude glob rules.","properties":{"type":{"$ref":"#/components/schemas/GitFilterType","description":"Include or exclude matching paths.","example":"INCLUDE"},"value":{"description":"Repository glob pattern; leading slashes are removed.","example":"locales/**","maxLength":4096,"minLength":0,"pattern":"^[^\\x00]*$","type":"string"}},"required":["type","value"],"type":"object"},"SetGitLabCredentials":{"additionalProperties":false,"description":"Request body to replace the credentials of a manual GitLab authentication. Stored without a remote check.","properties":{"access_token":{"description":"Write-only provider credential. Saved without a remote validity check.","example":"provider-credential","maxLength":8192,"minLength":1,"type":"string"},"is_self_hosted":{"description":"Whether to use the existing self-hosted GitLab configuration.","example":false,"type":"boolean"},"provider":{"description":"Selects this shape of the body.","enum":["GITLAB"],"example":"GITLAB","type":"string"},"provider_url":{"description":"Provider base URL, required for self-hosted GitLab. Otherwise ignored, preserving the existing hosted default.","example":"https://gitlab.example.com","maxLength":4096,"minLength":0,"type":["string","null"]}},"required":["access_token","is_self_hosted","provider"],"type":"object"},"SetGitSchedule":{"additionalProperties":false,"description":"Request body to configure a periodic Git schedule in UTC.","properties":{"day_of_week":{"description":"Required for WEEKLY; null for DAILY.","example":"MONDAY","oneOf":[{"$ref":"#/components/schemas/GitScheduleWeekday"},{"type":"null"}]},"period":{"$ref":"#/components/schemas/GitSchedulePeriod","description":"Daily or weekly repetition.","example":"DAILY"},"time":{"description":"Execution time in UTC, HH:mm.","example":"10:30","pattern":"(?:[01][0-9]|2[0-3]):[0-5][0-9]","type":"string"}},"required":["period","time"],"type":"object"},"SetIntegrationAuthenticationCredentials":{"description":"Request body to replace the complete credentials of a manual authentication. `provider` selects the shape of the body and must be the authentication's stored provider.","discriminator":{"mapping":{"AWS_CODE_COMMIT":"#/components/schemas/SetCodeCommitCredentials","AZURE":"#/components/schemas/SetTokenCredentials","BITBUCKET":"#/components/schemas/SetTokenCredentials","CONTENTFUL":"#/components/schemas/SetTokenCredentials","CRISP_HELPDESK":"#/components/schemas/SetCrispHelpdeskCredentials","GITLAB":"#/components/schemas/SetGitLabCredentials","HUBSPOT":"#/components/schemas/SetTokenCredentials","STORYBLOK":"#/components/schemas/SetStoryblokCredentials","STRIPO":"#/components/schemas/SetTokenCredentials","ZENDESK":"#/components/schemas/SetZendeskCredentials"},"propertyName":"provider"},"oneOf":[{"$ref":"#/components/schemas/SetTokenCredentials"},{"$ref":"#/components/schemas/SetGitLabCredentials"},{"$ref":"#/components/schemas/SetCodeCommitCredentials"},{"$ref":"#/components/schemas/SetStoryblokCredentials"},{"$ref":"#/components/schemas/SetZendeskCredentials"},{"$ref":"#/components/schemas/SetCrispHelpdeskCredentials"}],"type":"object"},"SetInvitationStackAssignment":{"additionalProperties":false,"description":"Request body to replace a pending email invitation's complete stored stack assignment.","properties":{"language_permissions":{"additionalProperties":{"$ref":"#/components/schemas/StackMemberLanguagePermission"},"description":"Complete configured language map. Omission or null removes explicit language configuration. On acceptance each entry applies only to selected stacks containing that language. Each supplied language must exist in at least one selected stack.","example":{"de":"READ_ACCESS"},"maxProperties":1000,"type":["object","null"]},"stack_ids":{"description":"Distinct target stacks in this workspace. Requires settings management on each stack.","example":["stack_0197c8f2-5a6b-7cde-8f12-3456789abcde"],"items":{"pattern":"^stack_[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}$","type":"string"},"maxItems":1000,"minItems":1,"type":"array","uniqueItems":true},"stack_role_id":{"description":"Non-owner stack role in this workspace.","example":"stackr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stackr_[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}$","type":"string"}},"required":["stack_ids","stack_role_id"],"type":"object"},"SetLinaLanguageEngine":{"additionalProperties":false,"description":"Request body to choose the engine for one target language.","properties":{"language_code":{"description":"Target language the engine is used for.","example":"de","type":"string"},"linguistic_engine_id":{"description":"Engine to use for this language; it must be enabled in the workspace.","example":"engine_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^engine_[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}$","type":"string"}},"required":["language_code","linguistic_engine_id"],"type":"object"},"SetStackAutomationRule":{"additionalProperties":false,"description":"Request body to replace the corresponding automation rule configuration.","properties":{"action":{"$ref":"#/components/schemas/SetAutomationAction","description":"What the rule does and to which texts. Its `type` must follow from the rule's `type`: `TEXT` → `REPLACE_TEXT`, `STATUS` → `SET_STATUS`, `LABEL` → `ADD_LABEL`."},"conditions":{"description":"All trigger conditions must match.","example":[{"mode":"CONTAINS","subject":"TEXT","value":"draft"}],"items":{"$ref":"#/components/schemas/SetAutomationCondition"},"maxItems":10,"minItems":0,"type":"array"},"is_enabled":{"description":"Whether the rule is enabled. Disabled rules are still validated.","example":true,"type":"boolean"},"rule_key":{"description":"Existing configuration key preserves identity. Null, omitted or unknown keys get a new server-generated key.","example":"0197c8f2-5a6b-7cde-8f12-3456789abcde","format":"uuid","pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}","type":["string","null"]},"scope":{"$ref":"#/components/schemas/SetAutomationScope","description":"Origin, role and language selection."},"trigger":{"$ref":"#/components/schemas/AutomationTrigger","description":"Incoming event that can trigger this rule.","example":"TEXT_UPDATED"},"type":{"$ref":"#/components/schemas/AutomationType","description":"How the rule's group runs. `TEXT`: every matching rule applies, in list order, so the replacements chain. `STATUS`: the first matching rule wins. `LABEL`: every matching rule applies.","example":"STATUS"}},"required":["action","conditions","is_enabled","scope","trigger","type"],"type":"object"},"SetStackAutomationSettings":{"additionalProperties":false,"description":"Request body to replace the automation settings of a stack.","properties":{"rules":{"description":"All rules of the stack, in order. An empty list removes every rule; at most `max_rules` rules.","example":[{"action":{"status":"APPROVED","target":{"conditions":[],"language_codes":[],"selector":"TRIGGERING_TEXT"},"type":"SET_STATUS"},"conditions":[],"is_enabled":true,"rule_key":"0197c8f2-5a6b-7cde-8f12-3456789abcde","scope":{"language_codes":["de","fr"],"origin":"IMPORT","role":"TARGET"},"trigger":"TEXT_CREATED_OR_UPDATED","type":"STATUS"}],"items":{"$ref":"#/components/schemas/SetStackAutomationRule"},"maxItems":1000,"minItems":0,"type":"array"}},"required":["rules"],"type":"object"},"SetStackMember":{"additionalProperties":false,"description":"Request body to create or fully replace an explicit stack assignment's role and configured language map. Both fields are required; use an empty map to clear explicit language permissions.","properties":{"language_permissions":{"additionalProperties":{"$ref":"#/components/schemas/StackMemberLanguagePermission"},"description":"Complete map of configured stack language codes to explicit permissions. The map and each value must be non-null; an empty object removes all explicit language rows. This is not effective access.","example":{"de":"READ_ACCESS"},"type":"object"},"stack_role_id":{"description":"A stack role of this workspace; not the owner role.","example":"stackr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stackr_[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}$","type":"string"}},"required":["language_permissions","stack_role_id"],"type":"object"},"SetStoryblokCredentials":{"additionalProperties":false,"description":"Request body to replace the credentials of a manual Storyblok authentication. Name and identity are preserved; the token is validated and never returned.","properties":{"access_token":{"description":"Provider access token. Validated and stored through the existing encrypted credential path; never returned.","example":"provider-token","maxLength":8192,"minLength":1,"type":"string"},"provider":{"description":"Selects this shape of the body.","enum":["STORYBLOK"],"example":"STORYBLOK","type":"string"},"region":{"$ref":"#/components/schemas/StoryblokRegion","description":"Existing Storyblok hosting region.","example":"EUROPE"}},"required":["access_token","provider","region"],"type":"object"},"SetStyleGuideLanguageRules":{"additionalProperties":false,"description":"Request body to set per-language override rules that refine the global style guide settings for a specific language. Creates the rule set if it does not exist, otherwise replaces it. Omitted fields are cleared.","properties":{"date_format":{"description":"Preferred date format for this language.","example":"EU_FORMAT","oneOf":[{"$ref":"#/components/schemas/StyleGuideDateFormat"},{"type":"null"}]},"decimal_separator":{"description":"Preferred decimal separator for this language.","example":"COMMA","oneOf":[{"$ref":"#/components/schemas/StyleGuideDecimalSeparator"},{"type":"null"}]},"formality":{"description":"Language-specific formality override.","example":"FORMAL","oneOf":[{"$ref":"#/components/schemas/StyleGuideFormality"},{"type":"null"}]},"gender_inclusiveness":{"description":"Gender inclusiveness preference for this language.","example":"GENDER_NEUTRAL","oneOf":[{"$ref":"#/components/schemas/StyleGuideGenderInclusiveness"},{"type":"null"}]},"grouping_separator":{"description":"Preferred grouping separator for numeric values in this language.","example":"DOT","oneOf":[{"$ref":"#/components/schemas/StyleGuideGroupingSeparator"},{"type":"null"}]},"honorific_level_japanese":{"description":"Honorific level for Japanese translations.","example":"POLITE","oneOf":[{"$ref":"#/components/schemas/StyleGuideHonorificLevelJapanese"},{"type":"null"}]},"honorific_level_korean":{"description":"Honorific level for Korean translations.","example":"POLITE","oneOf":[{"$ref":"#/components/schemas/StyleGuideHonorificLevelKorean"},{"type":"null"}]},"language_complexity":{"description":"Language complexity level for this language.","example":"STANDARD","oneOf":[{"$ref":"#/components/schemas/StyleGuideLanguageComplexity"},{"type":"null"}]},"oxford_comma":{"description":"Preferred serial comma usage for this language.","example":"NOT_SPECIFIED","oneOf":[{"$ref":"#/components/schemas/StyleGuideOxfordComma"},{"type":"null"}]},"quotes_format":{"description":"Preferred quotation mark style for this language.","example":"QUOTES_GERMAN","oneOf":[{"$ref":"#/components/schemas/StyleGuideQuotesFormat"},{"type":"null"}]},"time_format":{"description":"Preferred time format for this language.","example":"TIME_24H","oneOf":[{"$ref":"#/components/schemas/StyleGuideTimeFormat"},{"type":"null"}]},"voice":{"description":"Language-specific voice preference.","example":"ACTIVE","oneOf":[{"$ref":"#/components/schemas/StyleGuideVoice"},{"type":"null"}]}},"type":"object"},"SetStyleGuideLanguageVariant":{"additionalProperties":false,"description":"Request body to set the regional variant for a language, e.g. `en-GB` for `en`.","properties":{"variant_language_code":{"description":"Regional variant of the language in the path that texts are written in; a supported locale (GET /v2/locales lists them).","example":"en-GB","type":"string"}},"required":["variant_language_code"],"type":"object"},"SetTokenCredentials":{"additionalProperties":false,"description":"Request body to replace the access token of a manual authentication. Azure DevOps and Bitbucket store it without a remote check; Contentful, HubSpot and Stripo validate it with the provider first.","properties":{"access_token":{"description":"Write-only provider access token; never returned.","example":"provider-token","maxLength":8192,"minLength":1,"type":"string"},"provider":{"description":"Selects this shape of the body.","enum":["AZURE","BITBUCKET","CONTENTFUL","HUBSPOT","STRIPO"],"example":"AZURE","type":"string"}},"required":["access_token","provider"],"type":"object"},"SetZendeskCredentials":{"additionalProperties":false,"description":"Request body to replace the credentials of a manual Zendesk authentication. Name and identity are preserved; the credentials are validated and never returned.","properties":{"access_token":{"description":"Provider access token. Validated and stored through the existing encrypted credential path; never returned.","example":"provider-token","maxLength":8192,"minLength":1,"type":"string"},"provider":{"description":"Selects this shape of the body.","enum":["ZENDESK"],"example":"ZENDESK","type":"string"},"provider_url":{"description":"Canonical HTTPS Zendesk tenant origin. Custom aliases, paths, credentials and ports are not accepted by this V2 credential route.","example":"https://example.zendesk.com","maxLength":2048,"minLength":1,"pattern":"^https://[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.zendesk\\.com/?$","type":"string"},"username":{"description":"Existing Zendesk API username; use the same value as the integration setup.","example":"agent@example.com","maxLength":255,"minLength":1,"type":"string"}},"required":["access_token","provider","provider_url","username"],"type":"object"},"Stack":{"description":"A LingoHub stack.","properties":{"ai_context":{"description":"Context that tells LINA what the stack is about, given with the project's own.","example":"Mobile apps for retail banking.","maxLength":512,"minLength":0,"type":["string","null"]},"character_count":{"description":"The characters this stack counts toward the workspace's character limit of its plan: the characters of its texts in all languages, including segments that are no longer in any file and excluding segments marked not translatable. Changes with the stack's content.","example":72632,"format":"int64","type":"integer"},"color":{"description":"Hex color code of the stack icon.","example":"#FF5733","maxLength":7,"minLength":7,"pattern":"#[0-9a-fA-F]{6}","type":"string"},"counts_updated_at":{"description":"When the counts last changed; the stack's creation time while it has none.","example":"2025-06-20T10:34:38.123Z","format":"date-time","type":"string"},"created_at":{"description":"Timestamp when the stack was created.","example":"2025-01-15T10:30:00.123Z","format":"date-time","type":"string"},"id":{"description":"Unique identifier of the stack.","example":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^stack_[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}$","type":"string"},"lina_id":{"description":"LINA of the stack, or null when the stack has none. The role it plays per language is the stack language's `lina_role`.","example":"lina_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^lina_[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}$","type":["string","null"]},"name":{"description":"Display name of the stack.","example":"My Stack","maxLength":999,"minLength":0,"type":"string"},"object_type":{"description":"Always `STACK`.","enum":["STACK"],"example":"STACK","type":"string"},"type":{"$ref":"#/components/schemas/StackType","description":"Type of the stack.","example":"PRIVATE"},"updated_at":{"description":"Timestamp when the stack was last updated.","example":"2025-06-20T14:45:00.123Z","format":"date-time","type":"string"},"word_count":{"description":"Words of the stack's texts in all languages, counted like character_count.","example":8840,"format":"int64","type":"integer"}},"required":["ai_context","character_count","color","counts_updated_at","created_at","id","lina_id","name","object_type","type","updated_at","word_count"],"type":"object"},"StackAutomationRule":{"description":"One rule in the ordered configuration of a stack; not a separately persisted V2 resource.","properties":{"action":{"$ref":"#/components/schemas/AutomationAction","description":"What the rule does and to which texts. Its `type` follows from the rule's `type` for now: `TEXT` → `REPLACE_TEXT`, `STATUS` → `SET_STATUS`, `LABEL` → `ADD_LABEL`.","example":{"status":"APPROVED","target":{"conditions":[],"language_codes":[],"selector":"TRIGGERING_TEXT"},"type":"SET_STATUS"}},"conditions":{"description":"All trigger conditions must match.","example":[{"mode":"CONTAINS","subject":"TEXT","value":"draft"}],"items":{"$ref":"#/components/schemas/AutomationCondition"},"type":"array"},"is_enabled":{"description":"Whether this configured rule is enabled.","example":true,"type":"boolean"},"rule_key":{"description":"Stored UUID configuration key, stable across saves. Null preserves a historical missing key; reads never mint one.","example":"0197c8f2-5a6b-7cde-8f12-3456789abcde","format":"uuid","type":["string","null"]},"scope":{"$ref":"#/components/schemas/AutomationScope","description":"Origin, text role and language selection.","example":{"language_codes":["de"],"origin":"IMPORT","role":"TARGET"}},"trigger":{"$ref":"#/components/schemas/AutomationTrigger","description":"Incoming event that may trigger the rule.","example":"TEXT_UPDATED"},"type":{"$ref":"#/components/schemas/AutomationType","description":"How the rule's group runs. `TEXT`: every matching rule applies, in list order, so the replacements chain. `STATUS`: the first matching rule wins. `LABEL`: every matching rule applies.","example":"STATUS"}},"required":["action","conditions","is_enabled","rule_key","scope","trigger","type"],"type":"object"},"StackAutomationSettings":{"description":"Current automation configuration of the stack, which applies to every project of it; not a simulation of effective behavior across the keys of shared segments.","properties":{"created_at":{"description":"Creation time of the stack settings row.","example":"2026-09-30T00:00:00.123Z","format":"date-time","type":"string"},"id":{"description":"Stack public identity addressing this singleton.","example":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^stack_[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}$","type":"string"},"max_rules":{"description":"Current maximum number of rules allowed for the stack; does not truncate existing configuration.","example":50,"format":"int64","minimum":0,"type":"integer"},"object_type":{"description":"Always `STACK_AUTOMATION_SETTINGS`.","enum":["STACK_AUTOMATION_SETTINGS"],"example":"STACK_AUTOMATION_SETTINGS","type":"string"},"rules":{"description":"Complete ordered configuration. Evaluation runs TEXT, STATUS, LABEL families with order preserved within each family.","example":[{"action":{"status":"APPROVED","target":{"conditions":[],"language_codes":[],"selector":"TRIGGERING_TEXT"},"type":"SET_STATUS"},"conditions":[{"mode":"CONTAINS","subject":"TEXT","value":"draft"}],"is_enabled":true,"rule_key":"0197c8f2-5a6b-7cde-8f12-3456789abcde","scope":{"language_codes":["de"],"origin":"IMPORT","role":"TARGET"},"trigger":"TEXT_UPDATED","type":"STATUS"}],"items":{"$ref":"#/components/schemas/StackAutomationRule"},"type":"array"},"updated_at":{"description":"Last change to the stack settings row.","example":"2026-09-30T00:00:00.123Z","format":"date-time","type":"string"}},"required":["created_at","id","max_rules","object_type","rules","updated_at"],"type":"object"},"StackCollection":{"description":"A list of LingoHub stacks with pagination capability.","properties":{"data":{"description":"The list of items in this page.","example":[{"ai_context":"Mobile apps for retail banking.","character_count":72632,"color":"#FF5733","counts_updated_at":"2025-06-20T10:34:38.123Z","created_at":"2025-01-15T10:30:00.123Z","id":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","lina_id":"lina_0197c8f2-5a6b-7cde-8f12-3456789abcde","name":"My Stack","object_type":"STACK","type":"PRIVATE","updated_at":"2025-06-20T14:45:00.123Z","word_count":8840}],"items":{"$ref":"#/components/schemas/Stack"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"StackFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+stack[created_at]","-stack[created_at]","+stack[name]","-stack[name]","+stack[updated_at]","-stack[updated_at]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/StackFilterGroup"}},"type":"object"},"StackFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/StackFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/StackFilterClause"},"minItems":1,"type":"array"},"stack[created_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"stack[id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^stack_[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}$","type":"string"},"_in":{"items":{"pattern":"^stack_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^stack_[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}$","type":"string"},"_nin":{"items":{"pattern":"^stack_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"stack[name]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"stack[type]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["PRIVATE","PUBLIC"],"type":"string"},"_in":{"items":{"enum":["PRIVATE","PUBLIC"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["PRIVATE","PUBLIC"],"type":"string"},"_nin":{"items":{"enum":["PRIVATE","PUBLIC"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"stack[updated_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"}},"type":"object"},"StackFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/StackFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/StackFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"StackLanguage":{"description":"A language of a stack: its source language or a target language. The stack's projects add it to their branches with addProjectLanguages.","properties":{"created_at":{"description":"Timestamp when the language was added to the stack.","example":"2025-01-15T10:30:00.123Z","format":"date-time","type":"string"},"fallback_language_code":{"description":"The language used when a translation in this language is missing, or null for none. It applies to every project of the stack.","example":"de","type":["string","null"]},"id":{"description":"Unique identifier of the stack language.","example":"stackl_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^stackl_[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}$","type":"string"},"is_source":{"description":"Whether this is the stack's source language. Every stack has exactly one; it can't be changed through the API.","example":false,"type":"boolean"},"language_code":{"description":"The language's code; unique in the stack.","example":"de-AT","type":"string"},"lina_role":{"$ref":"#/components/schemas/LanguageLinaRole","description":"What the stack's LINA does in this language: `ASSISTANT` only when asked; `TRANSLATOR` translates and checks, and a person approves; `AGENT` also approves by itself when the stack's quality settings allow. Has no effect while the stack has no LINA.","example":"ASSISTANT"},"object_type":{"description":"Always `STACK_LANGUAGE`.","enum":["STACK_LANGUAGE"],"example":"STACK_LANGUAGE","type":"string"},"updated_at":{"description":"Timestamp when the stack language was last updated.","example":"2025-06-20T14:45:00.123Z","format":"date-time","type":"string"}},"required":["created_at","fallback_language_code","id","is_source","language_code","lina_role","object_type","updated_at"],"type":"object"},"StackLanguageCollection":{"description":"A list of stack languages.","properties":{"data":{"description":"The list of items in this page.","example":[{"created_at":"2025-01-15T10:30:00.123Z","fallback_language_code":"de","id":"stackl_0197c8f2-5a6b-7cde-8f12-3456789abcde","is_source":false,"language_code":"de-AT","lina_role":"ASSISTANT","object_type":"STACK_LANGUAGE","updated_at":"2025-06-20T14:45:00.123Z"}],"items":{"$ref":"#/components/schemas/StackLanguage"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"StackLanguageFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return.","properties":{"where":{"$ref":"#/components/schemas/StackLanguageFilterGroup"}},"type":"object"},"StackLanguageFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/StackLanguageFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/StackLanguageFilterClause"},"minItems":1,"type":"array"},"stack_language[is_source]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_false":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_true":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"}},"type":"object"},"stack_language[language_code]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_gt":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_in":{"items":{"type":"string"},"minItems":1,"type":"array"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nin":{"items":{"type":"string"},"minItems":1,"type":"array"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"}},"type":"object"},"StackLanguageFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/StackLanguageFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/StackLanguageFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"StackMember":{"description":"An explicit stack assignment, addressed by stack and workspace membership. Inherited access need not have an assignment. Timestamps describe the assignment; validators also cover current profile and language rows.","properties":{"created_at":{"description":"Time the explicit stack assignment was created.","example":"2026-09-29T10:00:00.123Z","format":"date-time","type":"string"},"email":{"description":"Current account email, when available.","example":"translator@example.com","type":["string","null"]},"first_name":{"description":"Current first name, when provided.","example":"Alex","type":["string","null"]},"id":{"description":"Workspace membership identity, separate from the account identity.","example":"wsu_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^wsu_[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}$","type":"string"},"is_owner":{"description":"Whether the member holds the stack's owner role. Owners can't be changed or removed through the API (409 `owner_membership_protected`).","example":false,"type":"boolean"},"language_permissions":{"additionalProperties":{"$ref":"#/components/schemas/StackMemberLanguagePermission"},"description":"Explicit stored language permissions. An empty map means no explicit rows; it does not describe effective access inherited through roles.","example":{"de":"READ_ACCESS"},"type":"object"},"last_name":{"description":"Current last name, when provided.","example":"Muster","type":["string","null"]},"object_type":{"description":"Always `STACK_MEMBER`.","enum":["STACK_MEMBER"],"example":"STACK_MEMBER","type":"string"},"stack_id":{"description":"Stack containing this explicit assignment.","example":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stack_[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}$","type":"string"},"stack_role_id":{"description":"Current assigned role in this stack.","example":"stackr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stackr_[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}$","type":"string"},"updated_at":{"description":"Stored stack-assignment update time; profile and language rows change independently.","example":"2026-09-29T10:00:00.123Z","format":"date-time","type":"string"}},"required":["created_at","email","first_name","id","is_owner","language_permissions","last_name","object_type","stack_id","stack_role_id","updated_at"],"type":"object"},"StackMemberCollection":{"description":"A cursor-paginated collection of explicit stack members.","properties":{"data":{"description":"The list of items in this page.","example":[{"created_at":"2026-09-29T10:00:00.123Z","email":"translator@example.com","first_name":"Alex","id":"wsu_0197c8f2-5a6b-7cde-8f12-3456789abcde","is_owner":false,"language_permissions":{"de":"READ_ACCESS"},"last_name":"Muster","object_type":"STACK_MEMBER","stack_id":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","stack_role_id":"stackr_0197c8f2-5a6b-7cde-8f12-3456789abcde","updated_at":"2026-09-29T10:00:00.123Z"}],"items":{"$ref":"#/components/schemas/StackMember"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"StackMemberFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+stack_member[created_at]","-stack_member[created_at]","+stack_member[updated_at]","-stack_member[updated_at]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/StackMemberFilterGroup"}},"type":"object"},"StackMemberFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/StackMemberFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/StackMemberFilterClause"},"minItems":1,"type":"array"},"stack_member[created_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"stack_member[email]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"stack_member[first_name]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"stack_member[id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^wsu_[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}$","type":"string"},"_in":{"items":{"pattern":"^wsu_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^wsu_[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}$","type":"string"},"_nin":{"items":{"pattern":"^wsu_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"stack_member[last_name]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"stack_member[stack_role_id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^stackr_[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}$","type":"string"},"_in":{"items":{"pattern":"^stackr_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^stackr_[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}$","type":"string"},"_nin":{"items":{"pattern":"^stackr_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"stack_member[updated_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"}},"type":"object"},"StackMemberFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/StackMemberFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/StackMemberFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"StackMemberLanguagePermission":{"description":"Explicit stored language permission; effective access can additionally come from workspace or stack role permissions.","enum":["READ_ACCESS","RESTRICTED_ACCESS","FULL_ACCESS"],"example":"READ_ACCESS","type":"string"},"StackMemberPermissions":{"description":"Computed application permissions of a workspace member on one stack, including inherited access without an explicit assignment. These are not the calling API key's permissions or an exception to API owner-mutation restrictions. Computed data has no invented timestamps.","properties":{"id":{"description":"Workspace membership identity, addressed together with the stack.","example":"wsu_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^wsu_[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}$","type":"string"},"language_permissions":{"additionalProperties":{"$ref":"#/components/schemas/EffectiveLanguagePermission"},"description":"Effective access for each current stack language, including inherited defaults. NO_ACCESS means the language checks grant no access; an empty map means the stack has no languages.","example":{"de":"READ_ACCESS"},"type":"object"},"object_type":{"description":"Always `STACK_MEMBER_PERMISSIONS`.","enum":["STACK_MEMBER_PERMISSIONS"],"example":"STACK_MEMBER_PERMISSIONS","type":"string"},"permissions":{"description":"Effective access for every stack permission target, evaluated by the application's authorization checks.","example":[{"level":"VIEW","scope":"STACK","target":"RESOURCES"}],"items":{"$ref":"#/components/schemas/Permission"},"type":"array"},"stack_id":{"description":"Stack on which the permissions are evaluated.","example":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stack_[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}$","type":"string"}},"required":["id","language_permissions","object_type","permissions","stack_id"],"type":"object"},"StackPermissions":{"description":"The API key's stack permissions for one stack where they differ from its default.","properties":{"permissions":{"description":"The permissions on this stack, one per stack area.","example":[{"level":"MANAGE","scope":"STACK","target":"RESOURCES"}],"items":{"$ref":"#/components/schemas/Permission"},"type":"array"},"stack_id":{"description":"Unique identifier of the stack.","example":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stack_[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}$","type":"string"}},"required":["permissions","stack_id"],"type":"object"},"StackRole":{"description":"An existing stack role without its internal permission configuration or assigned users.","properties":{"created_at":{"description":"Time the role was created.","example":"2026-09-29T10:00:00.123Z","format":"date-time","type":"string"},"description":{"description":"Description of the role, if provided.","example":"Translates assigned content.","type":["string","null"]},"id":{"description":"Unique stack role identity.","example":"stackr_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^stackr_[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}$","type":"string"},"name":{"description":"Display name of the role.","example":"Translator","type":"string"},"object_type":{"description":"Always `STACK_ROLE`.","enum":["STACK_ROLE"],"example":"STACK_ROLE","type":"string"},"type":{"$ref":"#/components/schemas/StackRoleType","description":"Role category. Reading OWNER does not permit owner membership changes through the API.","example":"CUSTOM"},"updated_at":{"description":"Time the role was last changed.","example":"2026-09-29T10:00:00.123Z","format":"date-time","type":"string"}},"required":["created_at","description","id","name","object_type","type","updated_at"],"type":"object"},"StackRoleCollection":{"description":"A cursor-paginated collection of stack roles.","properties":{"data":{"description":"The list of items in this page.","example":[{"created_at":"2026-09-29T10:00:00.123Z","description":"Translates assigned content.","id":"stackr_0197c8f2-5a6b-7cde-8f12-3456789abcde","name":"Translator","object_type":"STACK_ROLE","type":"CUSTOM","updated_at":"2026-09-29T10:00:00.123Z"}],"items":{"$ref":"#/components/schemas/StackRole"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"StackRoleFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+stack_role[created_at]","-stack_role[created_at]","+stack_role[name]","-stack_role[name]","+stack_role[updated_at]","-stack_role[updated_at]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/StackRoleFilterGroup"}},"type":"object"},"StackRoleFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/StackRoleFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/StackRoleFilterClause"},"minItems":1,"type":"array"},"stack_role[created_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"stack_role[description]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"stack_role[id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^stackr_[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}$","type":"string"},"_in":{"items":{"pattern":"^stackr_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^stackr_[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}$","type":"string"},"_nin":{"items":{"pattern":"^stackr_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"stack_role[name]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"stack_role[type]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["OWNER","LOCALIZATION_MANAGER","MEMBER","CUSTOM"],"type":"string"},"_in":{"items":{"enum":["OWNER","LOCALIZATION_MANAGER","MEMBER","CUSTOM"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["OWNER","LOCALIZATION_MANAGER","MEMBER","CUSTOM"],"type":"string"},"_nin":{"items":{"enum":["OWNER","LOCALIZATION_MANAGER","MEMBER","CUSTOM"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"stack_role[updated_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"}},"type":"object"},"StackRoleFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/StackRoleFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/StackRoleFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"StackRoleType":{"description":"Stack role category. OWNER can be discovered but owner membership changes are outside the API.","enum":["OWNER","LOCALIZATION_MANAGER","MEMBER","CUSTOM"],"example":"MEMBER","type":"string"},"StackType":{"description":"`PUBLIC`: a shared stack that several projects can use. `PRIVATE`: the stack a single project creates for itself; the app doesn't show it as a separate stack.","enum":["PRIVATE","PUBLIC"],"type":"string"},"StoryblokRegion":{"description":"Existing Storyblok hosting regions.","enum":["EUROPE","UNITED_STATES","CANADA","AUSTRALIA","CHINA"],"type":"string"},"StyleGuide":{"description":"A style guide: the rules LINA follows when translating and the style checks use. General rules apply to every language; single languages can have rules of their own and a regional variant.","properties":{"ai_context":{"description":"Additional instructions LINA gets with the style guide, e.g. about tone.","example":"Translate in a friendly and approachable tone suitable for a SaaS product.","maxLength":512,"minLength":0,"type":["string","null"]},"audience_description":{"description":"Who the texts are written for, in your own words.","example":"Software developers and technical users familiar with localization workflows.","maxLength":16384,"minLength":0,"type":["string","null"]},"created_at":{"description":"Timestamp when the style guide was created.","example":"2025-01-15T10:30:00.123Z","format":"date-time","type":"string"},"id":{"description":"Unique identifier of the style guide.","example":"sg_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^sg_[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}$","type":"string"},"language_variants":{"description":"Regional variants set for general languages, sorted by language; read one with getStyleGuideLanguageVariant.","example":[{"language_code":"de","variant_language_code":"de-AT"}],"items":{"$ref":"#/components/schemas/LanguageVariant"},"type":"array"},"name":{"description":"Name of the style guide; it doesn't have to be unique.","example":"Workspace Style Guide","maxLength":128,"minLength":0,"type":"string"},"object_type":{"description":"Always `STYLE_GUIDE`.","enum":["STYLE_GUIDE"],"example":"STYLE_GUIDE","type":"string"},"rule_language_codes":{"description":"Languages with rules of their own, sorted; read them with getStyleGuideLanguageRules.","example":["de","ja"],"items":{"example":"de","type":"string"},"type":"array"},"rules":{"$ref":"#/components/schemas/StyleGuideRules","description":"The general rules, for every language."},"updated_at":{"description":"Timestamp when the style guide was last updated.","example":"2025-06-20T14:45:00.123Z","format":"date-time","type":"string"}},"required":["ai_context","audience_description","created_at","id","language_variants","name","object_type","rule_language_codes","rules","updated_at"],"type":"object"},"StyleGuideAgeGroup":{"description":"Defines the target age group for content, allowing tone and vocabulary to be adjusted accordingly.","enum":["NOT_SPECIFIED","CHILDREN","TEENAGERS","YOUNG_ADULTS","ADULTS","SENIORS"],"type":"string"},"StyleGuideAudience":{"description":"Defines the target audience for a piece of communication, which helps tailor the tone, vocabulary, and language complexity.","enum":["NOT_SPECIFIED","GENERAL_PUBLIC","CUSTOMERS","BUSINESS","PARTNERS","EXPERTS","DEVELOPERS","MARKETING","INTERNAL_EMPLOYEES"],"type":"string"},"StyleGuideCollection":{"description":"A list of LingoHub style guides with pagination capability.","properties":{"data":{"description":"The list of items in this page.","example":[{"ai_context":"Translate in a friendly and approachable tone suitable for a SaaS product.","audience_description":"Software developers and technical users familiar with localization workflows.","created_at":"2025-01-15T10:30:00.123Z","id":"sg_0197c8f2-5a6b-7cde-8f12-3456789abcde","language_variants":[{"language_code":"de","variant_language_code":"de-AT"}],"name":"Workspace Style Guide","object_type":"STYLE_GUIDE","rule_language_codes":["de","ja"],"rules":{"age_group":"ADULTS","audience":"DEVELOPERS","domain":"TECHNOLOGY","formality":"FORMAL","grammatical_person":"SECOND_PERSON_SINGULAR","language_complexity":"STANDARD","literal_translation":"NEUTRAL","text_type":"SOFTWARE_UI","vocabulary_type":"TECHNICAL","voice":"ACTIVE"},"updated_at":"2025-06-20T14:45:00.123Z"}],"items":{"$ref":"#/components/schemas/StyleGuide"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"StyleGuideDateFormat":{"description":"Specifies various date formats for formatting and parsing dates, covering common standards and regional conventions.","enum":["NOT_SPECIFIED","ISO_8601","US_FORMAT","EU_FORMAT","UK_FORMAT","CHINA_FORMAT","JAPAN_FORMAT","KOREA_FORMAT","SHORT_FORMAT","LONG_FORMAT"],"type":"string"},"StyleGuideDecimalSeparator":{"description":"Defines the character used as decimal separator in numeric values.","enum":["NOT_SPECIFIED","DOT","COMMA"],"type":"string"},"StyleGuideDomain":{"description":"Represents various content domains to help guide context-specific AI behavior.","enum":["NOT_SPECIFIED","AGRICULTURE","AEROSPACE","ANIMALS","ARTS","AUTOMOTIVE","TECHNOLOGY","REAL_ESTATE","CONSUMER_GOODS","EDUCATION","ENTERTAINMENT","ECOLOGY","HEALTH","PHARMACEUTICAL","GOVERNMENT","MEDIA","RELIGION","FOOD","RETAIL","FASHION","TRAVEL","ENERGY","FINANCIAL","LEGAL","RAW_MATERIALS","LIFESTYLE","SPORTS","HOME","ECONOMY","SCIENCE","HUMAN_RESOURCES","ADULT"],"type":"string"},"StyleGuideFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+style_guide[created_at]","-style_guide[created_at]","+style_guide[name]","-style_guide[name]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/StyleGuideFilterGroup"}},"type":"object"},"StyleGuideFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/StyleGuideFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/StyleGuideFilterClause"},"minItems":1,"type":"array"},"style_guide[created_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"style_guide[id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^sg_[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}$","type":"string"},"_in":{"items":{"pattern":"^sg_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^sg_[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}$","type":"string"},"_nin":{"items":{"pattern":"^sg_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"style_guide[name]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"}},"type":"object"},"StyleGuideFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/StyleGuideFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/StyleGuideFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"StyleGuideFormality":{"description":"Defines the desired level of formality in language, ranging from formal to informal.","enum":["NOT_SPECIFIED","FORMAL","INFORMAL"],"type":"string"},"StyleGuideGenderInclusiveness":{"description":"Defines preferences for gender expression in language, particularly for nouns and pronouns in gendered languages.","enum":["NOT_SPECIFIED","MASCULINE_GENERIC","FEMININE_GENERIC","GENDER_NEUTRAL","GENDER_INCLUSIVE"],"type":"string"},"StyleGuideGrammaticalPerson":{"description":"Defines the grammatical person to be used when addressing or referring to the reader in generated text.","enum":["NOT_SPECIFIED","FIRST_PERSON_SINGULAR","SECOND_PERSON_SINGULAR","THIRD_PERSON_SINGULAR_MASCULINE","THIRD_PERSON_SINGULAR_FEMININE","THIRD_PERSON_SINGULAR_NEUTRAL","FIRST_PERSON_PLURAL","SECOND_PERSON_PLURAL","THIRD_PERSON_PLURAL"],"type":"string"},"StyleGuideGroupingSeparator":{"description":"Defines the character used for grouping digits in numeric values.","enum":["NOT_SPECIFIED","NONE","COMMA","DOT","SPACE_LIKE","APOSTROPHE"],"type":"string"},"StyleGuideHonorificLevelJapanese":{"description":"Defines the level of formality for the Japanese language, affecting verb conjugations and vocabulary choice.","enum":["NOT_SPECIFIED","PLAIN","POLITE","HONORIFIC","HUMBLE","BUSINESS_POLITE"],"type":"string"},"StyleGuideHonorificLevelKorean":{"description":"Defines the level of formality for the Korean language, which is crucial for correct social and business communication.","enum":["NOT_SPECIFIED","PLAIN","POLITE","FORMAL_POLITE"],"type":"string"},"StyleGuideLanguageComplexity":{"description":"Defines the desired level of language complexity and simplicity for generated text.","enum":["NOT_SPECIFIED","STANDARD","PLAIN_LANGUAGE","VERY_SIMPLE"],"type":"string"},"StyleGuideLanguageRules":{"description":"Per-language override rules that refine the global style guide settings for a specific language.","properties":{"created_at":{"description":"Timestamp when the rules were created.","example":"2025-01-15T10:30:00.123Z","format":"date-time","type":"string"},"date_format":{"description":"Preferred date format for this language.","example":"EU_FORMAT","oneOf":[{"$ref":"#/components/schemas/StyleGuideDateFormat"},{"type":"null"}]},"decimal_separator":{"description":"Preferred decimal separator for this language.","example":"COMMA","oneOf":[{"$ref":"#/components/schemas/StyleGuideDecimalSeparator"},{"type":"null"}]},"formality":{"description":"Language-specific formality override.","example":"FORMAL","oneOf":[{"$ref":"#/components/schemas/StyleGuideFormality"},{"type":"null"}]},"gender_inclusiveness":{"description":"Gender inclusiveness preference for this language.","example":"GENDER_NEUTRAL","oneOf":[{"$ref":"#/components/schemas/StyleGuideGenderInclusiveness"},{"type":"null"}]},"grouping_separator":{"description":"Preferred grouping separator for numeric values in this language.","example":"DOT","oneOf":[{"$ref":"#/components/schemas/StyleGuideGroupingSeparator"},{"type":"null"}]},"honorific_level_japanese":{"description":"Honorific level for Japanese translations.","example":"POLITE","oneOf":[{"$ref":"#/components/schemas/StyleGuideHonorificLevelJapanese"},{"type":"null"}]},"honorific_level_korean":{"description":"Honorific level for Korean translations.","example":"POLITE","oneOf":[{"$ref":"#/components/schemas/StyleGuideHonorificLevelKorean"},{"type":"null"}]},"language_code":{"description":"Language code the rules apply to.","example":"de","type":"string"},"language_complexity":{"description":"Language complexity level for this language.","example":"STANDARD","oneOf":[{"$ref":"#/components/schemas/StyleGuideLanguageComplexity"},{"type":"null"}]},"object_type":{"description":"Always `STYLE_GUIDE_LANGUAGE_RULES`.","enum":["STYLE_GUIDE_LANGUAGE_RULES"],"example":"STYLE_GUIDE_LANGUAGE_RULES","type":"string"},"oxford_comma":{"description":"Preferred serial comma usage for this language.","example":"NOT_SPECIFIED","oneOf":[{"$ref":"#/components/schemas/StyleGuideOxfordComma"},{"type":"null"}]},"quotes_format":{"description":"Preferred quotation mark style for this language.","example":"QUOTES_GERMAN","oneOf":[{"$ref":"#/components/schemas/StyleGuideQuotesFormat"},{"type":"null"}]},"style_guide_id":{"description":"Unique identifier of the style guide the rules belong to.","example":"sg_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^sg_[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}$","type":"string"},"time_format":{"description":"Preferred time format for this language.","example":"TIME_24H","oneOf":[{"$ref":"#/components/schemas/StyleGuideTimeFormat"},{"type":"null"}]},"updated_at":{"description":"Timestamp when the rules were last updated.","example":"2025-06-20T14:45:00.123Z","format":"date-time","type":"string"},"voice":{"description":"Language-specific voice preference.","example":"ACTIVE","oneOf":[{"$ref":"#/components/schemas/StyleGuideVoice"},{"type":"null"}]}},"required":["created_at","date_format","decimal_separator","formality","gender_inclusiveness","grouping_separator","honorific_level_japanese","honorific_level_korean","language_code","language_complexity","object_type","oxford_comma","quotes_format","style_guide_id","time_format","updated_at","voice"],"type":"object"},"StyleGuideLanguageVariant":{"description":"The regional variant a style guide sets for a language: texts translated into the general language are written in it, e.g. `en-GB` for `en`.","properties":{"created_at":{"description":"Timestamp when the variant was created.","example":"2025-01-15T10:30:00.123Z","format":"date-time","type":"string"},"language_code":{"description":"General language the variant is set for.","example":"en","type":"string"},"object_type":{"description":"Always `STYLE_GUIDE_LANGUAGE_VARIANT`.","enum":["STYLE_GUIDE_LANGUAGE_VARIANT"],"example":"STYLE_GUIDE_LANGUAGE_VARIANT","type":"string"},"style_guide_id":{"description":"Unique identifier of the style guide the variant belongs to.","example":"sg_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^sg_[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}$","type":"string"},"updated_at":{"description":"Timestamp when the variant was last updated.","example":"2025-06-20T14:45:00.123Z","format":"date-time","type":"string"},"variant_language_code":{"description":"Regional variant that texts in the general language are written in.","example":"en-GB","type":"string"}},"required":["created_at","language_code","object_type","style_guide_id","updated_at","variant_language_code"],"type":"object"},"StyleGuideLiteralTranslation":{"description":"Defines the preferred translation approach, ranging from literal word-for-word to cultural or conversational adaptation.","enum":["NOT_SPECIFIED","CULTURAL_OR_CONVERSATIONAL","LITERAL","NEUTRAL"],"type":"string"},"StyleGuideOxfordComma":{"description":"Defines stylistic preferences for using the serial (Oxford) comma before the final conjunction in lists.","enum":["NOT_SPECIFIED","OXFORD_COMMA","NO_OXFORD_COMMA"],"type":"string"},"StyleGuideQuotesFormat":{"description":"Defines different typographical styles for quotation marks, accommodating various international and stylistic conventions.","enum":["NOT_SPECIFIED","QUOTES_ENGLISH","QUOTES_SINGLE","QUOTES_GERMAN","QUOTES_FRENCH","QUOTES_SWISS","QUOTES_GUILLEMET"],"type":"string"},"StyleGuideRules":{"description":"The global translation rules defined for a style guide.","properties":{"age_group":{"$ref":"#/components/schemas/StyleGuideAgeGroup","description":"Target age group for translation style and vocabulary choice.","example":"ADULTS"},"audience":{"$ref":"#/components/schemas/StyleGuideAudience","description":"Target audience for translation style and vocabulary choice.","example":"DEVELOPERS"},"domain":{"$ref":"#/components/schemas/StyleGuideDomain","description":"Content domain to guide context-specific AI behavior.","example":"TECHNOLOGY"},"formality":{"$ref":"#/components/schemas/StyleGuideFormality","description":"Desired level of formality for translated text.","example":"FORMAL"},"grammatical_person":{"$ref":"#/components/schemas/StyleGuideGrammaticalPerson","description":"Grammatical person to use for translated text.","example":"SECOND_PERSON_SINGULAR"},"language_complexity":{"$ref":"#/components/schemas/StyleGuideLanguageComplexity","description":"Desired level of language complexity for generated text.","example":"STANDARD"},"literal_translation":{"$ref":"#/components/schemas/StyleGuideLiteralTranslation","description":"Specifies how literally the source text should be translated.","example":"NEUTRAL"},"text_type":{"$ref":"#/components/schemas/StyleGuideTextType","description":"Type of text being translated.","example":"SOFTWARE_UI"},"vocabulary_type":{"$ref":"#/components/schemas/StyleGuideVocabularyType","description":"Type of vocabulary to guide AI word choice.","example":"TECHNICAL"},"voice":{"$ref":"#/components/schemas/StyleGuideVoice","description":"Preferred grammatical voice for translated text.","example":"ACTIVE"}},"required":["age_group","audience","domain","formality","grammatical_person","language_complexity","literal_translation","text_type","vocabulary_type","voice"],"type":"object"},"StyleGuideTextType":{"description":"Defines the specific type of text being processed, which helps in applying the correct style, tone, and formatting rules.","enum":["NOT_SPECIFIED","TECHNICAL_DOCUMENTATION","SOFTWARE_UI","MOBILE_UI","MARKETING_TEXT","SYSTEM_MESSAGE","EMAIL_CONTENT","WEBSITE_CONTENT","CONVERSATIONAL_CONTENT","SURVEY_AND_FEEDBACK_TEXT","SOCIAL_MEDIA_CONTENT","MULTIMEDIA_TEXT","SEO_CONTENT"],"type":"string"},"StyleGuideTimeFormat":{"description":"Specifies various time formats for formatting and parsing time values.","enum":["NOT_SPECIFIED","TIME_24H","TIME_12H"],"type":"string"},"StyleGuideVocabularyType":{"description":"Represents different types of vocabulary to guide word choice in text generation.","enum":["NOT_SPECIFIED","POPULAR","TECHNICAL","FICTIONAL","FORMAL","SLANG"],"type":"string"},"StyleGuideVoice":{"description":"Specifies a preference for using either active or passive voice in writing.","enum":["NOT_SPECIFIED","ACTIVE","PASSIVE","FLEXIBLE"],"type":"string"},"SupportedLocaleCollection":{"description":"A list of locales supported by LingoHub with pagination capability.","properties":{"data":{"description":"The list of items in this page.","example":[{"direction":"LTR","english_name":"German (Austria)","id":"lo_0197c8f2-5a6b-7cde-8f12-3456789abcde","language_code":"de-AT","object_type":"LOCALE"}],"items":{"$ref":"#/components/schemas/Locale"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"SyncContentIntegration":{"additionalProperties":false,"description":"Request body to reconcile selected provider resources with the project.","properties":{"is_import_new_resources":{"description":"Whether newly discovered resources are imported immediately, using the existing provider workflow.","example":true,"type":"boolean"}},"required":["is_import_new_resources"],"type":"object"},"SyncStatusCode":{"description":"Public background-operation and entry outcome codes. ALREADY_EXISTS explains a skipped language addition. PARTIAL_FAILURE means some work completed. UNKNOWN_ERROR means no more specific cause was recorded. Clients must tolerate future codes.","enum":["ALREADY_EXISTS","UNKNOWN_ERROR","PARTIAL_FAILURE","STORAGE_UPLOAD_FAILED","STORAGE_DOWNLOAD_FAILED","ARCHIVE_CREATION_FAILED","LANGUAGE_NOT_DETECTED","FILE_PATH_NOT_DETECTED","PRETRANSLATION_FAILED","TRANSLATION_PROVIDER_FAILED","EMPTY_FILE","UNKNOWN_ENCODING","UNSUPPORTED_IMPORT_FORMAT","INVALID_FILE_SYNTAX","DUPLICATE_KEY","KEY_OPERATION_IN_PROGRESS","INVALID_DOCUMENT","DOCUMENT_PROCESSING_FAILED","UNSUPPORTED_EXPORT_FORMAT","FILE_GENERATION_FAILED","INVALID_FILE_STRUCTURE","RESOURCE_TREE_CHANGED","RESOURCE_NOT_FOUND","LANGUAGE_NOT_FOUND","LANGUAGE_NOT_SUPPORTED","NO_RESOURCES","NO_FILES","ENTRY_FAILURES","DOCUMENT_VERSION_MISSING","DOCUMENT_MERGE_FAILED","INVALID_TRANSLATIONS","INTEGRATION_RESOURCE_NOT_FOUND","INTEGRATION_FAILED","INCOMPLETE_TRANSLATION","INTERRUPTED","SELECTION_CHANGED","EMPTY_SELECTION","MOVE_SOURCE_CHANGED","BACKUP_FAILED","RESTORE_FAILED","EXECUTION_FAILED","TIMED_OUT"],"type":"string"},"SyncStatusDetails":{"description":"A machine-readable explanation of a background operation or entry outcome. The detail is safe display text, not a value to parse. A failed or partial operation may already have applied changes; inspect its entries before retrying.","properties":{"code":{"$ref":"#/components/schemas/SyncStatusCode","description":"Stable public outcome code.","example":"NO_FILES"},"detail":{"description":"English explanation of the outcome.","example":"There are no files to export.","type":"string"}},"required":["code","detail"],"type":"object"},"Term":{"description":"A glossary term with its forms: per language, the preferred form and its alternatives. An untranslatable term's forms have no language.","properties":{"ai_context":{"description":"Context for AI translation, e.g. what the term means.","example":"Final step of the purchase flow.","type":["string","null"]},"created_at":{"description":"Timestamp when the term was created.","example":"2025-01-15T10:30:00.123Z","format":"date-time","type":"string"},"enforcement_status":{"$ref":"#/components/schemas/EnforcementStatus","description":"How strictly the term is applied.","example":"ENFORCED"},"forms":{"description":"The term's forms, ordered by language, with the preferred form first. Languages that inherit a form are listed in its `inherited_by`.","example":[{"case_sensitivity":"SENSITIVE","created_at":"2025-01-15T10:30:00.123Z","form_type":"FULL_FORM","grammatical_gender":"FEMININE","grammatical_number":"SINGULAR","id":"ter_0197c8f2-5a6b-7cde-8f12-3456789abcde","inherited_by":["de-AT","de-CH"],"language_code":"de","match_expression":null,"matching":"AUTOMATIC","object_type":"TERM_FORM","part_of_speech":"NOUN","term_id":"te_0197c8f2-5a6b-7cde-8f12-3456789abcde","text":"Kasse","updated_at":"2025-06-20T14:45:00.123Z","usage_status":"PREFERRED"}],"items":{"$ref":"#/components/schemas/TermForm"},"type":"array"},"glossary_id":{"description":"Unique identifier of the glossary the term belongs to.","example":"gls_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^gls_[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}$","type":"string"},"id":{"description":"Unique identifier of the term.","example":"te_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^te_[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}$","type":"string"},"object_type":{"description":"Always `TERM`.","enum":["TERM"],"example":"TERM","type":"string"},"type":{"$ref":"#/components/schemas/TermType","description":"Whether the term is translated.","example":"TRANSLATABLE"},"updated_at":{"description":"Timestamp when the term was last updated.","example":"2025-06-20T14:45:00.123Z","format":"date-time","type":"string"}},"required":["ai_context","created_at","enforcement_status","forms","glossary_id","id","object_type","type","updated_at"],"type":"object"},"TermCollection":{"description":"A list of terms with pagination capability.","properties":{"data":{"description":"The list of items in this page.","example":[{"ai_context":"Final step of the purchase flow.","created_at":"2025-01-15T10:30:00.123Z","enforcement_status":"ENFORCED","forms":[{"case_sensitivity":"SENSITIVE","created_at":"2025-01-15T10:30:00.123Z","form_type":"FULL_FORM","grammatical_gender":"FEMININE","grammatical_number":"SINGULAR","id":"ter_0197c8f2-5a6b-7cde-8f12-3456789abcde","inherited_by":["de-AT","de-CH"],"language_code":"de","match_expression":null,"matching":"AUTOMATIC","object_type":"TERM_FORM","part_of_speech":"NOUN","term_id":"te_0197c8f2-5a6b-7cde-8f12-3456789abcde","text":"Kasse","updated_at":"2025-06-20T14:45:00.123Z","usage_status":"PREFERRED"}],"glossary_id":"gls_0197c8f2-5a6b-7cde-8f12-3456789abcde","id":"te_0197c8f2-5a6b-7cde-8f12-3456789abcde","object_type":"TERM","type":"TRANSLATABLE","updated_at":"2025-06-20T14:45:00.123Z"}],"items":{"$ref":"#/components/schemas/Term"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"TermFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+term[created_at]","-term[created_at]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/TermFilterGroup"}},"type":"object"},"TermFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/TermFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/TermFilterClause"},"minItems":1,"type":"array"},"term[created_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"term[enforcement_status]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["ENFORCED","INFORMATIONAL"],"type":"string"},"_in":{"items":{"enum":["ENFORCED","INFORMATIONAL"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["ENFORCED","INFORMATIONAL"],"type":"string"},"_nin":{"items":{"enum":["ENFORCED","INFORMATIONAL"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"term[id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^te_[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}$","type":"string"},"_in":{"items":{"pattern":"^te_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^te_[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}$","type":"string"},"_nin":{"items":{"pattern":"^te_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"term[type]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["TRANSLATABLE","UNTRANSLATABLE"],"type":"string"},"_in":{"items":{"enum":["TRANSLATABLE","UNTRANSLATABLE"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["TRANSLATABLE","UNTRANSLATABLE"],"type":"string"},"_nin":{"items":{"enum":["TRANSLATABLE","UNTRANSLATABLE"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"term_form[id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^ter_[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}$","type":"string"},"_in":{"items":{"pattern":"^ter_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^ter_[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}$","type":"string"},"_nin":{"items":{"pattern":"^ter_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"term_form[language_code]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_gt":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_in":{"items":{"type":"string"},"minItems":1,"type":"array"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nin":{"items":{"type":"string"},"minItems":1,"type":"array"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"term_form[text]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"}},"type":"object"},"TermFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/TermFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/TermFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"TermForm":{"description":"One way of writing a term in a language: its preferred form, an admitted alternative, or a form not to use.","properties":{"case_sensitivity":{"$ref":"#/components/schemas/CaseSensitivity","description":"How the form is matched with regard to case.","example":"SENSITIVE"},"created_at":{"description":"Timestamp when the form was created.","example":"2025-01-15T10:30:00.123Z","format":"date-time","type":"string"},"form_type":{"description":"Lexical type of the form.","example":"FULL_FORM","oneOf":[{"$ref":"#/components/schemas/TermFormType"},{"type":"null"}]},"grammatical_gender":{"description":"Grammatical gender of the form.","example":"FEMININE","oneOf":[{"$ref":"#/components/schemas/GrammaticalGender"},{"type":"null"}]},"grammatical_number":{"description":"Grammatical number of the form.","example":"SINGULAR","oneOf":[{"$ref":"#/components/schemas/GrammaticalNumber"},{"type":"null"}]},"id":{"description":"Unique identifier of the term form.","example":"ter_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^ter_[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}$","type":"string"},"inherited_by":{"description":"Languages without a form of their own that use this preferred form, e.g. `de-AT` using the `de` form. Empty for every other form.","example":["de-AT","de-CH"],"items":{"type":"string"},"type":"array"},"language_code":{"description":"Language of the form; null for the forms of an untranslatable term.","example":"de","type":["string","null"]},"match_expression":{"description":"The regular expression a `CUSTOM` matching uses; null for every other matching.","type":["string","null"]},"matching":{"$ref":"#/components/schemas/Matching","description":"How the form is matched against text.","example":"AUTOMATIC"},"object_type":{"description":"Always `TERM_FORM`.","enum":["TERM_FORM"],"example":"TERM_FORM","type":"string"},"part_of_speech":{"description":"Part of speech of the form.","example":"NOUN","oneOf":[{"$ref":"#/components/schemas/PartOfSpeech"},{"type":"null"}]},"term_id":{"description":"Unique identifier of the term the form belongs to.","example":"te_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^te_[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}$","type":"string"},"text":{"description":"The form's text.","example":"Kasse","type":"string"},"updated_at":{"description":"Timestamp when the form was last updated.","example":"2025-06-20T14:45:00.123Z","format":"date-time","type":"string"},"usage_status":{"$ref":"#/components/schemas/UsageStatus","description":"How the form should be used.","example":"PREFERRED"}},"required":["case_sensitivity","created_at","form_type","grammatical_gender","grammatical_number","id","inherited_by","language_code","match_expression","matching","object_type","part_of_speech","term_id","text","updated_at","usage_status"],"type":"object"},"TermFormType":{"description":"Lexical type of a term form.","enum":["FULL_FORM","ACRONYM","ABBREVIATION","SHORT_FORM","VARIANT","PHRASE"],"type":"string"},"TermType":{"description":"Whether a term is translated:\n  - TRANSLATABLE: the term is translated; each of its forms belongs to a language.\n  - UNTRANSLATABLE: the term stays as it is in every language (a brand or product name); its forms have no language.\n","enum":["TRANSLATABLE","UNTRANSLATABLE"],"type":"string"},"TextAction":{"description":"Manual workflow action. Source texts support APPROVE and REOPEN; targets support all actions. An action changes the status only and does not check the content: a text without content can be approved.","enum":["APPROVE","REOPEN","MARK_TRANSLATED","REJECT"],"type":"string"},"TextDirection":{"description":"The writing direction of a locale:\n  - LTR: left-to-right (e.g. English, German)\n  - RTL: right-to-left (e.g. Arabic, Hebrew)\n","enum":["LTR","RTL"],"type":"string"},"TextStage":{"description":"The high-level workflow stage that groups one or more `TextStatus` values:\n  - `NOT_READY` — blocked segments\n  - `NEEDS_EDIT` — new, draft, stale or rejected segments\n  - `NEEDS_REVIEW` — AI-translated, translated, QA-passed or QA-flagged segments\n  - `DONE` — approved or not-translatable segments","enum":["NOT_READY","NEEDS_EDIT","NEEDS_REVIEW","DONE"],"type":"string"},"TextStatus":{"description":"The workflow status of texts in a given language. Each status belongs to exactly one `TextStage` (see the `stage` grouping in the status counts).","enum":["BLOCKED","NEW","STALE","REJECTED","DRAFT","AI_TRANSLATED","TRANSLATED","QA_PASSED","QA_FLAGGED","APPROVED","NOT_TRANSLATABLE"],"type":"string"},"TextUpdateMode":{"description":"When an import may change an existing text: `ALWAYS` overwrites it, `ONLY_EMPTY` only fills it when it's empty, `NEVER` keeps it.","enum":["ALWAYS","ONLY_EMPTY","NEVER"],"type":"string"},"TextVariant":{"description":"One variant of a text: its content for a device and a plural form.","properties":{"content":{"description":"The text, with its placeholders and markup.","example":"Sign in","type":"string"},"device":{"$ref":"#/components/schemas/VariantDevice","description":"Device the variant is for.","example":"OTHER"},"plural_form":{"$ref":"#/components/schemas/VariantPluralForm","description":"Plural form of the variant; a segment without plural forms has OTHER only.","example":"OTHER"}},"required":["content","device","plural_form"],"type":"object"},"TransferContentIntegration":{"additionalProperties":false,"description":"Request body to pull or push resources through the existing content integration.","properties":{"language_codes":{"description":"Language selection from the current default branch. Null or an empty list uses all eligible languages according to the provider workflow. Duplicate codes are rejected.","example":["de"],"items":{"type":"string"},"maxItems":1000,"minItems":0,"type":["array","null"]},"resource_ids":{"description":"Resource selection in the project's current default branch. Null or an empty list selects all eligible resources, preserving the provider workflow. Duplicate identities are rejected.","example":["rc_0197c8f2-5a6b-7cde-8f12-3456789abcde"],"items":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a resource container, a valid value would be : rc_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^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}$","type":"string"},"maxItems":1000,"minItems":0,"type":["array","null"]}},"type":"object"},"TransitionSegment":{"additionalProperties":false,"description":"Request body to change the status of the segment's text in one language.","properties":{"action":{"$ref":"#/components/schemas/TextAction","description":"APPROVE approves the text and dismisses its quality findings, REOPEN reopens it, MARK_TRANSLATED marks a translation as translated, REJECT rejects a translation. The source text takes only APPROVE and REOPEN.","example":"APPROVE"},"language_code":{"description":"Language of the text, one of the stack's languages.","example":"de","type":"string"}},"required":["action","language_code"],"type":"object"},"TransitionSegmentsBulk":{"additionalProperties":false,"description":"Request body to change the status of up to 150 texts of a branch.","properties":{"items":{"description":"The status changes, each text once.","example":[{"action":"APPROVE","language_code":"de","segment_id":"seg_0197c8f2-5a6b-7cde-8f12-3456789abcde"}],"items":{"$ref":"#/components/schemas/BulkTransitionSegmentItem"},"maxItems":150,"minItems":1,"type":"array"}},"required":["items"],"type":"object"},"TranslateLina":{"additionalProperties":false,"description":"Request body to translate plain texts with a LINA, outside any project. At most 16,384 characters in total.","properties":{"source_language_code":{"description":"Language of the texts; a supported locale.","example":"en","type":"string"},"target_language_code":{"description":"Language to translate into; a supported locale other than the source.","example":"de","type":"string"},"texts":{"description":"One to ten plain texts; `results[i]` of the response belongs to `texts[i]`. Whitespace is kept, and no file format or placeholders are assumed. The same text may be listed more than once.","example":["Hello","Checkout"],"items":{"maxLength":4096,"minLength":0,"type":"string"},"maxItems":10,"minItems":1,"type":"array"}},"required":["source_language_code","target_language_code","texts"],"type":"object"},"UpdateBranch":{"additionalProperties":false,"description":"Request body to partially update a branch (PATCH, JSON merge-patch). Only fields present in the request body are changed; an omitted `name` is left unchanged. `name` cannot be null.","properties":{"name":{"description":"Display name of the branch; unique in the project.","example":"feature/checkout-v2","maxLength":4096,"minLength":1,"type":"string"}},"type":"object"},"UpdateContentIntegration":{"additionalProperties":false,"description":"Request body to change which content a project syncs with its content platform (JSON merge-patch).","properties":{"path_filters":{"description":"The content the project syncs, replaced as a whole; empty for none. A change starts a sync of the default branch.","example":[{"type":"INCLUDE","value":"**"}],"items":{"$ref":"#/components/schemas/SetContentFilter"},"maxItems":1000,"type":"array"}},"type":"object"},"UpdateContextImage":{"additionalProperties":false,"description":"Request body to partially update a context image (PATCH, JSON merge-patch). Only fields present in the request body are changed; omitted fields are left unchanged and an explicit `description: null` clears the description. `name` cannot be null.","properties":{"description":{"description":"Description of what the image shows. An explicit null clears it.","example":"Screenshot of the checkout screen showing the payment options.","maxLength":4096,"type":["string","null"]},"name":{"description":"Display name of the context image. It can't be empty.","example":"checkout-screen.png","maxLength":4096,"minLength":1,"type":"string"}},"type":"object"},"UpdateCsvFileFormat":{"additionalProperties":false,"description":"Changes how CSV files are read and written, field by field.","properties":{"delimiter":{"description":"The character between the columns.","example":";","minLength":1,"type":"string"},"description_header":{"description":"The header of the column with the descriptions. Null: imports take the column headed Description or Comment, and exports leave the header empty.","example":"description","type":["string","null"]},"is_import_detection_enabled":{"description":"Let imports update detected CSV settings.","example":true,"type":"boolean"},"is_status_exported":{"description":"Include status information in CSV output.","example":false,"type":"boolean"},"key_header":{"description":"The header of the column with the keys. Null: imports take the column headed Title, Key or Id, and exports leave the header empty.","example":"key","type":["string","null"]},"quote":{"description":"The character that encloses a value.","example":"\"","minLength":1,"type":"string"}},"type":"object"},"UpdateEscapeFileFormat":{"additionalProperties":false,"description":"Changes how special characters are written.","properties":{"is_character_escaping_enabled":{"description":"Escape output characters.","example":true,"type":"boolean"}},"type":"object"},"UpdateGeneralFileFormat":{"additionalProperties":false,"description":"Changes the options every file format uses, field by field.","properties":{"charset":{"$ref":"#/components/schemas/FileCharset","description":"The character encoding of exported files.","example":"UTF_8"},"comment_languages":{"description":"Which exported files carry comments; null: no file does.","example":"SOURCE","oneOf":[{"$ref":"#/components/schemas/CommentLanguages"},{"type":"null"}]},"file_name_languages":{"$ref":"#/components/schemas/FileNameLanguages","description":"Which exported files carry their language code in the file name or path.","example":"ALL"},"indentation":{"description":"Spaces per indentation level, 0 to 100; null uses 2.","example":2,"format":"int32","maximum":100,"minimum":0,"type":["integer","null"]},"is_final_newline_enabled":{"description":"End output in a newline.","example":true,"type":"boolean"},"is_source_used_when_missing":{"description":"Use source content when supported.","example":true,"type":"boolean"}},"type":"object"},"UpdateGitPush":{"additionalProperties":false,"description":"How LingoHub pushes (JSON merge-patch).","properties":{"auto_push_default_branch_type":{"$ref":"#/components/schemas/GitAutoPushType","description":"How the default branch is pushed when its translations are complete.","example":"PULL_REQUEST"},"auto_push_other_branches_type":{"$ref":"#/components/schemas/GitAutoPushType","description":"How other branches are pushed when their translations are complete.","example":"PUSH"},"commit_description":{"description":"Commit description template; may be empty.","example":"Translations from LingoHub","maxLength":16384,"type":"string"},"commit_message":{"description":"Commit message template.","example":"Update translations","maxLength":16384,"minLength":1,"type":"string"},"pull_request_branch":{"description":"Template of the branch a pull request comes from.","example":"lingohub/translations_{base_branch}","maxLength":16384,"minLength":1,"type":"string"},"pull_request_description":{"description":"Pull request description template; may be empty.","example":"Translations from LingoHub","maxLength":16384,"type":"string"},"pull_request_title":{"description":"Pull request title template.","example":"Update translations","maxLength":16384,"minLength":1,"type":"string"},"push_type":{"$ref":"#/components/schemas/PushType","description":"Whether a push commits to the branch or opens a pull request.","example":"PULL_REQUEST"}},"type":"object"},"UpdateGitSelection":{"additionalProperties":false,"description":"Which files and branches LingoHub syncs (JSON merge-patch; lists are replaced as a whole). Branch filters exist only while branching: turning branching off drops them.","properties":{"branch_filters":{"description":"The remote branches LingoHub keeps a branch for; only while branching. New branch filters add or remove the branches they select.","example":[{"type":"INCLUDE","value":"locales/**"}],"items":{"$ref":"#/components/schemas/SetGitFilter"},"maxItems":1000,"type":"array"},"is_branching":{"description":"Whether LingoHub keeps a branch for every remote branch `branch_filters` select. Turning it off deletes every branch except the default one.","example":true,"type":"boolean"},"path_filters":{"description":"The files LingoHub syncs; empty for none. New path filters start an import on every branch.","example":[{"type":"INCLUDE","value":"locales/**"}],"items":{"$ref":"#/components/schemas/SetGitFilter"},"maxItems":1000,"type":"array"}},"type":"object"},"UpdateGitSync":{"additionalProperties":false,"description":"When LingoHub pulls and pushes by itself (JSON merge-patch). A schedule exists only for a `PERIODIC` mode: entering `PERIODIC` needs one, leaving it drops it.","properties":{"export_mode":{"$ref":"#/components/schemas/GitExportMode","description":"When LingoHub pushes by itself.","example":"ON_COMPLETION"},"export_schedule":{"description":"When LingoHub pushes; required for `PERIODIC`, null otherwise.","oneOf":[{"$ref":"#/components/schemas/SetGitSchedule"},{"type":"null"}]},"import_mode":{"$ref":"#/components/schemas/GitImportMode","description":"When LingoHub pulls by itself.","example":"PERIODIC"},"import_schedule":{"description":"When LingoHub pulls; required for `PERIODIC`, null otherwise.","oneOf":[{"$ref":"#/components/schemas/SetGitSchedule"},{"type":"null"}]}},"type":"object"},"UpdateGlossary":{"additionalProperties":false,"description":"Request body to change a glossary with JSON merge-patch: a field left out keeps its value, and `language_codes` replaces the whole list. Neither field can be null.","properties":{"language_codes":{"description":"Languages the glossary covers, each once, replacing the current list; every one a supported locale (GET /v2/locales lists them).","example":["en","de"],"items":{"example":"de","type":"string"},"type":"array","uniqueItems":true},"name":{"description":"Name of the glossary.","example":"My Updated Glossary","maxLength":1000,"minLength":2,"type":"string"}},"type":"object"},"UpdateI18nextFileFormat":{"additionalProperties":false,"description":"Changes how i18next JSON files are read and written, field by field.","properties":{"is_base_plural_exported":{"description":"Include base plural keys.","example":false,"type":"boolean"},"version":{"$ref":"#/components/schemas/I18nextVersion","description":"The i18next JSON version of the files.","example":"VERSION_4"}},"type":"object"},"UpdateIntegrationAuthentication":{"additionalProperties":false,"description":"Request body to rename a stored authentication. Omitted name leaves it unchanged; null is not accepted. Credentials and provider lifecycle are unchanged.","properties":{"name":{"description":"Authentication display name.","example":"Localization credentials","maxLength":255,"minLength":1,"type":"string"}},"type":"object"},"UpdateJsonFileFormat":{"additionalProperties":false,"description":"Changes how JSON files are laid out, field by field.","properties":{"is_array_indentation_enabled":{"description":"Indent JSON arrays.","example":false,"type":"boolean"},"is_plural_order_alphabetical":{"description":"Order plural forms alphabetically.","example":false,"type":"boolean"}},"type":"object"},"UpdateKey":{"additionalProperties":false,"description":"Request body to rename a key with JSON merge-patch.","properties":{"group_key":{"description":"The group, in formats with one group only (`key_type` REQUIRED_KEY_WITH_GROUP: PO, Qt TS, INI, Twine). Leaving it out keeps the group; null removes it.","example":"checkout","maxLength":50000,"type":["string","null"]},"key":{"description":"The full key, as the Key object shows it and createKey takes it. At most 128 parts and 49,999 characters as stored, with the group; a longer existing key can be sent back unchanged. Leaving it out keeps the key; null isn't accepted.","example":"navigation.log_in","maxLength":100256,"minLength":1,"type":"string"}},"type":"object"},"UpdateLabel":{"additionalProperties":false,"description":"Request body to partially update a label (PATCH, JSON merge-patch). Omitted fields are left unchanged. `ai_context` may be set to null to clear it; `name` and `color` cannot be null.","properties":{"ai_context":{"description":"Tells LINA what segments with this label are about. A LINA with an AI engine reads it when its `context.is_labels_enabled` is on; LingoHub-managed LINAs always do. Null clears it.","example":"Short, catchy texts for marketing campaigns","maxLength":256,"type":["string","null"]},"color":{"description":"Hex color code of the label (e.g., #FF5733).","example":"#FF5733","pattern":"#[0-9a-fA-F]{6}","type":"string"},"name":{"description":"Display name of the label. Must be unique within the workspace (case-insensitive).","example":"Marketing","maxLength":255,"minLength":2,"type":"string"}},"type":"object"},"UpdateLina":{"additionalProperties":false,"description":"Request body to change a LINA with JSON merge-patch: a field left out keeps its value, `null` clears a nullable field and lists replace the whole list.","properties":{"color":{"description":"Color of the LINA's icon, as a hexadecimal RGB value.","example":"#C084FC","pattern":"^#[0-9A-Fa-f]{6}$","type":"string"},"context":{"$ref":"#/components/schemas/UpdateLinaContext","description":"Which context the LINA sends along with each text; a source left out keeps its value.","example":{}},"description":{"description":"Description of the LINA; null clears it.","example":"Product translator","maxLength":1024,"type":["string","null"]},"glossary_id":{"description":"Glossary of the workspace the LINA uses for translation and for the terminology check; null: none.","example":"gls_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^gls_[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}$","type":["string","null"]},"is_tm_match_enabled":{"description":"Whether the LINA reuses a translation-memory match with exactly the same source text instead of translating it.","example":false,"type":"boolean"},"language_engine_overrides":{"description":"Engines the LINA uses for single target languages, replacing the current list; one per language. Can't be set for a LingoHub-managed LINA.","example":[{"language_code":"de","linguistic_engine_id":"engine_0197c8f2-5a6b-7cde-8f12-3456789abcde"}],"items":{"$ref":"#/components/schemas/SetLinaLanguageEngine"},"maxItems":1000,"type":"array"},"linguistic_engine_id":{"description":"Engine the LINA translates with; it must be enabled in the workspace. Can't be changed for a LingoHub-managed LINA.","example":"engine_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^engine_[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}$","type":"string"},"name":{"description":"Name of the LINA; it must stay unique in the workspace, ignoring case.","example":"Localization","maxLength":255,"minLength":1,"type":"string"},"restricted_stack_ids":{"description":"Stacks of the workspace the LINA may work in, replacing the current list; an empty list allows none. null: every stack.","example":["stack_0197c8f2-5a6b-7cde-8f12-3456789abcde"],"items":{"maxLength":1000,"minLength":0,"pattern":"^stack_[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}$","type":"string"},"maxItems":1000,"type":["array","null"],"uniqueItems":true},"style_guide_id":{"description":"Style guide of the workspace the LINA follows when translating and for the style checks; null: none.","example":"sg_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^sg_[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}$","type":["string","null"]}},"type":"object"},"UpdateLinaContext":{"additionalProperties":false,"description":"Request body to change the context a LINA sends along with each text.","properties":{"is_glossary_enabled":{"description":"Send the terms of the LINA's glossary.","example":false,"type":"boolean"},"is_labels_enabled":{"description":"Send the labels of the segment.","example":false,"type":"boolean"},"is_segments_enabled":{"description":"Send the description of the segment.","example":false,"type":"boolean"},"is_style_guide_enabled":{"description":"Send the rules of the LINA's style guide.","example":false,"type":"boolean"},"is_translation_memory_enabled":{"description":"Send similar translations from the translation memory.","example":false,"type":"boolean"}},"type":"object"},"UpdateLinaQualityRuleSettings":{"additionalProperties":false,"description":"Request body to change one quality-check rule; a field left out keeps its value.","properties":{"is_enabled":{"description":"Whether the rule runs.","example":true,"type":"boolean"},"severity":{"$ref":"#/components/schemas/QualityCheckSeverity","description":"How severe the rule's findings are.","example":"WARNING"}},"type":"object"},"UpdateLinaQualityRules":{"additionalProperties":false,"description":"Request body to change quality-check rules; a rule left out keeps its settings.","properties":{"duplication":{"$ref":"#/components/schemas/UpdateLinaQualityRuleSettings","description":"Changes to the duplication rule.","example":{"is_enabled":true}},"length_constraints":{"$ref":"#/components/schemas/UpdateLinaQualityRuleSettings","description":"Changes to the length constraints rule.","example":{"is_enabled":true}},"locale_formatting":{"$ref":"#/components/schemas/UpdateLinaQualityRuleSettings","description":"Changes to the locale formatting rule.","example":{"is_enabled":true}},"markup":{"$ref":"#/components/schemas/UpdateLinaQualityRuleSettings","description":"Changes to the markup rule.","example":{"is_enabled":true}},"placeholders":{"$ref":"#/components/schemas/UpdateLinaQualityRuleSettings","description":"Changes to the placeholders rule.","example":{"is_enabled":true}},"punctuation":{"$ref":"#/components/schemas/UpdateLinaQualityRuleSettings","description":"Changes to the punctuation rule.","example":{"is_enabled":true}},"quotes_and_delimiters":{"$ref":"#/components/schemas/UpdateLinaQualityRuleSettings","description":"Changes to the quotes and delimiters rule.","example":{"is_enabled":true}},"terminology":{"$ref":"#/components/schemas/UpdateLinaQualityRuleSettings","description":"Changes to the terminology rule.","example":{"is_enabled":true}},"untranslated":{"$ref":"#/components/schemas/UpdateLinaQualityRuleSettings","description":"Changes to the untranslated rule.","example":{"is_enabled":true}},"whitespace":{"$ref":"#/components/schemas/UpdateLinaQualityRuleSettings","description":"Changes to the whitespace rule.","example":{"is_enabled":true}}},"type":"object"},"UpdateLinaQualitySettings":{"additionalProperties":false,"description":"Request body to change a LINA's quality-check settings with JSON merge-patch: a rule or field left out keeps its value, and `translatable_html_attributes` replaces the whole list.","properties":{"is_html_attribute_check_enabled":{"description":"Whether the markup checks inspect the values of HTML attributes.","example":true,"type":"boolean"},"rules":{"$ref":"#/components/schemas/UpdateLinaQualityRules","description":"Rules to change; a rule left out keeps its settings.","example":{"terminology":{"severity":"ERROR"}}},"translatable_html_attributes":{"description":"Names of the HTML attributes whose values are translated, replacing the current list; each name once.","example":["alt","title"],"items":{"minLength":1,"type":"string"},"type":"array","uniqueItems":true}},"type":"object"},"UpdateMember":{"additionalProperties":false,"description":"Request body to update a non-owner workspace member's role while preserving explicit stack assignments.","properties":{"workspace_role_id":{"description":"Existing non-owner workspace role. Omission preserves the current role; null is not allowed.","example":"rol_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^rol_[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}$","type":"string"}},"type":"object"},"UpdateProject":{"additionalProperties":false,"description":"Request body to partially update a LingoHub project (PATCH, JSON merge-patch). Omitted fields are left unchanged. `ai_context` and `website` may be set to null to clear them; `name` and `color` cannot be null.","properties":{"ai_context":{"description":"Context that tells LINA what the project is about; LINA gets it together with the stack's context. `null` removes it.","example":"Updated project context.","maxLength":512,"type":["string","null"]},"color":{"description":"Hex color code of the project icon.","example":"#FF5733","pattern":"#[0-9a-fA-F]{6}","type":"string"},"name":{"description":"The name of the project, 2 to 255 characters.","example":"My Updated Project","maxLength":255,"minLength":2,"type":"string"},"website":{"description":"A website for the project, at most 256 characters. `null` removes it.","example":"www.lingohub.com","maxLength":256,"type":["string","null"]}},"type":"object"},"UpdateProjectExportSettings":{"additionalProperties":false,"description":"Changes the export defaults.","properties":{"html_encoding":{"$ref":"#/components/schemas/HtmlEncoding","description":"How exports write HTML in the formats that support it.","example":"CDATA"},"is_not_translatable_skipped":{"description":"Whether exports exclude not-translatable entries.","example":false,"type":"boolean"},"source_empty_content_handling":{"$ref":"#/components/schemas/BlankContentHandling","description":"What an export does with an empty source text.","example":"KEEP"},"source_statuses":{"description":"The statuses a source text needs to be exported.","example":["APPROVED"],"items":{"$ref":"#/components/schemas/TextStatus"},"maxItems":150,"type":"array"},"target_empty_content_handling":{"$ref":"#/components/schemas/BlankContentHandling","description":"What an export does with an empty target text.","example":"SKIP"},"target_statuses":{"description":"The statuses a target text needs to be exported.","example":["APPROVED"],"items":{"$ref":"#/components/schemas/TextStatus"},"maxItems":150,"type":"array"}},"type":"object"},"UpdateProjectFormatSettings":{"additionalProperties":false,"description":"The options of the project's file format, in sections. Which sections a project needs depends on its type: `general` for every file-based type except DOCUMENT; `csv` for STANDARD_CSV, SINGLE_LANGUAGE_CSV and KEY_VALUE_CSV; `escape` for STANDARD_PROPERTIES and STANDARD_INI; `json` for STANDARD_ARB, STANDARD_JSON, ANGULAR_TRANSLATE_JSON, CHROME_I18N_JSON, GO_I18N_JSON, I18NEXT_JSON, REACT_INTL_JSON and VUE_I18N_JSON; `i18next_json` for I18NEXT_JSON; `xliff` for STANDARD_XLIFF; `properties` for STANDARD_PROPERTIES. A section the type doesn't need has no effect.","properties":{"csv":{"description":"CSV options; changed field by field, null removes them.","oneOf":[{"$ref":"#/components/schemas/UpdateCsvFileFormat"},{"type":"null"}]},"escape":{"description":"Escaping options; changed field by field, null removes them.","oneOf":[{"$ref":"#/components/schemas/UpdateEscapeFileFormat"},{"type":"null"}]},"general":{"$ref":"#/components/schemas/UpdateGeneralFileFormat","description":"Options every file format uses; changed field by field."},"i18next_json":{"description":"i18next options; changed field by field, null removes them.","oneOf":[{"$ref":"#/components/schemas/UpdateI18nextFileFormat"},{"type":"null"}]},"json":{"description":"JSON options; changed field by field, null removes them.","oneOf":[{"$ref":"#/components/schemas/UpdateJsonFileFormat"},{"type":"null"}]},"properties":{"description":"Properties options; changed field by field, null removes them.","oneOf":[{"$ref":"#/components/schemas/UpdatePropertiesFileFormat"},{"type":"null"}]},"xliff":{"description":"XLIFF options; changed field by field, null removes them.","oneOf":[{"$ref":"#/components/schemas/UpdateXliffFileFormat"},{"type":"null"}]}},"type":"object"},"UpdateProjectGitIntegration":{"additionalProperties":false,"description":"Request body to change a project's git integration (JSON merge-patch): send only what changes. A new connection, repository or `git_branch` is checked with the git host, as when connecting the project.","properties":{"git_authentication_id":{"description":"A git connection from listIntegrationAuthentications.","example":"iau_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^iau_[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}$","type":"string"},"git_branch":{"description":"The remote branch the project's default branch syncs with; the default branch is renamed after it.","example":"main","maxLength":255,"minLength":1,"type":"string"},"name":{"description":"The repository's name.","example":"app","maxLength":4096,"minLength":1,"type":"string"},"namespace":{"description":"The repository's namespace, as the repository lookups name it; empty for CodeCommit.","example":"company","maxLength":4096,"type":"string"},"push":{"$ref":"#/components/schemas/UpdateGitPush","description":"How LingoHub pushes."},"selection":{"$ref":"#/components/schemas/UpdateGitSelection","description":"Which files and branches LingoHub syncs."},"sync":{"$ref":"#/components/schemas/UpdateGitSync","description":"When LingoHub pulls and pushes by itself."}},"type":"object"},"UpdateProjectHubSpotIntegration":{"additionalProperties":false,"description":"Request body to change which HubSpot content a project syncs (JSON merge-patch; lists are replaced as a whole).","properties":{"enabled_content_types":{"description":"The kinds of HubSpot content the project syncs. Saved and applied from the next sync.","example":["SITE_PAGE"],"items":{"$ref":"#/components/schemas/HubSpotContentType"},"maxItems":100,"minItems":1,"type":"array"},"path_filters":{"description":"The content the project syncs, matched against content paths; empty for none. A change starts a sync of the default branch.","example":[{"type":"INCLUDE","value":"**"}],"items":{"$ref":"#/components/schemas/SetContentFilter"},"maxItems":1000,"type":"array"}},"type":"object"},"UpdateProjectImportSettings":{"additionalProperties":false,"description":"Changes the import defaults.","properties":{"is_source_creation_enabled":{"description":"Whether imports may create source text entries.","example":true,"type":"boolean"},"is_source_deactivation_enabled":{"description":"Whether imports may deactivate source entries missing from the input.","example":false,"type":"boolean"},"is_source_metadata_update_enabled":{"description":"Whether imports may update source metadata.","example":true,"type":"boolean"},"is_target_creation_enabled":{"description":"Whether imports may create target text entries.","example":true,"type":"boolean"},"is_target_deactivation_enabled":{"description":"Whether imports may deactivate target entries missing from the input.","example":false,"type":"boolean"},"is_target_metadata_update_enabled":{"description":"Whether imports may update target metadata.","example":true,"type":"boolean"},"source_text_update_mode":{"$ref":"#/components/schemas/TextUpdateMode","description":"When imports may update an existing source text.","example":"ALWAYS"},"target_text_update_mode":{"$ref":"#/components/schemas/TextUpdateMode","description":"When imports may update an existing target text.","example":"ONLY_EMPTY"}},"type":"object"},"UpdateProjectIntegrationSettings":{"additionalProperties":false,"description":"Changes what a sync of the project's integration deletes; applies from the next sync.","properties":{"is_removed_language_deletion_enabled":{"description":"Whether a sync deletes languages the integration no longer reports. The source language is never deleted. Only Contentful, HubSpot, Storyblok, Stripo and Zendesk integrations read this setting; Git and Crisp integrations never delete languages. Enabled by default for Contentful, Zendesk and Storyblok integrations.","example":false,"type":"boolean"},"is_removed_resource_deletion_enabled":{"description":"Whether a Git repository pull deletes files the repository no longer contains. Only Git integrations read this setting; the other integrations always delete resources a sync no longer reports. Enabled by default for Git integrations.","example":true,"type":"boolean"}},"type":"object"},"UpdateProjectKeySettings":{"additionalProperties":false,"description":"Changes the key normalisation.","properties":{"normalization_strategy":{"$ref":"#/components/schemas/KeyNormalizationStrategy","description":"How keys are normalised when they are imported, created or renamed. Existing keys aren't renamed.","example":"FORMAT_SPECIFIC"}},"type":"object"},"UpdateProjectLanguage":{"additionalProperties":false,"description":"Request body to change a project language (JSON merge-patch). Omitted fields stay unchanged; `file_slug: null` removes the slug. The fallback language and LINA role are set on the stack language with updateStackLanguage.","properties":{"file_slug":{"description":"The language's name in this project's file names, used instead of the language code; null uses the language code.","example":"de_at","maxLength":256,"type":["string","null"]}},"type":"object"},"UpdateProjectPlaceholderSettings":{"additionalProperties":false,"description":"Changes which placeholders are recognised. `default_definitions` and `is_default` are read-only.","properties":{"definitions":{"description":"The placeholder kinds recognised in texts; the first that matches wins. Empty: none. Send `default_definitions` to go back to the defaults.","example":["DEFAULT_ICU","DEFAULT_PRINTF"],"items":{"$ref":"#/components/schemas/PlaceholderDefinition"},"type":"array"}},"type":"object"},"UpdateProjectSettings":{"additionalProperties":false,"description":"Request body to change a project's settings (JSON merge-patch): send only the sections and fields that change, also inside the sections of `format`. Lists are replaced as a whole; null removes a `format` section.","properties":{"export":{"$ref":"#/components/schemas/UpdateProjectExportSettings","description":"Export defaults."},"format":{"description":"File-format options. Null removes them, which only documents and integration projects allow.","oneOf":[{"$ref":"#/components/schemas/UpdateProjectFormatSettings"},{"type":"null"}]},"import":{"$ref":"#/components/schemas/UpdateProjectImportSettings","description":"Import defaults."},"integrations":{"$ref":"#/components/schemas/UpdateProjectIntegrationSettings","description":"Integration settings; only for a project that has an integration."},"keys":{"$ref":"#/components/schemas/UpdateProjectKeySettings","description":"Key normalisation."},"placeholders":{"$ref":"#/components/schemas/UpdateProjectPlaceholderSettings","description":"Placeholder recognition."}},"type":"object"},"UpdatePropertiesFileFormat":{"additionalProperties":false,"description":"Changes how properties files name plural forms.","properties":{"plural_separator":{"description":"The text between a key and its plural form, such as `_` in `apples_one`.","example":"_","type":"string"}},"type":"object"},"UpdateResource":{"additionalProperties":false,"description":"Request body to partially update a resource (PATCH, JSON merge-patch). Only fields present in the request body are changed; omitted fields are left unchanged. Renaming the `path` also moves the resource and its sub-resources within the branch.","properties":{"language_code_separator":{"description":"How the language is joined to the file name: `_`, `-` or `.`; Android XML also accepts `-r`.","enum":["_","-",".","-r"],"example":"-","type":"string"},"path":{"description":"New full path of the resource within the branch: relative, segments separated by `/`, the last one naming the resource. No empty or `..` segment, no segment longer than 255 characters. A file path must retain `%{locale}` somewhere in the path. When its basename combines `%{locale}` with other text, use `%{language_code_separator}` as the separator, for example `messages%{language_code_separator}%{locale}.json`. Keep an extension allowed by the resource's format. A folder path does not need a locale placeholder.","example":"app/src/main/res/%{locale}/strings.xml","maxLength":4096,"minLength":1,"type":"string"}},"type":"object"},"UpdateSegment":{"additionalProperties":false,"description":"Request body to change a segment and its texts with JSON merge-patch. Changes apply to every key of the segment.","properties":{"description":{"description":"Note for translators. A LINA with an AI engine reads it too when its `context.is_segments_enabled` is on; LingoHub-managed LINAs always do. Null clears it.","example":"Label on the sign-in button","type":["string","null"]},"is_not_translatable":{"description":"Whether the segment is excluded from translation.","example":false,"type":"boolean"},"is_plural":{"description":"Whether the segment has plural forms. The formats of all its files must allow it. Becoming singular keeps the OTHER form and removes the other plural forms in all languages.","example":false,"type":"boolean"},"label_ids":{"description":"Replaces the segment's labels with these labels of the workspace; `[]` removes them all. At most 150.","example":["la_0197c8f2-5a6b-7cde-8f12-3456789abcde"],"items":{"example":"la_0197c8f2-5a6b-7cde-8f12-3456789abcde","maxLength":150,"minLength":0,"pattern":"^la_[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}$","type":"string"},"maxItems":150,"type":"array","uniqueItems":true},"texts":{"additionalProperties":{"$ref":"#/components/schemas/UpdateSegmentText"},"description":"The texts to change, by language code; languages left out keep their text. `variants` replaces a language's text, and `[]` clears it.","example":{"de":{"variants":[{"content":"Anmelden"}]}},"type":"object"}},"type":"object"},"UpdateSegmentText":{"additionalProperties":false,"description":"Request body part that replaces the text of a segment in one language.","properties":{"is_minor_update":{"default":false,"description":"Whether the change is minor, such as a typo fix: the status automations for minor edits apply, so the translations of a changed source text can stay as they are. Defaults to false.","example":false,"type":["boolean","null"]},"variants":{"description":"The new text, one variant per device and plural form, in this order. It replaces the language's text; `[]` clears it. At most 1,000 variants.","example":[{"content":"Anmelden"}],"items":{"$ref":"#/components/schemas/WriteTextVariant"},"maxItems":1000,"minItems":0,"type":"array"}},"required":["variants"],"type":"object"},"UpdateSegmentsBulk":{"additionalProperties":false,"description":"Request body to change up to 150 segments of a branch.","properties":{"items":{"description":"The segments to change, each once. At most 1,048,576 characters of text in total.","example":[{"segment_id":"seg_0197c8f2-5a6b-7cde-8f12-3456789abcde","texts":{"de":{"variants":[{"content":"Anmelden"}]}}}],"items":{"$ref":"#/components/schemas/BulkUpdateSegmentItem"},"maxItems":150,"minItems":1,"type":"array"}},"required":["items"],"type":"object"},"UpdateStack":{"additionalProperties":false,"description":"Request body to partially update a LingoHub stack (PATCH, JSON merge-patch). Omitted fields are left unchanged; `name` and `color` cannot be null, a null `ai_context` or `lina_id` removes it.","properties":{"ai_context":{"description":"Context that tells LINA what the stack is about, given with the project's own.","example":"Mobile apps for retail banking.","maxLength":512,"type":["string","null"]},"color":{"description":"Hex color code of the stack icon.","example":"#FCAFE3","pattern":"#[0-9a-fA-F]{6}","type":"string"},"lina_id":{"description":"LINA of the workspace to assign to the stack; null removes the assignment. The stack languages keep their `lina_role`.","example":"lina_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^lina_[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}$","type":["string","null"]},"name":{"description":"Display name of the stack.","example":"My Changed Stack","maxLength":999,"minLength":2,"type":"string"}},"type":"object"},"UpdateStackLanguage":{"additionalProperties":false,"description":"Request body to change a stack language (JSON merge-patch). Omitted fields stay unchanged; `lina_role` can't be null, `fallback_language_code: null` removes the fallback.","properties":{"fallback_language_code":{"description":"The language used when a translation in this language is missing: another language of the stack, without loops. It applies to every project of the stack; `null` removes it.","example":"de","type":["string","null"]},"lina_role":{"$ref":"#/components/schemas/LanguageLinaRole","description":"What the stack's LINA does in this language. Has no effect while the stack has no LINA.","example":"TRANSLATOR"}},"type":"object"},"UpdateStackMember":{"additionalProperties":false,"description":"Request body to merge an existing stack assignment's role and explicit language permissions.","properties":{"language_permissions":{"additionalProperties":{"oneOf":[{"$ref":"#/components/schemas/StackMemberLanguagePermission"},{"type":"null"}]},"description":"Map entries are merged, not replaced. Omission or an empty map preserves explicit rows; a null value removes that locale's explicit row. The map itself cannot be null. This describes stored configuration, not effective access.","example":{"de":"READ_ACCESS","fr":null},"maxProperties":1000,"type":"object"},"stack_role_id":{"description":"Existing non-owner stack role. Omission preserves it; null is invalid.","example":"stackr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stackr_[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}$","type":"string"}},"type":"object"},"UpdateStyleGuide":{"additionalProperties":false,"description":"Request body to partially update a LingoHub style guide (PATCH, JSON merge-patch). Omitted fields are left unchanged. `name` and `rules` cannot be null; `ai_context` and `audience_description` may be set to null to clear them, and each rule inside `rules` may be set to null to reset it to `NOT_SPECIFIED`.","properties":{"ai_context":{"description":"Additional context provided to the AI to guide translation style and tone.","example":"Translate in a friendly and approachable tone suitable for a SaaS product.","maxLength":512,"type":["string","null"]},"audience_description":{"description":"Description of the target audience for this style guide.","example":"Software developers and technical users familiar with localization workflows.","maxLength":16384,"type":["string","null"]},"name":{"description":"Display name of the style guide.","example":"Workspace Style Guide","maxLength":128,"minLength":2,"type":"string"},"rules":{"$ref":"#/components/schemas/UpdateStyleGuideRules","description":"Style rules to change (JSON merge-patch): omitted rules are left unchanged, a rule set to null is reset to NOT_SPECIFIED."}},"type":"object"},"UpdateStyleGuideRules":{"additionalProperties":false,"description":"Style rules to change (JSON merge-patch): omitted rules are left unchanged, a rule set to null is reset to NOT_SPECIFIED.","properties":{"age_group":{"description":"Target age group for translation style and vocabulary choice.","example":"ADULTS","oneOf":[{"$ref":"#/components/schemas/StyleGuideAgeGroup"},{"type":"null"}]},"audience":{"description":"Target audience for translation style and vocabulary choice.","example":"DEVELOPERS","oneOf":[{"$ref":"#/components/schemas/StyleGuideAudience"},{"type":"null"}]},"domain":{"description":"Content domain to guide context-specific AI behavior.","example":"TECHNOLOGY","oneOf":[{"$ref":"#/components/schemas/StyleGuideDomain"},{"type":"null"}]},"formality":{"description":"Desired level of formality for translated text.","example":"FORMAL","oneOf":[{"$ref":"#/components/schemas/StyleGuideFormality"},{"type":"null"}]},"grammatical_person":{"description":"Grammatical person to use for translated text.","example":"SECOND_PERSON_SINGULAR","oneOf":[{"$ref":"#/components/schemas/StyleGuideGrammaticalPerson"},{"type":"null"}]},"language_complexity":{"description":"Desired level of language complexity for generated text.","example":"STANDARD","oneOf":[{"$ref":"#/components/schemas/StyleGuideLanguageComplexity"},{"type":"null"}]},"literal_translation":{"description":"Specifies how literally the source text should be translated.","example":"NEUTRAL","oneOf":[{"$ref":"#/components/schemas/StyleGuideLiteralTranslation"},{"type":"null"}]},"text_type":{"description":"Type of text being translated.","example":"SOFTWARE_UI","oneOf":[{"$ref":"#/components/schemas/StyleGuideTextType"},{"type":"null"}]},"vocabulary_type":{"description":"Type of vocabulary to guide AI word choice.","example":"TECHNICAL","oneOf":[{"$ref":"#/components/schemas/StyleGuideVocabularyType"},{"type":"null"}]},"voice":{"description":"Preferred grammatical voice for translated text.","example":"ACTIVE","oneOf":[{"$ref":"#/components/schemas/StyleGuideVoice"},{"type":"null"}]}},"type":"object"},"UpdateTerm":{"additionalProperties":false,"description":"Request body to partially update a term (JSON merge-patch). Omitted fields are left unchanged. The forms have their own endpoints.","properties":{"ai_context":{"description":"Context for AI translation. Null clears it.","example":"Final step of the purchase flow.","maxLength":256,"type":["string","null"]},"enforcement_status":{"$ref":"#/components/schemas/EnforcementStatus","description":"How strictly the term is applied.","example":"INFORMATIONAL"}},"type":"object"},"UpdateTermForm":{"additionalProperties":false,"description":"Request body to change a term form with JSON merge-patch: a field left out keeps its value, null clears a nullable field. The language of a form cannot change: add a form in the other language and delete this one instead.","properties":{"case_sensitivity":{"$ref":"#/components/schemas/CaseSensitivity","description":"How the form is matched with regard to case.","example":"SENSITIVE"},"form_type":{"description":"Lexical type of the form. Null clears it.","example":"FULL_FORM","oneOf":[{"$ref":"#/components/schemas/TermFormType"},{"type":"null"}]},"grammatical_gender":{"description":"Grammatical gender of the form. Null clears it.","example":"FEMININE","oneOf":[{"$ref":"#/components/schemas/GrammaticalGender"},{"type":"null"}]},"grammatical_number":{"description":"Grammatical number of the form. Null clears it.","example":"SINGULAR","oneOf":[{"$ref":"#/components/schemas/GrammaticalNumber"},{"type":"null"}]},"inherited_by":{"description":"Languages of the glossary without a form of their own that use this form. Replaces the current list; only for the preferred form of a translatable term. A language removed from the list keeps a copy of the form.","example":["de-AT","de-CH"],"items":{"example":"de-AT","maxLength":100,"minLength":0,"type":"string"},"maxItems":100,"type":"array"},"match_expression":{"description":"The regular expression a `CUSTOM` matching uses. Null clears it.","example":"Kasse[n]?","maxLength":256,"type":["string","null"]},"matching":{"$ref":"#/components/schemas/Matching","description":"How the form is matched against text; `AUTOMATIC` only for languages that support it, also the inheriting ones.","example":"AUTOMATIC"},"part_of_speech":{"description":"Part of speech of the form. Null clears it.","example":"NOUN","oneOf":[{"$ref":"#/components/schemas/PartOfSpeech"},{"type":"null"}]},"text":{"description":"The form's text.","example":"Kasse","maxLength":4096,"minLength":1,"type":"string"},"usage_status":{"$ref":"#/components/schemas/UsageStatus","description":"How the form should be used.","example":"NOT_RECOMMENDED"}},"type":"object"},"UpdateWebhookEndpoint":{"additionalProperties":false,"description":"Request body to change a webhook endpoint. Omitted fields stay unchanged; null clears description or scope. To move the endpoint between a stack and a project, send the new id and null for the old one. event_types replaces the whole list.","properties":{"description":{"description":"Description of the endpoint; null clears it.","example":"Localization notifications","maxLength":4096,"type":["string","null"]},"event_types":{"description":"Events to receive, replacing the whole list, as listed by listWebhookEventTypes, or [\"*\"] for all events.","example":["project.created"],"items":{"example":"project.created","minLength":1,"type":"string"},"minItems":1,"type":"array"},"project_id":{"description":"Limits deliveries to the events of this project; null clears it. At most one of stack_id and project_id.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":["string","null"]},"stack_id":{"description":"Limits deliveries to the events of this stack and its projects; null clears it. At most one of stack_id and project_id.","example":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stack_[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}$","type":["string","null"]},"url":{"description":"Public HTTPS address deliveries are sent to; checked as on create.","example":"https://example.com/hooks","maxLength":2048,"minLength":1,"type":"string"}},"type":"object"},"UpdateWorkspaceApiKey":{"additionalProperties":false,"description":"Request body to partially update active workspace-managed key metadata without changing its permissions or ownership.","properties":{"description":{"description":"Optional description; null clears it.","example":"CI import key","maxLength":4096,"type":["string","null"]},"expiration_date":{"description":"Last valid day, inclusive, in UTC. Null means no configured expiration.","example":"2027-01-31","format":"date","type":["string","null"]},"name":{"description":"Display name, unique among workspace-managed keys.","example":"Automation","maxLength":4096,"type":"string"}},"type":"object"},"UpdateXliffFileFormat":{"additionalProperties":false,"description":"Changes how XLIFF files identify keys and languages, field by field.","properties":{"is_multi_language":{"description":"File contains multiple languages.","example":false,"type":"boolean"},"is_resname_identifier":{"description":"Use resname for segment identity.","example":false,"type":"boolean"}},"type":"object"},"UsageStatus":{"description":"How a term form should be used:\n  - PREFERRED: the recommended form. A language of a term has at most one preferred form.\n  - ADMITTED: an accepted alternative form.\n  - NOT_RECOMMENDED: a discouraged or deprecated form.\n","enum":["PREFERRED","ADMITTED","NOT_RECOMMENDED"],"type":"string"},"VariantDevice":{"description":"Device of a text variant.","enum":["PHONE","MUSIC_PLAYER","TABLET","WATCH","TV","GLASSES","PC","OTHER"],"type":"string"},"VariantPluralForm":{"description":"Plural form of a text variant.","enum":["ZERO","ONE","TWO","FEW","MANY","OTHER"],"type":"string"},"WebhookDelivery":{"description":"One event sent to one endpoint: its status, attempts, next retry, the last response, and the request that is sent.","properties":{"attempt_count":{"description":"Attempts made so far.","example":2,"format":"int32","type":"integer"},"created_at":{"description":"When the delivery was queued.","example":"2026-09-29T10:00:00.123Z","format":"date-time","type":"string"},"delivered_at":{"description":"When the endpoint accepted the delivery; null until it has.","example":null,"format":"date-time","type":["string","null"]},"event_id":{"description":"The event that is sent; also the webhook-id header of the request.","example":"evt_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^evt_[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}$","type":"string"},"event_type":{"description":"Public event name; null only for an event type this LingoHub version doesn't know yet.","example":"project.created","type":["string","null"]},"id":{"description":"Unique identifier of the webhook delivery.","example":"whd_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^whd_[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}$","type":"string"},"is_exhausted":{"description":"Whether all attempts were used.","example":false,"type":"boolean"},"last_duration_ms":{"description":"How long the last attempt took, in milliseconds.","example":120,"format":"int32","type":["integer","null"]},"last_error":{"description":"Short fixed text explaining why the last attempt failed, such as `non-2xx response: 503` or `The endpoint did not respond in time.`; null when no attempt failed.","example":"non-2xx response: 503","type":["string","null"]},"last_response_body":{"description":"Body of the endpoint's answer to the last failed attempt, cut at 8192 bytes; null when there was none.","example":"Temporarily unavailable","type":["string","null"]},"last_response_status":{"description":"HTTP status the endpoint answered the last attempt with; null without a response.","example":503,"format":"int32","type":["integer","null"]},"max_attempts":{"description":"Attempts the delivery gets before it is given up.","example":8,"format":"int32","type":"integer"},"next_attempt_at":{"description":"When the next attempt is due; null when none is scheduled.","example":"2026-09-29T10:00:00.123Z","format":"date-time","type":["string","null"]},"object_type":{"description":"Always `WEBHOOK_DELIVERY`.","enum":["WEBHOOK_DELIVERY"],"example":"WEBHOOK_DELIVERY","type":"string"},"request":{"$ref":"#/components/schemas/WebhookRequestDetails","description":"The request that is sent, rebuilt on each read from the event and the endpoint's current URL; the signature headers are not shown."},"status":{"$ref":"#/components/schemas/WebhookDeliveryStatus","description":"QUEUED waits for the first attempt or the next retry; PROCESSING is being sent; SUCCEEDED was accepted by the endpoint; FAILED was given up: `is_exhausted` true means all attempts were used, false that it stopped for another reason, e.g. a disabled endpoint.","example":"QUEUED"},"updated_at":{"description":"When the delivery last changed.","example":"2026-09-29T10:00:00.123Z","format":"date-time","type":"string"},"webhook_endpoint_id":{"description":"The endpoint the delivery is sent to.","example":"whe_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^whe_[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}$","type":"string"}},"required":["attempt_count","created_at","delivered_at","event_id","event_type","id","is_exhausted","last_duration_ms","last_error","last_response_body","last_response_status","max_attempts","next_attempt_at","object_type","request","status","updated_at","webhook_endpoint_id"],"type":"object"},"WebhookDeliveryCollection":{"description":"A cursor-paginated collection of webhook delivery resources.","properties":{"data":{"description":"The list of items in this page.","example":[{"attempt_count":2,"created_at":"2026-09-29T10:00:00.123Z","delivered_at":null,"event_id":"evt_0197c8f2-5a6b-7cde-8f12-3456789abcde","event_type":"project.created","id":"whd_0197c8f2-5a6b-7cde-8f12-3456789abcde","is_exhausted":false,"last_duration_ms":120,"last_error":"non-2xx response: 503","last_response_body":"Temporarily unavailable","last_response_status":503,"max_attempts":8,"next_attempt_at":"2026-09-29T10:00:00.123Z","object_type":"WEBHOOK_DELIVERY","request":{"body":"{\"id\":\"evt_0197c8f2-5a6b-7cde-8f12-3456789abcde\",\"type\":\"project.created\",\"api_version\":\"2026-07-01\",\"created_at\":\"2026-09-29T10:00:00.123+00:00\",\"workspace_id\":\"space_0197c8f2-5a6b-7cde-8f12-3456789abcde\",\"data\":{\"id\":\"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde\",\"title\":\"Website\"}}","headers":{"content-type":"application/json","user-agent":"LingoHub-Webhooks/1","webhook-id":"evt_0197c8f2-5a6b-7cde-8f12-3456789abcde"},"url":"https://example.com/lingohub/webhooks"},"status":"QUEUED","updated_at":"2026-09-29T10:00:00.123Z","webhook_endpoint_id":"whe_0197c8f2-5a6b-7cde-8f12-3456789abcde"}],"items":{"$ref":"#/components/schemas/WebhookDelivery"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"WebhookDeliveryFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+webhook_delivery[attempt_count]","-webhook_delivery[attempt_count]","+webhook_delivery[created_at]","-webhook_delivery[created_at]","+webhook_delivery[updated_at]","-webhook_delivery[updated_at]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/WebhookDeliveryFilterGroup"}},"type":"object"},"WebhookDeliveryFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/WebhookDeliveryFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/WebhookDeliveryFilterClause"},"minItems":1,"type":"array"},"webhook_delivery[attempt_count]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"_gt":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"_gte":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"_in":{"items":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"minItems":1,"type":"array"},"_lt":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"_lte":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"_ne":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"_nin":{"items":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"minItems":1,"type":"array"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"webhook_delivery[created_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"webhook_delivery[event_id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^evt_[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}$","type":"string"},"_in":{"items":{"pattern":"^evt_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^evt_[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}$","type":"string"},"_nin":{"items":{"pattern":"^evt_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"webhook_delivery[id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^whd_[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}$","type":"string"},"_in":{"items":{"pattern":"^whd_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^whd_[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}$","type":"string"},"_nin":{"items":{"pattern":"^whd_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"webhook_delivery[status]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["QUEUED","PROCESSING","SUCCEEDED","FAILED"],"type":"string"},"_in":{"items":{"enum":["QUEUED","PROCESSING","SUCCEEDED","FAILED"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["QUEUED","PROCESSING","SUCCEEDED","FAILED"],"type":"string"},"_nin":{"items":{"enum":["QUEUED","PROCESSING","SUCCEEDED","FAILED"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"webhook_delivery[updated_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"}},"type":"object"},"WebhookDeliveryFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/WebhookDeliveryFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/WebhookDeliveryFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"WebhookDeliveryJob":{"description":"A webhook delivery scheduled for asynchronous processing.","properties":{"data":{"$ref":"#/components/schemas/WebhookDelivery","description":"The queued delivery. Poll the Location while QUEUED or PROCESSING; SUCCEEDED and FAILED are terminal."},"job_type":{"description":"Always `WEBHOOK_DELIVERY`.","enum":["WEBHOOK_DELIVERY"],"example":"WEBHOOK_DELIVERY","type":"string"},"object_type":{"description":"Always `JOB`.","enum":["JOB"],"example":"JOB","type":"string"}},"required":["data","job_type","object_type"],"type":"object"},"WebhookDeliveryStatus":{"description":"Public webhook delivery state.","enum":["QUEUED","PROCESSING","SUCCEEDED","FAILED"],"type":"string"},"WebhookEndpoint":{"description":"An address LingoHub sends the subscribed events of one stack, one project or the whole workspace to. The signing secret is never included.","properties":{"api_version":{"description":"Payload format the endpoint was created with.","example":"2026-07-01","type":"string"},"consecutive_failures":{"description":"Failed deliveries in a row since the last success; at 15 the endpoint is switched off.","example":0,"format":"int32","type":"integer"},"created_at":{"description":"When the endpoint was created.","example":"2026-09-29T10:00:00.123Z","format":"date-time","type":"string"},"description":{"description":"Description of the endpoint; null when it has none.","example":"Localization notifications","type":["string","null"]},"disabled_at":{"description":"When the endpoint was switched off; null while it is enabled.","example":null,"format":"date-time","type":["string","null"]},"event_types":{"description":"Subscribed events, as listed by listWebhookEventTypes; [\"*\"] subscribes to all events, including those added later.","example":["project.created"],"items":{"example":"project.created","type":"string"},"type":"array"},"id":{"description":"Unique identifier of the webhook endpoint.","example":"whe_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^whe_[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}$","type":"string"},"last_failure_at":{"description":"When a delivery attempt last failed; null if none has yet.","example":"2026-09-29T10:00:00.123Z","format":"date-time","type":["string","null"]},"last_success_at":{"description":"When a delivery last succeeded; null if none has yet.","example":"2026-09-29T10:00:00.123Z","format":"date-time","type":["string","null"]},"object_type":{"description":"Always `WEBHOOK_ENDPOINT`.","enum":["WEBHOOK_ENDPOINT"],"example":"WEBHOOK_ENDPOINT","type":"string"},"project_id":{"description":"Project whose events the endpoint receives. At most one of stack_id and project_id is set; neither means the whole workspace.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":["string","null"]},"stack_id":{"description":"Stack whose events the endpoint receives, its projects included. At most one of stack_id and project_id is set; neither means the whole workspace.","example":null,"pattern":"^stack_[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}$","type":["string","null"]},"status":{"$ref":"#/components/schemas/WebhookEndpointStatus","description":"ENABLED receives deliveries. DISABLED was switched off by hand. AUTO_DISABLED was switched off by LingoHub after 15 failed deliveries in a row. Both stay off until the endpoint is enabled.","example":"ENABLED"},"updated_at":{"description":"When the endpoint was last changed.","example":"2026-09-29T10:00:00.123Z","format":"date-time","type":"string"},"url":{"description":"Public HTTPS address deliveries are sent to.","example":"https://example.com/lingohub/webhooks","type":"string"}},"required":["api_version","consecutive_failures","created_at","description","disabled_at","event_types","id","last_failure_at","last_success_at","object_type","project_id","stack_id","status","updated_at","url"],"type":"object"},"WebhookEndpointCollection":{"description":"A cursor-paginated collection of webhook endpoint resources.","properties":{"data":{"description":"The list of items in this page.","example":[{"api_version":"2026-07-01","consecutive_failures":0,"created_at":"2026-09-29T10:00:00.123Z","description":"Localization notifications","disabled_at":null,"event_types":["project.created"],"id":"whe_0197c8f2-5a6b-7cde-8f12-3456789abcde","last_failure_at":"2026-09-29T10:00:00.123Z","last_success_at":"2026-09-29T10:00:00.123Z","object_type":"WEBHOOK_ENDPOINT","project_id":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","stack_id":null,"status":"ENABLED","updated_at":"2026-09-29T10:00:00.123Z","url":"https://example.com/lingohub/webhooks"}],"items":{"$ref":"#/components/schemas/WebhookEndpoint"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"WebhookEndpointFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+webhook_endpoint[created_at]","-webhook_endpoint[created_at]","+webhook_endpoint[updated_at]","-webhook_endpoint[updated_at]","+webhook_endpoint[url]","-webhook_endpoint[url]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/WebhookEndpointFilterGroup"}},"type":"object"},"WebhookEndpointFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/WebhookEndpointFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/WebhookEndpointFilterClause"},"minItems":1,"type":"array"},"webhook_endpoint[created_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"webhook_endpoint[description]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"webhook_endpoint[id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^whe_[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}$","type":"string"},"_in":{"items":{"pattern":"^whe_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^whe_[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}$","type":"string"},"_nin":{"items":{"pattern":"^whe_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"webhook_endpoint[project_id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^pr_[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}$","type":"string"},"_in":{"items":{"pattern":"^pr_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^pr_[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}$","type":"string"},"_nin":{"items":{"pattern":"^pr_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"webhook_endpoint[stack_id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^stack_[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}$","type":"string"},"_in":{"items":{"pattern":"^stack_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^stack_[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}$","type":"string"},"_nin":{"items":{"pattern":"^stack_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"webhook_endpoint[status]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["ENABLED","DISABLED","AUTO_DISABLED"],"type":"string"},"_in":{"items":{"enum":["ENABLED","DISABLED","AUTO_DISABLED"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["ENABLED","DISABLED","AUTO_DISABLED"],"type":"string"},"_nin":{"items":{"enum":["ENABLED","DISABLED","AUTO_DISABLED"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"webhook_endpoint[updated_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"webhook_endpoint[url]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"}},"type":"object"},"WebhookEndpointFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/WebhookEndpointFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/WebhookEndpointFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"WebhookEndpointStatus":{"description":"Public webhook endpoint state.","enum":["ENABLED","DISABLED","AUTO_DISABLED"],"type":"string"},"WebhookEndpointWithSecret":{"description":"A webhook endpoint together with its signing secret. Only the response that creates the endpoint or rotates its secret includes the secret.","properties":{"api_version":{"description":"Payload format the endpoint was created with.","example":"2026-07-01","type":"string"},"consecutive_failures":{"description":"Failed deliveries in a row since the last success; at 15 the endpoint is switched off.","example":0,"format":"int32","type":"integer"},"created_at":{"description":"When the endpoint was created.","example":"2026-09-29T10:00:00.123Z","format":"date-time","type":"string"},"description":{"description":"Description of the endpoint; null when it has none.","example":"Localization notifications","type":["string","null"]},"disabled_at":{"description":"When the endpoint was switched off; null while it is enabled.","example":null,"format":"date-time","type":["string","null"]},"event_types":{"description":"Subscribed events, as listed by listWebhookEventTypes; [\"*\"] subscribes to all events, including those added later.","example":["project.created"],"items":{"example":"project.created","type":"string"},"type":"array"},"id":{"description":"Unique identifier of the webhook endpoint.","example":"whe_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^whe_[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}$","type":"string"},"last_failure_at":{"description":"When a delivery attempt last failed; null if none has yet.","example":"2026-09-29T10:00:00.123Z","format":"date-time","type":["string","null"]},"last_success_at":{"description":"When a delivery last succeeded; null if none has yet.","example":"2026-09-29T10:00:00.123Z","format":"date-time","type":["string","null"]},"object_type":{"description":"Always `WEBHOOK_ENDPOINT`.","enum":["WEBHOOK_ENDPOINT"],"example":"WEBHOOK_ENDPOINT","type":"string"},"project_id":{"description":"Project whose events the endpoint receives. At most one of stack_id and project_id is set; neither means the whole workspace.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":["string","null"]},"secret":{"description":"Signing secret of the endpoint's deliveries, shown only in this response. If it gets lost, rotate the secret.","example":"whsec_example","type":"string"},"stack_id":{"description":"Stack whose events the endpoint receives, its projects included. At most one of stack_id and project_id is set; neither means the whole workspace.","example":null,"pattern":"^stack_[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}$","type":["string","null"]},"status":{"$ref":"#/components/schemas/WebhookEndpointStatus","description":"ENABLED receives deliveries. DISABLED was switched off by hand. AUTO_DISABLED was switched off by LingoHub after 15 failed deliveries in a row. Both stay off until the endpoint is enabled.","example":"ENABLED"},"updated_at":{"description":"When the endpoint was last changed.","example":"2026-09-29T10:00:00.123Z","format":"date-time","type":"string"},"url":{"description":"Public HTTPS address deliveries are sent to.","example":"https://example.com/lingohub/webhooks","type":"string"}},"required":["api_version","consecutive_failures","created_at","description","disabled_at","event_types","id","last_failure_at","last_success_at","object_type","project_id","secret","stack_id","status","updated_at","url"],"type":"object"},"WebhookEventCategory":{"description":"Public grouping of webhook subscription events.","enum":["PROJECTS_AND_BRANCHES","LANGUAGES","RESOURCES","IMPORTS_AND_EXPORTS","KEYS","TEXTS","AUTOMATION_AND_AI","QUALITY","TRANSLATION_ORDERS","MEMBERS_AND_STACKS","TMS_ASSETS","PROJECT_CONFIG","PLATFORM"],"type":"string"},"WebhookEventType":{"description":"An event a webhook endpoint can subscribe to.","properties":{"category":{"$ref":"#/components/schemas/WebhookEventCategory","description":"Group the event belongs to.","example":"PROJECTS_AND_BRANCHES"},"event_type":{"description":"The event's name, as the event_types of an endpoint and the type of a delivery name it.","example":"project.created","type":"string"},"name":{"description":"Label of the event for people.","example":"Project created","type":"string"},"object_type":{"description":"Always `WEBHOOK_EVENT_TYPE`.","enum":["WEBHOOK_EVENT_TYPE"],"example":"WEBHOOK_EVENT_TYPE","type":"string"}},"required":["category","event_type","name","object_type"],"type":"object"},"WebhookEventTypeCollection":{"description":"A cursor-paginated collection of accepted webhook subscription events.","properties":{"data":{"description":"The list of items in this page.","example":[{"category":"PROJECTS_AND_BRANCHES","event_type":"project.created","name":"Project created","object_type":"WEBHOOK_EVENT_TYPE"}],"items":{"$ref":"#/components/schemas/WebhookEventType"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"WebhookEventTypeFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+webhook_event_type[event_type]","-webhook_event_type[event_type]","+webhook_event_type[name]","-webhook_event_type[name]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/WebhookEventTypeFilterGroup"}},"type":"object"},"WebhookEventTypeFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/WebhookEventTypeFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/WebhookEventTypeFilterClause"},"minItems":1,"type":"array"},"webhook_event_type[category]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["PROJECTS_AND_BRANCHES","LANGUAGES","RESOURCES","IMPORTS_AND_EXPORTS","KEYS","TEXTS","AUTOMATION_AND_AI","QUALITY","TRANSLATION_ORDERS","MEMBERS_AND_STACKS","TMS_ASSETS","PROJECT_CONFIG","PLATFORM"],"type":"string"},"_in":{"items":{"enum":["PROJECTS_AND_BRANCHES","LANGUAGES","RESOURCES","IMPORTS_AND_EXPORTS","KEYS","TEXTS","AUTOMATION_AND_AI","QUALITY","TRANSLATION_ORDERS","MEMBERS_AND_STACKS","TMS_ASSETS","PROJECT_CONFIG","PLATFORM"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["PROJECTS_AND_BRANCHES","LANGUAGES","RESOURCES","IMPORTS_AND_EXPORTS","KEYS","TEXTS","AUTOMATION_AND_AI","QUALITY","TRANSLATION_ORDERS","MEMBERS_AND_STACKS","TMS_ASSETS","PROJECT_CONFIG","PLATFORM"],"type":"string"},"_nin":{"items":{"enum":["PROJECTS_AND_BRANCHES","LANGUAGES","RESOURCES","IMPORTS_AND_EXPORTS","KEYS","TEXTS","AUTOMATION_AND_AI","QUALITY","TRANSLATION_ORDERS","MEMBERS_AND_STACKS","TMS_ASSETS","PROJECT_CONFIG","PLATFORM"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"webhook_event_type[event_type]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"webhook_event_type[name]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"}},"type":"object"},"WebhookEventTypeFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/WebhookEventTypeFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/WebhookEventTypeFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"WebhookRequestDetails":{"description":"The request the delivery sends, rebuilt on each read from the event and the endpoint's current URL and payload format. It is not a stored copy of what an earlier attempt sent.","properties":{"body":{"description":"The JSON body as it is signed and sent; null when this LingoHub version doesn't know the event type yet.","example":"{\"id\":\"evt_0197c8f2-5a6b-7cde-8f12-3456789abcde\",\"type\":\"project.created\",\"api_version\":\"2026-07-01\",\"created_at\":\"2026-09-29T10:00:00.123+00:00\",\"workspace_id\":\"space_0197c8f2-5a6b-7cde-8f12-3456789abcde\",\"data\":{\"id\":\"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde\",\"title\":\"Website\"}}","type":["string","null"]},"headers":{"additionalProperties":{"type":"string"},"description":"Headers every attempt sends: webhook-id (the event's id), content-type and user-agent. The webhook-timestamp and webhook-signature headers are made for each attempt and not shown.","example":{"content-type":"application/json","user-agent":"LingoHub-Webhooks/1","webhook-id":"evt_0197c8f2-5a6b-7cde-8f12-3456789abcde"},"type":"object"},"url":{"description":"The endpoint's current URL.","example":"https://example.com/lingohub/webhooks","type":"string"}},"required":["body","headers","url"],"type":"object"},"Workspace":{"description":"A LingoHub workspace.","properties":{"created_at":{"description":"Timestamp when the workspace was created.","example":"2025-01-15T10:30:00.123Z","format":"date-time","type":"string"},"id":{"description":"Unique identifier of the workspace.","example":"space_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^space_[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}$","type":"string"},"name":{"description":"Display name of the workspace.","example":"My Workspace","maxLength":4096,"minLength":0,"type":"string"},"object_type":{"description":"Always `WORKSPACE`.","enum":["WORKSPACE"],"example":"WORKSPACE","type":"string"},"updated_at":{"description":"Timestamp when the workspace was last updated.","example":"2025-06-20T14:45:00.123Z","format":"date-time","type":"string"}},"required":["created_at","id","name","object_type","updated_at"],"type":"object"},"WorkspaceRole":{"description":"An existing workspace role without its internal permission configuration or assigned users.","properties":{"created_at":{"description":"Time the role was created.","example":"2026-09-29T10:00:00.123Z","format":"date-time","type":"string"},"description":{"description":"Description of the role, if provided.","example":"Translates assigned content.","type":["string","null"]},"id":{"description":"Unique workspace role identity.","example":"rol_0197c8f2-5a6b-7cde-8f12-3456789abcde","minLength":1,"pattern":"^rol_[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}$","type":"string"},"name":{"description":"Display name of the role.","example":"Translator","type":"string"},"object_type":{"description":"Always `WORKSPACE_ROLE`.","enum":["WORKSPACE_ROLE"],"example":"WORKSPACE_ROLE","type":"string"},"type":{"$ref":"#/components/schemas/WorkspaceRoleType","description":"Role category. Reading OWNER does not permit owner membership changes through the API.","example":"CUSTOM"},"updated_at":{"description":"Time the role was last changed.","example":"2026-09-29T10:00:00.123Z","format":"date-time","type":"string"}},"required":["created_at","description","id","name","object_type","type","updated_at"],"type":"object"},"WorkspaceRoleCollection":{"description":"A cursor-paginated collection of workspace roles.","properties":{"data":{"description":"The list of items in this page.","example":[{"created_at":"2026-09-29T10:00:00.123Z","description":"Translates assigned content.","id":"rol_0197c8f2-5a6b-7cde-8f12-3456789abcde","name":"Translator","object_type":"WORKSPACE_ROLE","type":"CUSTOM","updated_at":"2026-09-29T10:00:00.123Z"}],"items":{"$ref":"#/components/schemas/WorkspaceRole"},"type":"array"},"has_more":{"description":"True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.","example":true,"type":"boolean"},"next_cursor":{"description":"Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.","example":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","type":["string","null"]},"object_type":{"description":"Always `LIST`.","enum":["LIST"],"example":"LIST","type":"string"}},"required":["data","has_more","next_cursor","object_type"],"type":"object"},"WorkspaceRoleFilter":{"additionalProperties":false,"description":"The filter of a list: which items to return and in which order.","properties":{"sort":{"description":"Fields to sort by, in order: `+` ascending, `-` descending.","items":{"enum":["+workspace_role[created_at]","-workspace_role[created_at]","+workspace_role[name]","-workspace_role[name]","+workspace_role[updated_at]","-workspace_role[updated_at]"],"type":"string"},"maxItems":8,"type":"array"},"where":{"$ref":"#/components/schemas/WorkspaceRoleFilterGroup"}},"type":"object"},"WorkspaceRoleFilterClause":{"additionalProperties":false,"description":"A nested `_and`/`_or`, or one field with one operator.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/WorkspaceRoleFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/WorkspaceRoleFilterClause"},"minItems":1,"type":"array"},"workspace_role[created_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"},"workspace_role[description]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"workspace_role[id]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"pattern":"^rol_[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}$","type":"string"},"_in":{"items":{"pattern":"^rol_[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}$","type":"string"},"minItems":1,"type":"array"},"_ne":{"pattern":"^rol_[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}$","type":"string"},"_nin":{"items":{"pattern":"^rol_[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}$","type":"string"},"minItems":1,"type":"array"}},"type":"object"},"workspace_role[name]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_blank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_contains":{"type":"string"},"_ends":{"type":"string"},"_eq":{"type":"string"},"_icontains":{"type":"string"},"_ilike":{"type":"string"},"_like":{"type":"string"},"_nblank":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_ncontains":{"type":"string"},"_ne":{"type":"string"},"_nicontains":{"type":"string"},"_nilike":{"type":"string"},"_nlike":{"type":"string"},"_starts":{"type":"string"}},"type":"object"},"workspace_role[type]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"enum":["OWNER","ADMIN","LOCALIZATION_MANAGER","MEMBER","CUSTOM"],"type":"string"},"_in":{"items":{"enum":["OWNER","ADMIN","LOCALIZATION_MANAGER","MEMBER","CUSTOM"],"type":"string"},"minItems":1,"type":"array"},"_ne":{"enum":["OWNER","ADMIN","LOCALIZATION_MANAGER","MEMBER","CUSTOM"],"type":"string"},"_nin":{"items":{"enum":["OWNER","ADMIN","LOCALIZATION_MANAGER","MEMBER","CUSTOM"],"type":"string"},"minItems":1,"type":"array"}},"type":"object"},"workspace_role[updated_at]":{"additionalProperties":false,"description":"Exactly one operator of the field.","maxProperties":1,"minProperties":1,"properties":{"_eq":{"format":"date-time","type":"string"},"_gt":{"format":"date-time","type":"string"},"_gte":{"format":"date-time","type":"string"},"_lt":{"format":"date-time","type":"string"},"_lte":{"format":"date-time","type":"string"},"_nnull":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_null":{"description":"Takes no value; send `true`.","enum":[true],"type":"boolean"},"_within":{"description":"The lower and the upper bound.","items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"type":"object"}},"type":"object"},"WorkspaceRoleFilterGroup":{"additionalProperties":false,"description":"Exactly one of `_and` and `_or`, with the clauses it combines.","maxProperties":1,"minProperties":1,"properties":{"_and":{"items":{"$ref":"#/components/schemas/WorkspaceRoleFilterClause"},"minItems":1,"type":"array"},"_or":{"items":{"$ref":"#/components/schemas/WorkspaceRoleFilterClause"},"minItems":1,"type":"array"}},"type":"object"},"WorkspaceRoleType":{"description":"Workspace role category. OWNER can be discovered but owner membership changes are outside the API.","enum":["OWNER","ADMIN","LOCALIZATION_MANAGER","MEMBER","CUSTOM"],"example":"MEMBER","type":"string"},"WriteTextVariant":{"additionalProperties":false,"description":"One variant of a text: its content for a device and a plural form. The variants of a text keep the order they are sent in.","properties":{"content":{"description":"The text, with its placeholders and markup. A variant that is still empty after the project's automations is removed. At most 51,999 characters.","example":"Sign in","maxLength":51999,"type":"string"},"device":{"$ref":"#/components/schemas/VariantDevice","default":"OTHER","description":"Device the variant is for. Defaults to OTHER.","example":"OTHER"},"plural_form":{"$ref":"#/components/schemas/VariantPluralForm","default":"OTHER","description":"Plural form of the variant; a segment without plural forms takes OTHER only. Defaults to OTHER.","example":"OTHER"}},"required":["content"],"type":"object"},"XliffFileFormatConfiguration":{"description":"How XLIFF files identify keys and languages.","properties":{"is_multi_language":{"description":"Whether the XLIFF file carries multiple languages.","example":false,"type":"boolean"},"is_resname_identifier":{"description":"Whether resname identifies the segment key.","example":false,"type":"boolean"}},"required":["is_multi_language","is_resname_identifier"],"type":"object"}},"securitySchemes":{"bearerAuth":{"description":"API key authentication. Create API keys in your LingoHub workspace settings. Keys use the `lh-api_` prefix. Pass the full key as the Bearer token.","scheme":"bearer","type":"http"}}},"info":{"contact":{"email":"info@lingohub.com","name":"lingohub GmbH","url":"https://lingohub.com"},"description":"> **Beta:** API V2 is in beta. Endpoints, request and response fields, and behavior can still change. Use the LingoHub CLI (`lingohub`) where possible: it is updated together with the API. If you call the HTTP API directly, be prepared to update your integration when V2 changes.\n\nThe LingoHub V2 API provides programmatic access to your localization workflow. Use it to manage workspaces, projects, resources, translations, and more.\n\n## Authentication\n\nAll requests require a Bearer token in the `Authorization` header. API keys can be created in the LingoHub workspace settings and use the `lh-api_` prefix.\n\n```\nAuthorization: Bearer lh-api_your_api_key_here\n```\n\n## Pagination\n\nList endpoints use cursor pagination via the `cursor` and `limit` query parameters (`limit` defaults to 20, maximum 100). Each response contains the returned items in `data`, a `has_more` flag, and an opaque `next_cursor` token that is null on the last page. To iterate a collection, repeat the request with `cursor` set to the previous response's `next_cursor` until `has_more` is false. Keep all other query parameters identical while iterating — a cursor is bound to the collection (parent resource), the filters, and the sort order it was created under and is rejected with an `invalid_cursor` error otherwise. Total counts are intentionally not provided; items created or deleted before the cursor position are not revisited during an iteration.\n\n## Filtering\n\nLists take a `filter` query parameter: URL-encoded JSON that selects the items to return (`where`) and orders them (`sort`). `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is a nested `_and`/`_or`, or a field with exactly one operator. Fields are named `<object_type>[<field>]` after the list's items, e.g. `project[name]`, and compare the values the responses show. Each list documents its fields, their operators and values, and which of them sort, in its `filter` parameter and its schema (`ProjectFilter`, ...). A field, operator or value a list does not support answers `400 invalid_filter`, with an error pointing into the filter and naming what is supported there.\n\n### Operators\n\nA clause compares one field with one operator: `{ \"<field>\": { \"<operator>\": <value> } }`.\n\n| Operator | Matches items whose field | Value |\n|---|---|---|\n| `_eq`, `_ne` | equals / does not equal the value | one value |\n| `_in`, `_nin` | is one of / none of the values | non-empty array |\n| `_lt`, `_lte`, `_gt`, `_gte` | is less than / at most / greater than / at least the value | number or timestamp |\n| `_within` | lies between the two bounds, both included | `[lower, upper]` |\n| `_contains`, `_ncontains` | contains / does not contain the text, case-sensitive | text |\n| `_icontains`, `_nicontains` | contains / does not contain the text, ignoring case | text |\n| `_starts`, `_ends` | starts / ends with the text, case-sensitive | text |\n| `_like`, `_nlike` | matches / does not match a pattern, case-sensitive: `%` stands for any text, `_` for one character | text |\n| `_ilike`, `_nilike` | like `_like` and `_nlike`, ignoring case | text |\n| `_blank`, `_nblank` | has no text (missing or empty) / has text | `true` |\n| `_null`, `_nnull` | has no value / has a value | `true` |\n| `_true`, `_false` | is true / is false | `true` |\n\nWhich operators a field offers depends on its type:\n\n| Field type | Operators |\n|---|---|\n| text | `_eq` `_ne` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_like` `_nlike` `_ilike` `_nilike` `_blank` `_nblank` |\n| id, enum | `_eq` `_ne` `_in` `_nin` |\n| integer | `_eq` `_ne` `_in` `_nin` `_lt` `_lte` `_gt` `_gte` `_within` `_null` `_nnull` |\n| timestamp | `_eq` `_lt` `_lte` `_gt` `_gte` `_within` `_null` `_nnull` |\n| boolean | `_true` `_false` |\n\nValues have the form the responses show: public ids (`stack_0197c8f2-…`), enum values (`STANDARD_JSON`), and timestamps in RFC 3339 UTC (`2026-01-01T00:00:00Z`). Each list operation shows its own fields in a table under its `filter` parameter in the API reference: the field name, its type, the operators it offers and whether it can sort.\n\nMore clauses:\n\n```json\n{ \"project[type]\": { \"_in\": [\"STANDARD_JSON\", \"I18NEXT_JSON\"] } }\n{ \"import[created_at]\": { \"_within\": [\"2026-11-01T00:00:00Z\", \"2026-11-30T23:59:59Z\"] } }\n{ \"invitation[accepted_at]\": { \"_null\": true } }\n{ \"branch[is_default]\": { \"_false\": true } }\n{ \"key[key]\": { \"_like\": \"checkout.%\" } }\n```\n\n### Example\n\n```json\n{\n  \"where\": {\n    \"_and\": [\n      { \"project[name]\": { \"_icontains\": \"app\" } },\n      {\n        \"_or\": [\n          { \"project[type]\": { \"_eq\": \"STANDARD_JSON\" } },\n          { \"project[created_at]\": { \"_gte\": \"2026-01-01T00:00:00Z\" } }\n        ]\n      }\n    ]\n  },\n  \"sort\": [\"-project[created_at]\"]\n}\n```\n\nAn unknown value is answered with where it is and what the field accepts:\n\n```json\n{\n  \"status\": 400,\n  \"code\": \"invalid_filter\",\n  \"errors\": [\n    {\n      \"parameter\": \"filter\",\n      \"pointer\": \"#/where/_and/1/_or/0/project[type]/_eq\",\n      \"code\": \"enum\",\n      \"detail\": \"'JSON' is not a value of 'project[type]'. Values: ANDROID_XML, IOS_STRINGS, ...\"\n    }\n  ]\n}\n```\n\n## Rate limiting\n\nRequests are rate limited per API key and per workspace (aggregate across all of its keys). Exceeding either limit returns `429 rate_limit_exceeded` with a `Retry-After` header stating the seconds to wait before retrying. Responses to authenticated requests additionally carry the structured `RateLimit` and `RateLimit-Policy` headers (IETF draft-ietf-httpapi-ratelimit-headers): `RateLimit-Policy` lists the applied policies with their request quota `q` per window of `w` seconds, and `RateLimit` reports the policy currently closest to rejection with the requests remaining right now (`r`) and the seconds until the full quota is available again (`t`). Use them to pace request rates proactively instead of backing off on 429 — but treat them as advisory: they are absent when the request fails authentication or the limiter state is momentarily unknown.\n\n## Errors\n\nAll error responses follow the RFC 9457 Problem Details format with additional `code` and `request_id` fields for machine-readable error handling and support requests, and an additional `errors` field for handling multiple validation errors at once.\n\nThe field-level validation errors return a JSON pointer to the problem value, a detail description, and a machine-readable code. For more information, see RFC 9457 Section 3 §7.\n\n## Error code catalog\n\n| Code | HTTP status | Meaning |\n|---|---|---|\n| `invalid_json` | 400 | Invalid JSON |\n| `invalid_parameter` | 400 | Invalid parameter |\n| `missing_parameter` | 400 | Missing parameter |\n| `unknown_parameter` | 400 | Unknown parameter |\n| `invalid_filter` | 400 | Invalid filter |\n| `invalid_cursor` | 400 | Invalid cursor |\n| `bad_request` | 400 | Bad request |\n| `missing_api_key` | 401 | Missing API key |\n| `invalid_api_key` | 401 | Invalid API key |\n| `expired_api_key` | 401 | Expired API key |\n| `revoked_api_key` | 401 | Revoked API key |\n| `disabled_api_key` | 401 | Disabled API key |\n| `insufficient_permissions` | 403 | Insufficient permissions |\n| `resource_not_found` | 404 | Resource not found |\n| `route_not_found` | 404 | Route not found |\n| `method_not_allowed` | 405 | Method not allowed |\n| `not_acceptable` | 406 | Not acceptable |\n| `precondition_failed` | 412 | Precondition failed |\n| `content_too_large` | 413 | Content too large |\n| `unsupported_media_type` | 415 | Unsupported media type |\n| `already_exists` | 409 | Already exists |\n| `idempotency_outcome_unknown` | 409 | Idempotency outcome unknown |\n| `idempotency_key_in_use` | 409 | Idempotency key in use |\n| `stack_not_empty` | 409 | Stack not empty |\n| `branch_not_ready` | 409 | Branch not ready |\n| `backup_not_ready` | 409 | Backup not ready |\n| `backup_in_use` | 409 | Backup in use |\n| `default_branch_protected` | 409 | Default branch protected |\n| `owner_membership_protected` | 409 | Owner membership protected |\n| `source_language_protected` | 409 | Source language protected |\n| `branch_limit_reached` | 409 | Branch limit reached |\n| `context_image_limit_reached` | 409 | Context image limit reached |\n| `automation_limit_reached` | 409 | Automation limit reached |\n| `translation_order_pending` | 409 | Translation order pending |\n| `git_integration_not_configured` | 409 | Git integration not configured |\n| `branch_git_integration_not_configured` | 409 | Branch git integration not configured |\n| `git_integration_unauthorized` | 409 | Git integration unauthorized |\n| `conflict` | 409 | Conflict |\n| `validation_failed` | 422 | Validation failed |\n| `idempotency_key_mismatch` | 422 | Idempotency key mismatch |\n| `rate_limit_exceeded` | 429 | Rate limit exceeded |\n| `internal_error` | 500 | Internal error |\n| `upstream_error` | 502 | Upstream error |\n| `service_unavailable` | 503 | Service unavailable |\n| `upstream_timeout` | 504 | Upstream timeout |","termsOfService":"https://lingohub.com/terms","title":"LingoHub API V2 (Beta)","version":"2.0"},"openapi":"3.1.0","paths":{"/v2/api-key":{"delete":{"description":"Revokes the personal API key this request is made with, as its owner deleting it in LingoHub would: the key is deactivated, its metadata and history remain, and later requests with it fail with 401 `revoked_api_key`. Command-line clients use this to sign out. Workspace-managed keys can't revoke themselves (403); an administrator revokes them in LingoHub. Optional If-Match uses the validator of `getApiKey`; a stale one returns 412. Requires a personal API key.","operationId":"deleteApiKey","parameters":[{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"API key revoked.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Revoke the API key","tags":["API Keys"]},"get":{"description":"Returns the API key this request is made with: what it reaches, what it may do there, and when it expires. The permissions are the ones requests are authorized with, in the vocabulary of `required_permission` in 403 responses.","operationId":"getApiKey","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}},"description":"API key retrieved successfully.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve the API key","tags":["API Keys"]}},"/v2/api-keys":{"get":{"description":"Lists every API key of the workspace, personal and workspace-managed, active and deactivated. Tokens and permissions aren't included; use getApiKey for the calling key's permissions. Requires workspace-level API access view permission.","operationId":"listWorkspaceApiKeys","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `ApiKeyFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `api_key[created_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `api_key[deactivated_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | – |\n| `api_key[deactivation_reason]` | EXPIRATION_DATE \\| WORKSPACE_USER_REMOVED \\| STACK_DELETED \\| MANUAL_REVOCATION \\| SELF_SERVICE_DISABLED | `_eq` `_ne` `_in` `_nin` | – |\n| `api_key[description]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | – |\n| `api_key[id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `api_key[management_mode]` | WORKSPACE_MANAGED \\| USER_OWNED | `_eq` `_ne` `_in` `_nin` | – |\n| `api_key[member_id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `api_key[name]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | yes |\n| `api_key[scope]` | WORKSPACE \\| STACK \\| USER | `_eq` `_ne` `_in` `_nin` | – |\n| `api_key[stack_id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `api_key[updated_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyCollection"}}},"description":"Workspace API keys retrieved.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List workspace API keys","tags":["API Keys"]}},"/v2/api-keys/{apiKeyId}":{"get":{"description":"Returns one API key of the workspace, without its token or permissions. A key that isn't deactivated can still be refused, for example once it has expired or its member lost access. Requires workspace-level API access view permission.","operationId":"getWorkspaceApiKey","parameters":[{"in":"path","name":"apiKeyId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For an API key, a valid value would be : api_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^api_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}},"description":"Workspace API key retrieved.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve a workspace API key","tags":["API Keys"]},"patch":{"description":"Renames a workspace-managed key or changes its description or expiry date; its scope, permissions and token stay the same. `null` clears the description or removes the expiry. Personal and deactivated keys can't be changed here (409). Requires workspace-level API access management permission.","operationId":"updateWorkspaceApiKey","parameters":[{"in":"path","name":"apiKeyId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For an API key, a valid value would be : api_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^api_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWorkspaceApiKey"}},"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateWorkspaceApiKey"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}},"description":"Workspace API key updated.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`conflict`: the key is a personal key, which only its owner manages, or it is deactivated or expired.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Update a workspace API key","tags":["API Keys"]}},"/v2/api-logs":{"get":{"description":"Lists the workspace's V1 and V2 API requests, newest first, as far back as the plan keeps API logs. A key with the workspace's logs view permission sees every key's requests, any other key only its own. Use `filter` to narrow the list, e.g. by `created_at` or `status_code`.","operationId":"listApiLogs","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiLogFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `ApiLogFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `api_log[api_key_id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `api_log[created_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `api_log[id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `api_log[method]` | GET \\| HEAD \\| POST \\| PUT \\| PATCH \\| DELETE \\| OPTIONS \\| TRACE \\| OTHER | `_eq` `_ne` `_in` `_nin` | – |\n| `api_log[path]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | – |\n| `api_log[request_id]` | uuid | `_eq` `_ne` `_in` `_nin` | – |\n| `api_log[status_code]` | integer | `_eq` `_ne` `_in` `_nin` `_gt` `_lt` `_gte` `_lte` `_within` `_null` `_nnull` | – |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiLogCollection"}}},"description":"The API log entries the key can read.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List API logs","tags":["API Logs"]}},"/v2/api-logs/{apiLogId}":{"get":{"description":"Returns one API log entry. Any key can read the entries of its own requests; a key with the workspace's logs view permission can read every key's. Entries of other keys, and entries older than the plan keeps API logs, answer 404. To find the entries of a request whose `request_id` you have, filter the list by `api_log[request_id]`.","operationId":"getApiLog","parameters":[{"description":"Unique identifier of the API log entry.","example":"req_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"apiLogId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For an api log, a valid value would be : req_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^req_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiLog"}}},"description":"The API log entry.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve an API log","tags":["API Logs"]}},"/v2/audit-logs":{"get":{"description":"Lists the workspace's audit log, newest first, as far back as the plan keeps audit logs: what changed, who changed it and in which project. The changed values are available from getAuditLog. Requires the workspace's logs view permission.","operationId":"listAuditLogs","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditLogFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `AuditLogFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `audit_log[actor_id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `audit_log[actor_type]` | LINGOHUB_ROBOT \\| USER \\| API_KEY \\| LINA | `_eq` `_ne` `_in` `_nin` | – |\n| `audit_log[category]` | WORKSPACES \\| TMS \\| MARKETPLACE \\| API \\| MEMBERS \\| LABELS \\| PROJECTS \\| USERS | `_eq` `_ne` `_in` `_nin` | – |\n| `audit_log[created_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `audit_log[event]` | CREATE \\| UPDATE \\| DELETE \\| RENAME \\| IMPORT \\| EXPORT \\| DEACTIVATE \\| ACTIVATE \\| CANCEL \\| RENEW \\| APPROVE \\| FAIL \\| ACCEPT \\| DECLINE \\| TRANSFER \\| RESET \\| CONFIRM \\| ENABLE \\| DISABLE \\| SCHEDULE | `_eq` `_ne` `_in` `_nin` | – |\n| `audit_log[id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `audit_log[project_id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `audit_log[project_name]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | – |\n| `audit_log[request_id]` | uuid | `_eq` `_ne` `_in` `_nin` | – |\n| `audit_log[target]` | GENERAL \\| PROFILE \\| PROFILE_URL \\| SUBSCRIPTION \\| BILLING_INFOS \\| PAYMENT_INFOS \\| INVOICES \\| PAYMENTS \\| GLOSSARIES \\| TRANSLATION_MEMORIES \\| STYLE_GUIDES \\| ORDERS \\| KEYS \\| WEBHOOKS \\| INVITATION \\| PERMISSION \\| ROLE \\| LOCALES \\| RESOURCES \\| PACKAGES \\| BACKUPS \\| PRE_TRANSLATION \\| INTEGRATIONS \\| API_LOGS \\| STACK \\| LINA \\| AUDIT_LOGS \\| SEGMENT_TEXT_EDITS \\| WORK_LOGS \\| PASSWORD \\| WORKSPACE \\| TWO_FACTOR \\| TEXT_PROCESSINGS \\| SETTINGS \\| BRANCHES | `_eq` `_ne` `_in` `_nin` | – |\n| `audit_log[updated_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditLogCollection"}}},"description":"The audit log entries.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List workspace audit logs","tags":["Audit Logs"]}},"/v2/audit-logs/{auditLogId}":{"get":{"description":"Returns one audit log entry: what changed, who changed it, in which project, and the changed values with their previous ones. Secrets are never shown. Entries older than the plan keeps audit logs answer 404. Requires the workspace's logs view permission.","operationId":"getAuditLog","parameters":[{"in":"path","name":"auditLogId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^audit_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditLogWithChanges"}}},"description":"The audit log entry with its changed values.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve a workspace audit log","tags":["Audit Logs"]}},"/v2/backup-restores/{backupRestoreId}":{"get":{"description":"Returns one restore. Poll it while `status` is `QUEUED` or `PROCESSING`; a failed restore says why in `status_details`. A restore is gone once its backup or its branch is deleted. Requires project-level settings management permission.","operationId":"getBackupRestore","parameters":[{"in":"path","name":"backupRestoreId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^bkr_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackupRestore"}}},"description":"The restore.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve a backup restore","tags":["Backup Restores"]}},"/v2/backups/{backupId}":{"delete":{"description":"Deletes the backup and the records of restores made from it. A backup that is still being made or restored can't be deleted yet: the answer is 409 `backup_in_use`. Send the ETag from getBackup as If-Match to make sure nobody changed it in between. Requires project-level settings management permission.","operationId":"deleteBackup","parameters":[{"in":"path","name":"backupId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^bkp_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Backup deleted.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`backup_in_use`: the backup is queued or being made, a restore from it is pending, or another operation is working on it.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Delete a backup","tags":["Backups"]},"get":{"description":"Returns one backup, the same object as in listBackups. Poll it while `status` is `QUEUED` or `PROCESSING`; a failed backup says why in `status_details`. Requires project-level settings management permission.","operationId":"getBackup","parameters":[{"in":"path","name":"backupId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^bkp_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Backup"}}},"description":"The backup.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve a backup","tags":["Backups"]}},"/v2/branches/{branchId}":{"delete":{"description":"Deletes a branch that isn't the default: it disappears from the project immediately and is cleaned up in the background; this can't be undone. Its files, keys, languages, Git connection and import history are deleted. The texts stay in the stack, and backups of the branch are kept. Make another branch the default first to delete the current default (409 `default_branch_protected`). Requires project-level settings management permission.","operationId":"deleteBranch","parameters":[{"description":"Unique identifier of the branch.","example":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"branchId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project branch, a valid value would be : prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Branch deleted successfully.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The branch is the project's default branch (`default_branch_protected`); make another branch the default first.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Delete a branch","tags":["Branches"]},"get":{"description":"Returns one branch. Poll it after creating a copied branch until `initialization_status` is final. A branch the key can't see returns 404, the same as one that doesn't exist. Requires project-level general view permission.","operationId":"getBranch","parameters":[{"description":"Unique identifier of the branch.","example":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"branchId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project branch, a valid value would be : prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Branch"}}},"description":"Branch retrieved successfully.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve a branch","tags":["Branches"]},"patch":{"description":"Renames a branch; names are unique in the project. A connected Git branch keeps its own name (`git_branch`). Requires project-level settings management permission.","operationId":"updateBranch","parameters":[{"description":"Unique identifier of the branch.","example":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"branchId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project branch, a valid value would be : prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBranch"}},"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateBranch"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Branch"}}},"description":"Branch updated successfully.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"A branch with this name already exists (`already_exists` on `name`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Rename a branch","tags":["Branches"]}},"/v2/branches/{branchId}/backup-restores":{"post":{"description":"Restores the chosen languages of a succeeded backup into a branch of the same project, in the background; poll the restore at the URL in `Location`. The backup's files come back in those languages with their texts and statuses; files the backup doesn't contain stay as they are, and a language the branch no longer has is added back. Restoring the source language also restores the files' keys and their settings. The backup's source language must match the branch's. Requires branch-level and backup settings management permission.","operationId":"createBackupRestore","parameters":[{"in":"path","name":"branchId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project branch, a valid value would be : prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBackupRestore"}}},"required":true},"responses":{"202":{"content":{"application/json":{"examples":{"queued":{"description":"queued","value":{"data":{"backup_id":"bkp_0197c8f2-5a6b-7cde-8f12-3456789abcde","branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","created_at":"2026-01-15T10:30:00.123Z","id":"bkr_0197c8f2-5a6b-7cde-8f12-3456789abcde","language_codes":["en","de"],"object_type":"BACKUP_RESTORE","project_id":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","status":"QUEUED","status_details":null,"updated_at":"2026-01-15T10:30:00.123Z"},"job_type":"BACKUP_RESTORE","object_type":"JOB"}}},"schema":{"$ref":"#/components/schemas/BackupRestoreJob"}}},"description":"Restore queued.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the restore, to poll it until it has finished.","schema":{"example":"/v2/backup-restores/bkr_0197c8f2-5a6b-7cde-8f12-3456789abcde","format":"uri-reference","type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`branch_not_ready`: the branch is still being created. `backup_not_ready`: the backup has not succeeded. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"A field is invalid; `errors` points at it. `not_found` on `backup_id` when the project has no such backup and on an item of `language_codes` when the backup doesn't have that language; `not_supported` on `backup_id` when the backup's source language differs from the branch's.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Create a backup restore","tags":["Backup Restores"]}},"/v2/branches/{branchId}/backups":{"post":{"description":"Backs up the branch in the background: its files, keys and texts in all of its languages. Poll the backup at the URL in `Location` until it has finished. The branch must be ready; while it is still being created the answer is 409 `branch_not_ready`. Requires branch-level settings management permission.","operationId":"createBackup","parameters":[{"in":"path","name":"branchId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project branch, a valid value would be : prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBackup"}}},"required":true},"responses":{"202":{"content":{"application/json":{"examples":{"queued":{"description":"queued","value":{"data":{"branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","branch_name":"main","created_at":"2026-01-15T10:30:00.123Z","id":"bkp_0197c8f2-5a6b-7cde-8f12-3456789abcde","name":"Before release","object_type":"BACKUP","project_id":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","source_language_code":"en","status":"QUEUED","status_details":null,"target_language_codes":["de","fr"],"updated_at":"2026-01-15T10:30:00.123Z"},"job_type":"BACKUP","object_type":"JOB"}}},"schema":{"$ref":"#/components/schemas/BackupJob"}}},"description":"Backup queued.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the backup, to poll it until it has finished.","schema":{"example":"/v2/backups/bkp_0197c8f2-5a6b-7cde-8f12-3456789abcde","format":"uri-reference","type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`branch_not_ready`: the branch is still being created. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Create a backup","tags":["Backups"]}},"/v2/branches/{branchId}/exports":{"get":{"description":"Returns the branch's exports, newest first, as far back as the workspace's plan keeps them: those made through the API as well as downloads in the app, git pushes, CDN releases, backups and integration pushes. Each states the languages it was limited to and, once it succeeded, a download URL that works for 24 hours; reading the export again gives a fresh one. Requires branch-level resource view permission.","operationId":"listExports","parameters":[{"in":"path","name":"branchId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project branch, a valid value would be : prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `ExportFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `export[created_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `export[id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `export[status]` | QUEUED \\| PROCESSING \\| SUCCEEDED \\| PARTIALLY_SUCCEEDED \\| FAILED \\| CANCELLED \\| SKIPPED | `_eq` `_ne` `_in` `_nin` | – |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportCollection"}}},"description":"The branch's exports.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List exports","tags":["Exports"]},"post":{"description":"Exports all files of the branch in the background, for all languages or those in `language_codes`; poll the export at the URL in `Location` until it has finished, then download it from `download_url`. The project's export settings apply as they are when the export runs. Requires branch-level resource view permission.","operationId":"createExport","parameters":[{"in":"path","name":"branchId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project branch, a valid value would be : prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExport"}}},"required":true},"responses":{"202":{"content":{"application/json":{"examples":{"queued":{"description":"queued","value":{"data":{"branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","created_at":"2026-01-15T10:30:00.123Z","download_url":null,"download_url_expires_at":null,"git_result":null,"id":"reg_0197c8f2-5a6b-7cde-8f12-3456789abcde","language_codes":["de","fr"],"object_type":"EXPORT","status":"QUEUED","status_details":null,"updated_at":"2026-01-15T10:30:00.123Z"},"job_type":"EXPORT","object_type":"JOB"}}},"schema":{"$ref":"#/components/schemas/ExportJob"}}},"description":"Export queued.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the export, to poll it until it has finished.","schema":{"example":"/v2/exports/reg_0197c8f2-5a6b-7cde-8f12-3456789abcde","format":"uri-reference","type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The branch has not completed initialization (`branch_not_ready`); poll its initialization_status before retrying. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"A field is invalid; `errors` points at it. `not_found` on an item of `language_codes` when the branch doesn't have that language.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Create an export","tags":["Exports"]}},"/v2/branches/{branchId}/imports":{"get":{"description":"Lists the branch's imports, newest first, as far back as the workspace's plan keeps them. Besides file uploads this includes git pulls, content platform syncs, added languages and delivered translations. The counters are 0 until an import finishes. Requires branch-level resource view permission.","operationId":"listImports","parameters":[{"in":"path","name":"branchId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project branch, a valid value would be : prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `ImportFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `import[created_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `import[id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `import[status]` | QUEUED \\| PROCESSING \\| SUCCEEDED \\| PARTIALLY_SUCCEEDED \\| FAILED \\| CANCELLED \\| SKIPPED | `_eq` `_ne` `_in` `_nin` | – |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportCollection"}}},"description":"The branch's imports.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List imports","tags":["Imports"]},"post":{"description":"Uploads a file, or a `.zip` of files, and imports it into the branch in the background; poll the import at the URL in `Location`. Each file can be up to 10 MB (50 MB in document projects), the whole upload up to 100 MB. `path` is the folder the files go into (the project root if left out); `language_code` is their language (detected from each file's name and path if left out). A file in a language the branch doesn't have yet adds that language as a target language. The import uses the project's import settings as they are when it's queued; a file that hasn't changed since its last import is recognised and left alone. Requires branch-level resource management permission.","operationId":"createImport","parameters":[{"in":"path","name":"branchId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project branch, a valid value would be : prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file":{"description":"The file to import. A file whose name ends in `.zip` is imported as an archive of files.","format":"binary","type":"string"},"language_code":{"description":"Language of the file, or of every file of an archive; one of the supported locales. Omit it to detect the language from each file's name and path.","example":"de","type":"string"},"path":{"description":"Folder the file, or every file of an archive, is imported into (e.g. `src/i18n/de`). Omit it to import at the project root. Must be a relative POSIX path of at most 4096 characters: `..` segments, absolute paths, drive letters and segments longer than 255 characters are rejected.","example":"src/i18n/de","maxLength":4096,"type":"string"}},"required":["file"],"type":"object"}}}},"responses":{"202":{"content":{"application/json":{"examples":{"queued":{"description":"queued","value":{"data":{"branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","created_at":"2026-01-15T10:30:00.123Z","git_source":null,"id":"rin_0197c8f2-5a6b-7cde-8f12-3456789abcde","keys_deactivated":0,"keys_reactivated":0,"keys_renamed":0,"object_type":"IMPORT","status":"QUEUED","status_details":null,"texts_created":0,"texts_updated":0,"updated_at":"2026-01-15T10:30:00.123Z"},"job_type":"IMPORT","object_type":"JOB"}}},"schema":{"$ref":"#/components/schemas/ImportJob"}}},"description":"Import queued.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the import, to poll it until it has finished.","schema":{"example":"/v2/imports/rin_0197c8f2-5a6b-7cde-8f12-3456789abcde","format":"uri-reference","type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The request is malformed: the `file` field is missing, or a query parameter or the id in the path is invalid. `code` names the problem, `errors` the parameter.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The branch has not completed initialization (`branch_not_ready`); poll its initialization_status before retrying. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The upload exceeds the maximum size.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"A form field is invalid; `errors` names it. For `file`: `file_empty`; `unsupported_file_extension` or `file_too_large` for the file or for each offending file of an archive; `invalid_archive` when a `.zip` file cannot be read at all (not an archive, corrupt, truncated or password-protected); `empty_archive` when it holds no importable files; `not_supported` when an archive mixes LingoHub CSV/XLIFF downloads with project files. `path` breaks a path rule (`minLength`, `maxLength`, `pattern`). `language_code` is not a language code (`format`) or not a supported locale (`enum`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Create an import","tags":["Imports"]}},"/v2/branches/{branchId}/integrations/git":{"delete":{"description":"Unlinks the branch from its remote branch; the branch and its texts stay, and a pull or push already queued still runs. The default branch can't be unlinked (409 `default_branch_protected`): disconnect the project instead. While branching is on, a branch filter that matches the remote branch links it again at the next sync. Send the ETag from getBranchGitIntegration as If-Match to make sure nobody changed the link in between. Requires stack-level settings management permission.","operationId":"deleteBranchGitIntegration","parameters":[{"in":"path","name":"branchId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project branch, a valid value would be : prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Unlinked; the branch stays.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`default_branch_protected`: the default branch can't be unlinked.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Disconnect a project branch from Git","tags":["Git Integrations"]},"get":{"description":"Returns the branch's link to its remote branch: the remote branch's name, how the link came about (`DEFAULT` for the default branch, `USER` when linked by hand, `SYSTEM` when created by branching), and the last successful pull and push. Requires stack-level settings management permission.","operationId":"getBranchGitIntegration","parameters":[{"in":"path","name":"branchId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project branch, a valid value would be : prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BranchGitIntegration"}}},"description":"The branch's link to its remote branch.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve the branch's git integration","tags":["Git Integrations"]},"post":{"description":"Links a branch to a remote branch and starts its first pull from it; poll the import at the URL in `Location`. The branch keeps its name. The project must be connected to git, and the default branch can't be linked here: its remote branch is set with `git_branch` on updateProjectGitIntegration. Requires stack-level settings management permission.","operationId":"createBranchGitIntegration","parameters":[{"in":"path","name":"branchId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project branch, a valid value would be : prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBranchGitIntegration"}}},"required":true},"responses":{"202":{"content":{"application/json":{"example":{"data":{"branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","created_at":"2026-01-15T10:30:00.123Z","git_source":null,"id":"rin_0197c8f2-5a6b-7cde-8f12-3456789abcde","keys_deactivated":0,"keys_reactivated":0,"keys_renamed":0,"object_type":"IMPORT","status":"QUEUED","status_details":null,"texts_created":0,"texts_updated":0,"updated_at":"2026-01-15T10:30:00.123Z"},"job_type":"IMPORT","object_type":"JOB"},"schema":{"$ref":"#/components/schemas/ImportJob"}}},"description":"Linked; the first pull is queued.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"$ref":"#/components/headers/Location"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`git_integration_not_configured`: the project isn't connected to git. `already_exists`: the branch is already linked. `default_branch_protected`: the default branch is linked through the project's git integration. `git_integration_unauthorized`: the git host refused the connection's credentials. `branch_not_ready`: the branch is still being created. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"502":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_error`: the git host failed, or answered with more or other data than LingoHub accepts.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"504":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_timeout`: the git host didn't answer in time.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}}},"security":[{"bearerAuth":[]}],"summary":"Bind a project branch to Git","tags":["Git Integrations"]}},"/v2/branches/{branchId}/integrations/git/pull":{"post":{"description":"Pulls the branch's files from its remote branch in the background, or once from another remote branch given in `git_branch`; poll the import at the URL in `Location`. The branch must be linked to a remote branch. Imports and restores on the same stack run one after another. Requires stack-level resource management permission.","operationId":"pullFromGit","parameters":[{"in":"path","name":"branchId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project branch, a valid value would be : prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PullFromGit"}}}},"responses":{"202":{"content":{"application/json":{"example":{"data":{"branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","created_at":"2026-01-15T10:30:00.123Z","git_source":null,"id":"rin_0197c8f2-5a6b-7cde-8f12-3456789abcde","keys_deactivated":0,"keys_reactivated":0,"keys_renamed":0,"object_type":"IMPORT","status":"QUEUED","status_details":null,"texts_created":0,"texts_updated":0,"updated_at":"2026-01-15T10:30:00.123Z"},"job_type":"IMPORT","object_type":"JOB"},"schema":{"$ref":"#/components/schemas/ImportJob"}}},"description":"The pull is queued.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"$ref":"#/components/headers/Location"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The project has no git integration (`git_integration_not_configured`), the branch is not bound to a git branch (`branch_git_integration_not_configured`), or the git provider refuses it access (`git_integration_unauthorized`). The branch has not completed initialization (`branch_not_ready`); poll its initialization_status before retrying. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"A field is invalid; `errors` names it. A `git_branch` the repository does not have is `not_found`.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"502":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The git provider failed or answered unexpectedly (`upstream_error`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"504":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The git provider did not answer in time (`upstream_timeout`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}}},"security":[{"bearerAuth":[]}],"summary":"Pull from git integration","tags":["Git Integrations"]}},"/v2/branches/{branchId}/integrations/git/push":{"post":{"description":"Pushes the branch's files to its remote branch in the background, or once to another remote branch given in `git_branch`, as a commit or a pull request; poll the export at the URL in `Location`. Fields you leave out come from the project's push settings. A pull request needs a `pull_request_branch` here or in the push settings, and a direct push to a protected branch is refused (422 on `push_type`). Requires stack-level resource management permission.","operationId":"pushToGit","parameters":[{"in":"path","name":"branchId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project branch, a valid value would be : prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushToGit"}}}},"responses":{"202":{"content":{"application/json":{"example":{"data":{"branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","created_at":"2026-09-30T10:00:00.123Z","download_url":null,"download_url_expires_at":null,"git_result":null,"id":"reg_0197c8f2-5a6b-7cde-8f12-3456789abcde","language_codes":null,"object_type":"EXPORT","status":"QUEUED","status_details":null,"updated_at":"2026-09-30T10:00:00.123Z"},"job_type":"EXPORT","object_type":"JOB"},"schema":{"$ref":"#/components/schemas/ExportJob"}}},"description":"The push is queued.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the export to poll.","schema":{"type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The project has no git integration (`git_integration_not_configured`), the branch is not bound to a git branch (`branch_git_integration_not_configured`), or the git provider refuses it access (`git_integration_unauthorized`). The branch has not completed initialization (`branch_not_ready`); poll its initialization_status before retrying. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"A field is invalid; `errors` names it. A `git_branch` the repository does not have is `not_found`. A direct push to a protected git branch is `not_supported` on `push_type`.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"502":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The git provider failed or answered unexpectedly (`upstream_error`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"504":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The git provider did not answer in time (`upstream_timeout`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}}},"security":[{"bearerAuth":[]}],"summary":"Push to git integration","tags":["Git Integrations"]}},"/v2/branches/{branchId}/languages":{"get":{"description":"Lists the branch's languages: the source language first, then the target languages by language code. `file_slug` is this project's own setting; `is_source`, `lina_role` and the fallback come from the stack language and are the same in every project of the stack. Requires project-level languages view permission.","operationId":"listProjectLanguages","parameters":[{"description":"Unique identifier of the branch.","example":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"branchId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project branch, a valid value would be : prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectLanguageFilter"}}},"description":"Filters the list: URL-encoded JSON of the schema `ProjectLanguageFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. This list cannot be sorted. An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators |\n|---|---|---|\n| `project_language[is_source]` | boolean | `_true` `_false` |\n| `project_language[language_code]` | language code | `_eq` `_ne` `_in` `_nin` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` `_gt` |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectLanguageCollection"}}},"description":"Project languages retrieved successfully.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List project languages","tags":["Project Languages"]},"post":{"description":"Adds target languages to the branch in the background; poll the import at `Location` (getImport). A language the stack doesn't have yet is added to the stack as well; the stack's other projects don't get it. Languages the branch already has are skipped (`ALREADY_EXISTS`) without blocking the others. The branch must have finished its initial copy. The source language can't be changed here; switching the source is a separate action that the API doesn't offer. Requires project-level languages management permission; the import, its entries and its logs can be read with languages view permission.","operationId":"addProjectLanguages","parameters":[{"description":"Unique identifier of the branch.","example":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"branchId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project branch, a valid value would be : prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddProjectLanguages"}}},"required":true},"responses":{"202":{"content":{"application/json":{"examples":{"queued":{"description":"queued","value":{"data":{"branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","created_at":"2025-01-15T10:30:00.000Z","git_source":null,"id":"rin_0197c8f2-5a6b-7cde-8f12-3456789abcde","keys_deactivated":0,"keys_reactivated":0,"keys_renamed":0,"object_type":"IMPORT","status":"QUEUED","status_details":null,"texts_created":0,"texts_updated":0,"updated_at":"2025-01-15T10:30:00.000Z"},"job_type":"ADD_LANGUAGES","object_type":"JOB"}}},"schema":{"$ref":"#/components/schemas/AddLanguagesJob"}}},"description":"The import that adds the languages is queued.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the import that adds the languages.","schema":{"format":"uri-reference","type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The branch has not completed initialization (`branch_not_ready`); poll its initialization_status before retrying. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Add project languages","tags":["Project Languages"]}},"/v2/branches/{branchId}/languages/{languageCode}":{"delete":{"description":"Removes a target language from the branch: its files no longer include the language, and its context images, tasks and counts in this project are deleted. The texts stay in the stack, and so does the stack language unless `delete_unused_stack_language=true` is passed: then, if no other project or branch uses the language, the stack language is deleted too, with every translation in that language; this can't be undone. The source language can't be removed (409), nor a language with an active translation order (409). Requires project-level languages management permission.","operationId":"deleteProjectLanguage","parameters":[{"description":"Unique identifier of the branch.","example":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"branchId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project branch, a valid value would be : prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"}},{"description":"Language code that uniquely identifies a locale.","example":"de-AT","in":"path","name":"languageCode","required":true,"schema":{"description":"Language code that uniquely identifies a locale. Valid examples would be 'en', 'en-GB', 'de', 'de-DE' etc. according to [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).","type":"string"}},{"description":"Whether to delete the stack language, with every translation in it, after its last project or branch usage is removed. Only true or false is accepted; omission keeps the stack language.","in":"query","name":"delete_unused_stack_language","required":false,"schema":{"default":false,"example":false,"type":"boolean"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Project language removed successfully.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The language is the source language (`source_language_protected`), or a translation order for it is still active (`translation_order_pending`). The branch has not completed initialization (`branch_not_ready`); poll its initialization_status before retrying.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Remove a project language","tags":["Project Languages"]},"get":{"description":"Returns the language configured for the given branch and language code, including its file slug and fallback language. The ETag identifies this representation and can be used for conditional updates or deletion. Requires project-level languages view permission.","operationId":"getProjectLanguage","parameters":[{"description":"Unique identifier of the branch.","example":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"branchId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project branch, a valid value would be : prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"}},{"description":"Language code that uniquely identifies a locale.","example":"de-AT","in":"path","name":"languageCode","required":true,"schema":{"description":"Language code that uniquely identifies a locale. Valid examples would be 'en', 'en-GB', 'de', 'de-DE' etc. according to [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectLanguage"}}},"description":"Project language retrieved successfully.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve a project language","tags":["Project Languages"]},"patch":{"description":"Changes the language's file slug in this project (JSON merge-patch; `null` removes it). The slug is the language's part of file names, so exports and Git pushes use the new name from now on. The source language can't be changed here; switching the source is a separate action that the API doesn't offer. Requires project-level languages management permission.","operationId":"updateProjectLanguage","parameters":[{"description":"Unique identifier of the branch.","example":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"branchId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project branch, a valid value would be : prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"}},{"description":"Language code that uniquely identifies a locale.","example":"de-AT","in":"path","name":"languageCode","required":true,"schema":{"description":"Language code that uniquely identifies a locale. Valid examples would be 'en', 'en-GB', 'de', 'de-DE' etc. according to [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProjectLanguage"}},"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateProjectLanguage"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectLanguage"}}},"description":"Project language updated successfully.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Another language of the branch already uses this file slug (`already_exists` on `file_slug`). The branch has not completed initialization (`branch_not_ready`); poll its initialization_status before retrying.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Update a project language","tags":["Project Languages"]}},"/v2/branches/{branchId}/lina-executions":{"get":{"description":"Lists the LINA pre-translations started through the API on this branch, newest first, for the languages the key may read, as far back as the plan keeps LINA run history. Runs started in the app or by automations are not listed. Requires stack-level texts view permission.","operationId":"listLinaExecutions","parameters":[{"in":"path","name":"branchId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project branch, a valid value would be : prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinaExecutionFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `LinaExecutionFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `lina_execution[created_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `lina_execution[id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `lina_execution[status]` | QUEUED \\| PROCESSING \\| SUCCEEDED \\| PARTIALLY_SUCCEEDED \\| FAILED \\| CANCELLED \\| SKIPPED | `_eq` `_ne` `_in` `_nin` | – |\n| `lina_execution[updated_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinaExecutionCollection"}}},"description":"The runs.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List LINA runs","tags":["LINA Executions"]},"post":{"description":"Pre-translates the given segments into the target languages with the stack's LINA, in the background, one run per language, like \"Pre-translate with LINA\" in the app; poll each run at its URL (`Location` names the first). Every selected text that is translatable and has a source text is translated, also ones already translated, unless `only_empty` limits it to texts without a translation. Without `segment_ids`, every segment of the branch is selected. Results become `AI_TRANSLATED` and cost AI credits. A run with nothing to translate ends as `SKIPPED`. Needs a LINA on the stack and a plan that keeps LINA run history. Requires stack-level texts management permission and full access to every target language.","operationId":"createLinaExecution","parameters":[{"in":"path","name":"branchId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project branch, a valid value would be : prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLinaExecution"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinaExecutionJob"}}},"description":"The runs were started.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the first run.","schema":{"format":"uri-reference","type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`branch_not_ready`: the branch is still being set up. `conflict`: the stack has no LINA, its LINA may only be used in other stacks, or the plan keeps no LINA run history. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"A target language isn't a language of the branch (`not_found`), is its source language (`not_supported`) or is listed twice (`uniqueItems`); a segment isn't in the branch (`not_found`) or is listed twice (`uniqueItems`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Pre-translate with LINA","tags":["LINA Executions"]}},"/v2/branches/{branchId}/resources":{"get":{"description":"Returns a cursor-paginated list of the resources in the given project branch. Folders are listed only when the filter has a `resource[type]` condition; `{\"where\":{\"_and\":[{\"resource[type]\":{\"_in\":[\"FILE\",\"FOLDER\"]}}]}}` lists files and folders. Use `filter` to search and sort resources; iterate by passing `next_cursor` of the previous page via the `cursor` query parameter until `has_more` is false. Requires project-level resource view permission.","operationId":"listResources","parameters":[{"description":"Unique identifier of the project branch.","example":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"branchId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project branch, a valid value would be : prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `ResourceFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `resource[format]` | ANDROID_XML \\| IOS_STRINGS \\| IOS_STRINGSDICT \\| IOS_STRINGS_CATALOG \\| STANDARD_PROPERTIES \\| GETTEXT_PO \\| WINDOWS_RESX \\| QT_LINGUIST_TS \\| DEFINE_PHP \\| STANDARD_INI \\| STANDARD_ARB \\| RAILS_YAML \\| SYMFONY_YAML \\| STANDARD_JSON \\| STORYBLOK_JSON \\| ANGULAR_TRANSLATE_JSON \\| CHROME_I18N_JSON \\| GO_I18N_JSON \\| I18NEXT_JSON \\| REACT_INTL_JSON \\| STANDARD_CSV \\| SINGLE_LANGUAGE_CSV \\| KEY_VALUE_CSV \\| STANDARD_XLIFF \\| STANDARD_XLIFF_2 \\| STANDARD_TXT \\| TWINE_TXT \\| STANDARD_MARKDOWN \\| STANDARD_HTML \\| FIGMA \\| ZENDESK \\| STORYBLOK \\| CONTENTFUL \\| SUBTITLE_SRT \\| SUBTITLE_VTT \\| HUBSPOT \\| STRIPO \\| CRISP_HELPDESK \\| DOCX \\| PPTX \\| ODT \\| ODP \\| VUE_I18N_JSON | `_eq` `_ne` `_in` `_nin` | – |\n| `resource[id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `resource[name]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | yes |\n| `resource[path]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | yes |\n| `resource[type]` | FILE \\| FOLDER | `_eq` `_ne` `_in` `_nin` | – |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceCollection"}}},"description":"Resources retrieved successfully.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List resources","tags":["Resources"]},"post":{"description":"Creates an empty file in the branch, with any missing parent folders and an entry for every project language; it has no keys yet. `path` is a pattern containing `%{locale}`. Only the project's own formats that support empty files are accepted (see getProjectCapabilities); documents, subtitles and integration content are created by importing them. Requires project-level resource management permission.","operationId":"createResource","parameters":[{"description":"Public identifier of the branch.","in":"path","name":"branchId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project branch, a valid value would be : prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResource"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}},"description":"Empty resource created; Location identifies its canonical URL.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"Canonical URL of the created resource.","schema":{"type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Path already exists (`already_exists`), branch is not ready (`branch_not_ready`), or a file ancestor/concurrent tree change prevents creation (`conflict`). An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Create a resource","tags":["Resources"]}},"/v2/branches/{branchId}/segments":{"get":{"description":"Lists the segments that the keys of a branch use, each once, oldest first, with their texts in the branch's languages. `language_codes` limits the texts to the languages you name, and text filters apply to those languages. Deactivated segments, which are in no file, aren't listed. Requires stack-level segment and text view permissions.","operationId":"listSegments","parameters":[{"description":"Public identifier of the branch.","in":"path","name":"branchId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project branch, a valid value would be : prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"}},{"description":"Language codes of the texts to show, separated by commas; the branch's languages when left out.","example":["de","fr"],"explode":false,"in":"query","name":"language_codes","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `SegmentFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `key[key]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | – |\n| `key[resource_id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `segment[created_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `segment[description]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | – |\n| `segment[id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `segment[is_plural]` | boolean | `_true` `_false` | – |\n| `segment[label_ids]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `segment[updated_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `text[content]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | – |\n| `text[content_updated_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | – |\n| `text[stage]` | NOT_READY \\| NEEDS_EDIT \\| NEEDS_REVIEW \\| DONE | `_eq` `_ne` `_in` `_nin` | – |\n| `text[status]` | BLOCKED \\| NEW \\| STALE \\| REJECTED \\| DRAFT \\| AI_TRANSLATED \\| TRANSLATED \\| QA_PASSED \\| QA_FLAGGED \\| APPROVED \\| NOT_TRANSLATABLE | `_eq` `_ne` `_in` `_nin` | – |\n| `text[updated_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | – |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentCollection"}}},"description":"Retrieved successfully.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List segments","tags":["Segments"]}},"/v2/branches/{branchId}/segments/bulk-transition":{"post":{"description":"Changes the status of up to 150 texts of a branch at once. Either all changes are made or none: the first problem stops the batch, and its error points at the item. Requires stack-level text management and segment and text view permissions.","operationId":"transitionSegmentsBulk","parameters":[{"description":"Public identifier of the branch.","in":"path","name":"branchId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project branch, a valid value would be : prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransitionSegmentsBulk"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentList"}}},"description":"The segments after the change, one per item of the request and in its order.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`conflict`: another change to a segment's texts is in progress (retry). An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Change the statuses of texts in a batch","tags":["Segments"]}},"/v2/branches/{branchId}/segments/bulk-update":{"post":{"description":"Changes up to 150 segments of a branch at once, each item with the same fields as updateSegment. The branch's project supplies the placeholder settings and automations. Either all changes are made or none: the first problem stops the batch, and its error points at the item. Requires stack-level segment and text view permissions, segment management to change segments and text management to change texts.","operationId":"updateSegmentsBulk","parameters":[{"description":"Public identifier of the branch.","in":"path","name":"branchId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project branch, a valid value would be : prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSegmentsBulk"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentList"}}},"description":"The segments after the change, in the order of the request.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`conflict`: the project's edit settings refer to something that no longer exists, or another change to a segment's texts is in progress (retry). An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Update segments in a batch","tags":["Segments"]}},"/v2/branches/{branchId}/set-default":{"post":{"description":"Makes the branch the project's default branch; the previous default becomes a normal branch. Content-platform integrations (Contentful, Zendesk, …) sync with the default branch, and Git auto-push uses its default-branch setting for it. The branch must have finished its initial copy (409 `branch_not_ready`). Does nothing if the branch is already the default. Requires project-level settings management permission.","operationId":"setDefaultBranch","parameters":[{"description":"Unique identifier of the branch.","example":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"branchId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project branch, a valid value would be : prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^prb_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Branch"}}},"description":"Default branch set successfully.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The branch has not completed initialization (`branch_not_ready`); poll its initialization_status before retrying. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The Idempotency-Key belongs to a different request (`idempotency_key_mismatch`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Set the default branch","tags":["Branches"]}},"/v2/context-images/{contextImageId}":{"delete":{"description":"Deletes a context image and detaches it from all segments. The upload still counts toward the month's context image uploads. This can't be undone. Send the ETag from getContextImage as If-Match to make sure nobody changed the image in between. Requires project-level context-image management permission.","operationId":"deleteContextImage","parameters":[{"description":"Unique identifier of the context image.","example":"ci_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"contextImageId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a context image, a valid value would be : ci_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^ci_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Context image deleted successfully.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Delete a context image","tags":["Context Images"]},"get":{"description":"Returns one context image. `attachments` lists the segments it's attached to, with their highlight boxes; a match LingoHub only suggested counts once someone accepts it. The ETag covers the attachments too, so it changes when segments are attached or detached, including by text recognition after an upload. Requires project-level context-image view permission.","operationId":"getContextImage","parameters":[{"description":"Unique identifier of the context image.","example":"ci_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"contextImageId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a context image, a valid value would be : ci_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^ci_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContextImage"}}},"description":"Context image retrieved successfully.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve a context image","tags":["Context Images"]},"patch":{"description":"Changes a context image's name and description with JSON merge-patch: leaving out a field keeps it, and `description: null` clears it. The name can't be empty. Send the ETag from getContextImage as If-Match to make sure nobody changed the image in between. Requires project-level context-image management permission.","operationId":"updateContextImage","parameters":[{"description":"Unique identifier of the context image.","example":"ci_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"contextImageId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a context image, a valid value would be : ci_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^ci_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateContextImage"}},"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateContextImage"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContextImage"}}},"description":"Context image updated successfully.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Update a context image","tags":["Context Images"]}},"/v2/context-images/{contextImageId}/attach":{"post":{"description":"Attaches the image to segments of its project, at each segment's text in the image's language. Name the segments in `segments`, or send `rendered_strings` to let LingoHub find them, as on upload. Attaching is idempotent: an attached segment stays attached, and a suggestion becomes an attachment. `highlight_boxes` replaces that segment's boxes; leaving it out keeps them. A segment keeps its three most recently linked images; attaching a fourth detaches the oldest, possibly from another image. Requires project-level context-image management permission.","operationId":"attachContextImage","parameters":[{"description":"Unique identifier of the context image.","example":"ci_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"contextImageId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a context image, a valid value would be : ci_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^ci_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachContextImage"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContextImage"}}},"description":"Context image attached successfully.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"A value is invalid; `errors` points at each one. A segment of another project, or one without a text in the image's language, is `not_found` on its `segment_id`; a box outside the image is `maximum` on its `width` or `height`.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Attach a context image to segments","tags":["Context Images"]}},"/v2/context-images/{contextImageId}/detach":{"post":{"description":"Detaches the image from the given segments; their highlight boxes go with it. Segments the image isn't attached to are skipped, so repeating the call changes nothing. Suggestions for these segments stay unless `include_suggestions` is true. The image itself stays, even without attachments. Requires project-level context-image management permission.","operationId":"detachContextImage","parameters":[{"description":"Unique identifier of the context image.","example":"ci_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"contextImageId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a context image, a valid value would be : ci_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^ci_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetachContextImage"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContextImage"}}},"description":"Context image detached successfully.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Detach a context image from segments","tags":["Context Images"]}},"/v2/distribution-releases/{distributionReleaseId}":{"get":{"description":"Returns one release, the same object as in listDistributionReleases. Requires project-level settings management permission.","operationId":"getDistributionRelease","parameters":[{"in":"path","name":"distributionReleaseId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^rel_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistributionRelease"}}},"description":"The release.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve a distribution release","tags":["Distribution Releases"]}},"/v2/distributions/{distributionId}":{"get":{"description":"Returns one distribution, the same object as in listDistributions. List its releases to see which one is live. Requires project-level settings management permission.","operationId":"getDistribution","parameters":[{"in":"path","name":"distributionId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^dtb_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Distribution"}}},"description":"The distribution.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve a distribution","tags":["Distributions"]}},"/v2/distributions/{distributionId}/releases":{"get":{"description":"Lists the distribution's releases, newest first. The live release, the one the CDN serves, is the one with `activated_at` set; a distribution has at most one. Requires project-level settings management permission.","operationId":"listDistributionReleases","parameters":[{"in":"path","name":"distributionId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^dtb_[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}$","type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistributionReleaseFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `DistributionReleaseFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `distribution_release[activated_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | – |\n| `distribution_release[archive_size_kib]` | integer | `_eq` `_ne` `_in` `_nin` `_gt` `_lt` `_gte` `_lte` `_within` `_null` `_nnull` | – |\n| `distribution_release[branch_name]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | yes |\n| `distribution_release[created_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `distribution_release[file_count]` | integer | `_eq` `_ne` `_in` `_nin` `_gt` `_lt` `_gte` `_lte` `_within` `_null` `_nnull` | – |\n| `distribution_release[id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `distribution_release[name]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | yes |\n| `distribution_release[status]` | PROCESSING \\| SUCCEEDED \\| FAILED | `_eq` `_ne` `_in` `_nin` | – |\n| `distribution_release[updated_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistributionReleaseCollection"}}},"description":"The distribution's releases.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List distribution releases","tags":["Distribution Releases"]}},"/v2/export-entries/{exportEntryId}":{"get":{"description":"Returns one export entry, the same object as in listExportEntries. A succeeded entry gets a fresh `download_url`, valid for 24 hours, on every read. Requires stack-level resource view permission.","operationId":"getExportEntry","parameters":[{"description":"Unique identifier of the export entry.","example":"ree_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"exportEntryId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a resource export entry, a valid value would be : ree_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^ree_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportEntry"}}},"description":"The export entry.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve an export entry","tags":["Exports"]}},"/v2/exports/{exportId}":{"get":{"description":"Returns one export. Poll it while `status` is `QUEUED` or `PROCESSING`. Once it has `SUCCEEDED`, `download_url` points to the zip for 24 hours; reading the export again gives a fresh URL. An export stops at its first failed file and ends `FAILED`; `PARTIALLY_SUCCEEDED` only happens for git and content-platform pushes where some items failed. Requires stack-level resource view permission.","operationId":"getExport","parameters":[{"in":"path","name":"exportId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a resource export, a valid value would be : reg_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^reg_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Export"}}},"description":"The export.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve an export","tags":["Exports"]}},"/v2/exports/{exportId}/entries":{"get":{"description":"Lists the export's files, one entry per file and language (one per file for formats that hold every language), in the order they were queued. Files are exported one at a time; after the first file that fails, the rest are `SKIPPED` and the export ends `FAILED`. Every entry that succeeded has its own `download_url`, valid for 24 hours, even when the export failed. Requires stack-level resource view permission.","operationId":"listExportEntries","parameters":[{"in":"path","name":"exportId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a resource export, a valid value would be : reg_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^reg_[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}$","type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportEntryFilter"}}},"description":"Filters the list: URL-encoded JSON of the schema `ExportEntryFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. This list cannot be sorted. An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators |\n|---|---|---|\n| `export_entry[file_path]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` |\n| `export_entry[file_size_bytes]` | integer | `_eq` `_ne` `_in` `_nin` `_gt` `_lt` `_gte` `_lte` `_within` `_null` `_nnull` |\n| `export_entry[key_count]` | integer | `_eq` `_ne` `_in` `_nin` `_gt` `_lt` `_gte` `_lte` `_within` `_null` `_nnull` |\n| `export_entry[language_code]` | language code | `_eq` `_ne` `_in` `_nin` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` `_gt` |\n| `export_entry[resource_id]` | id | `_eq` `_ne` `_in` `_nin` |\n| `export_entry[status]` | QUEUED \\| PROCESSING \\| SUCCEEDED \\| FAILED \\| SKIPPED | `_eq` `_ne` `_in` `_nin` |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportEntryCollection"}}},"description":"The export's entries.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List export entries","tags":["Exports"]}},"/v2/exports/{exportId}/logs":{"get":{"description":"Lists the export's log, oldest first, as the app shows it, including the lines of a git or content-platform push. `entry_id` names the file a line is about; lines about the whole export have none. The messages are English text for people and may change; react in code to the entry's `status` and `status_details.code` instead. Requires stack-level resource view permission.","operationId":"listExportLogs","parameters":[{"in":"path","name":"exportId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a resource export, a valid value would be : reg_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^reg_[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}$","type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportLogFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `ExportLogFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `export_log[content]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | – |\n| `export_log[created_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `export_log[entry_id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `export_log[level]` | INFO \\| WARN \\| ERROR | `_eq` `_ne` `_in` `_nin` | – |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportLogCollection"}}},"description":"The export's log.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List export logs","tags":["Exports"]}},"/v2/glossaries":{"get":{"description":"Lists the workspace's glossaries, oldest first, with the languages each one covers. A LINA uses a glossary for translation and for the terminology check. Requires workspace-level glossaries view permission.","operationId":"listGlossaries","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlossaryFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `GlossaryFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `glossary[created_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `glossary[id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `glossary[name]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | yes |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlossaryCollection"}}},"description":"The glossaries.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List glossaries","tags":["Glossaries"]},"post":{"description":"Creates a glossary with the given name and languages; add terms to it with createTerm. Names don't have to be unique. To use it for translation, set it as a LINA's `glossary_id`. Requires workspace-level glossaries management permission.","operationId":"createGlossary","parameters":[{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGlossary"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Glossary"}}},"description":"The glossary was created.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the new glossary.","schema":{"format":"uri-reference","type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"A language isn't a supported locale (`enum`) or is listed twice (`uniqueItems`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Create a glossary","tags":["Glossaries"]}},"/v2/glossaries/{glossaryId}":{"delete":{"description":"Deletes a glossary with all its terms. LINAs that used it continue without a glossary: translations no longer get its terms as context, and the terminology check no longer uses them. This can't be undone. Send the ETag from getGlossary as If-Match to make sure nobody changed the glossary in between. Requires workspace-level glossaries management permission.","operationId":"deleteGlossary","parameters":[{"description":"Unique identifier of the glossary.","example":"gls_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"glossaryId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a glossary, a valid value would be : gls_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^gls_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"The glossary was deleted.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Delete a glossary","tags":["Glossaries"]},"get":{"description":"Returns one glossary, the same object as in listGlossaries. Its terms are listed with listTerms. Requires workspace-level glossaries view permission.","operationId":"getGlossary","parameters":[{"description":"Unique identifier of the glossary.","example":"gls_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"glossaryId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a glossary, a valid value would be : gls_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^gls_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Glossary"}}},"description":"The glossary.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve a glossary","tags":["Glossaries"]},"patch":{"description":"Changes a glossary with JSON merge-patch: leaving out a field keeps it; `language_codes` replaces the whole list. Removing a language deletes none of its terms: their forms in that language stay and are still used for translation and the terminology check. Sending only the current values changes nothing. Send the ETag from getGlossary as If-Match to make sure nobody changed the glossary in between. Requires workspace-level glossaries management permission.","operationId":"updateGlossary","parameters":[{"description":"Unique identifier of the glossary.","example":"gls_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"glossaryId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a glossary, a valid value would be : gls_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^gls_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateGlossary"}},"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateGlossary"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Glossary"}}},"description":"The glossary.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"A language isn't a supported locale (`enum`) or is listed twice (`uniqueItems`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Update a glossary","tags":["Glossaries"]}},"/v2/glossaries/{glossaryId}/terms":{"get":{"description":"Lists the glossary's terms, oldest first, each with its forms in every language. Filter on a form's text or language to find terms, e.g. `term_form[text]` containing \"checkout\". Requires workspace-level glossaries view permission.","operationId":"listTerms","parameters":[{"description":"Unique identifier of the glossary.","example":"gls_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"glossaryId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a glossary, a valid value would be : gls_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^gls_[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}$","type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TermFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `TermFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `term[created_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `term[enforcement_status]` | ENFORCED \\| INFORMATIONAL | `_eq` `_ne` `_in` `_nin` | – |\n| `term[id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `term[type]` | TRANSLATABLE \\| UNTRANSLATABLE | `_eq` `_ne` `_in` `_nin` | – |\n| `term_form[id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `term_form[language_code]` | language code | `_eq` `_ne` `_in` `_nin` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` `_gt` | – |\n| `term_form[text]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | – |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TermCollection"}}},"description":"The terms.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List terms","tags":["Terms"]},"post":{"description":"Creates a term with its forms in the glossary's languages. A language has at most one preferred form, which languages without a form of their own can inherit (`inherited_by`); an untranslatable term's forms have no language. Left-out settings get the same defaults as in the app. Requires workspace-level glossaries management permission.","operationId":"createTerm","parameters":[{"description":"Unique identifier of the glossary.","example":"gls_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"glossaryId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a glossary, a valid value would be : gls_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^gls_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTerm"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Term"}}},"description":"The term was created.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the new term.","schema":{"format":"uri-reference","type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"A form's language or an inheriting language isn't a supported locale (`enum`) or not a language of the glossary (`not_found`); `AUTOMATIC` matching for a language without it, or another rule of the forms (`not_supported`). `errors` point at the form field.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Create a term","tags":["Terms"]}},"/v2/import-entries/{importEntryId}":{"get":{"description":"Returns one import entry, the same object as in listImportEntries. The import's changes point to their entry with `entry_id`. Requires stack-level resource view permission; the entries of an import that adds languages can also be read with languages view permission.","operationId":"getImportEntry","parameters":[{"description":"Unique identifier of the import entry.","example":"rie_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"importEntryId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a resource import entry, a valid value would be : rie_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^rie_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportEntry"}}},"description":"The import entry.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve an import entry","tags":["Imports"]}},"/v2/imports/{importId}":{"get":{"description":"Returns one import. Poll it while `status` is `QUEUED` or `PROCESSING`; the counters are filled once it finishes. An import that adds languages can also be read with languages view permission. Its files are listed at listImportEntries. Requires stack-level resource view permission.","operationId":"getImport","parameters":[{"in":"path","name":"importId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a resource import, a valid value would be : rin_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^rin_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Import"}}},"description":"The import.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve an import","tags":["Imports"]}},"/v2/imports/{importId}/changes":{"get":{"description":"Lists what the import changed, one item per segment and file, in the order it happened: the key (created, renamed, moved to another file, deactivated or reactivated) and the texts in each language (created, content or status changed, or outdated because the source changed). `entry_id` names the file. `segment_id` and `key_id` turn null once the segment or key no longer exists; names, paths and contents stay. Requires stack-level resource, segment, key and text view permission; texts are listed only in the languages the API key can read.","operationId":"listImportChanges","parameters":[{"in":"path","name":"importId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a resource import, a valid value would be : rin_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^rin_[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}$","type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportChangeFilter"}}},"description":"Filters the list: URL-encoded JSON of the schema `ImportChangeFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. This list cannot be sorted. An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators |\n|---|---|---|\n| `import_change[entry_id]` | id | `_eq` `_ne` `_in` `_nin` |\n| `import_change[key_change]` | CREATED \\| RENAMED \\| MOVED \\| REACTIVATED \\| DEACTIVATED | `_eq` `_ne` `_in` `_nin` |\n| `import_change[language_code]` | language code | `_eq` `_ne` `_in` `_nin` |\n| `import_change[segment_id]` | id | `_eq` `_ne` `_in` `_nin` |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportChangeCollection"}}},"description":"The import's changes.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List import changes","tags":["Imports"]}},"/v2/imports/{importId}/entries":{"get":{"description":"Lists the import's entries, one per file and language, in the order they were queued. Files are imported one at a time, the source language first; after the first file that fails, the remaining ones are `SKIPPED`, so retry those after fixing the failed one. `UNCHANGED` means the file hadn't changed since its last import and was left alone. Requires stack-level resource view permission; the entries of an import that adds languages can also be read with languages view permission.","operationId":"listImportEntries","parameters":[{"in":"path","name":"importId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a resource import, a valid value would be : rin_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^rin_[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}$","type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportEntryFilter"}}},"description":"Filters the list: URL-encoded JSON of the schema `ImportEntryFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. This list cannot be sorted. An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators |\n|---|---|---|\n| `import_entry[file_path]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` |\n| `import_entry[file_size_bytes]` | integer | `_eq` `_ne` `_in` `_nin` `_gt` `_lt` `_gte` `_lte` `_within` `_null` `_nnull` |\n| `import_entry[language_code]` | language code | `_eq` `_ne` `_in` `_nin` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` `_gt` |\n| `import_entry[resource_id]` | id | `_eq` `_ne` `_in` `_nin` |\n| `import_entry[status]` | QUEUED \\| PROCESSING \\| SUCCEEDED \\| FAILED \\| SKIPPED \\| UNCHANGED | `_eq` `_ne` `_in` `_nin` |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportEntryCollection"}}},"description":"The import's entries.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List import entries","tags":["Imports"]}},"/v2/imports/{importId}/logs":{"get":{"description":"Lists the import's log, oldest first, as the app shows it. `entry_id` names the file a line is about; lines about the whole import have none. The messages are English text for people and may change; react in code to the entry's `status` and `status_details.code` instead. Requires stack-level resource view permission; the log of an import that adds languages can also be read with languages view permission.","operationId":"listImportLogs","parameters":[{"in":"path","name":"importId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a resource import, a valid value would be : rin_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^rin_[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}$","type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportLogFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `ImportLogFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `import_log[content]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | – |\n| `import_log[created_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `import_log[entry_id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `import_log[level]` | INFO \\| WARN \\| ERROR | `_eq` `_ne` `_in` `_nin` | – |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportLogCollection"}}},"description":"The import's log.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List import logs","tags":["Imports"]}},"/v2/integration-authentications":{"get":{"description":"Lists the workspace's connections to git hosts and content platforms, newest first. Git and content integrations use them to reach the provider. Credentials are never returned. Without integration management permission or settings management on a stack, only content-platform connections are listed: you pick one when creating a content project. Requires workspace-level integration management permission, stack-level settings management permission on any stack, or workspace-level stack management permission.","operationId":"listIntegrationAuthentications","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationAuthenticationFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `IntegrationAuthenticationFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `integration_authentication[created_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `integration_authentication[id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `integration_authentication[is_self_hosted]` | boolean | `_true` `_false` | yes |\n| `integration_authentication[name]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | yes |\n| `integration_authentication[provider]` | GITHUB \\| BITBUCKET \\| GITLAB \\| AZURE \\| AWS_CODE_COMMIT \\| STORYBLOK \\| CONTENTFUL \\| ZENDESK \\| HUBSPOT \\| STRIPO \\| CRISP_HELPDESK | `_eq` `_ne` `_in` `_nin` | – |\n| `integration_authentication[status]` | ACTIVE \\| SUSPENDED \\| REVOKED | `_eq` `_ne` `_in` `_nin` | – |\n| `integration_authentication[type]` | MANUAL \\| OAUTH \\| INSTALLATION | `_eq` `_ne` `_in` `_nin` | – |\n| `integration_authentication[updated_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationAuthenticationCollection"}}},"description":"Integration authentications retrieved.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List integration authentications","tags":["Integration Authentications"]},"post":{"description":"Stores a connection to a git host or content platform from a token or keys you enter. Content-platform credentials are checked with the provider first; git tokens are stored as given and only fail when an integration uses them. GitHub is connected by installing the GitHub App (getGitHubInstallationLink). Requires workspace-level integration management permission.","operationId":"createIntegrationAuthentication","parameters":[{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIntegrationAuthentication"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"created_at":"2025-01-15T10:30:00.123Z","id":"iau_0197c8f2-5a6b-7cde-8f12-3456789abcde","is_self_hosted":false,"name":"Company GitLab","object_type":"INTEGRATION_AUTHENTICATION","provider":"GITLAB","provider_origin":"https://gitlab.com","provider_region":null,"status":"ACTIVE","type":"MANUAL","updated_at":"2025-01-15T10:30:00.123Z"},"schema":{"$ref":"#/components/schemas/IntegrationAuthentication"}}},"description":"Authentication stored.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"502":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The content platform could not check the credentials (`upstream_error`). Nothing is stored; retry later.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Create an integration authentication","tags":["Integration Authentications"]}},"/v2/integration-authentications/{integrationAuthenticationId}":{"delete":{"description":"Deletes the connection, and with it the git or content integration of every project that uses it; the projects and their texts stay. The credentials aren't revoked at the provider: revoke the token or uninstall the GitHub App there yourself. Send the ETag from getIntegrationAuthentication as If-Match to make sure nobody changed it in between. Requires workspace-level integration management permission.","operationId":"deleteIntegrationAuthentication","parameters":[{"in":"path","name":"integrationAuthenticationId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^iau_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Authentication deleted.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Delete an integration authentication","tags":["Integration Authentications"]},"get":{"description":"Returns one connection, the same object as in listIntegrationAuthentications. Requires workspace-level integration management permission, stack-level settings management permission on any stack, or workspace-level stack management permission (content-platform connections only).","operationId":"getIntegrationAuthentication","parameters":[{"in":"path","name":"integrationAuthenticationId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^iau_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationAuthentication"}}},"description":"Integration authentication retrieved.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve an integration authentication","tags":["Integration Authentications"]},"patch":{"description":"Renames the connection; nothing else about it changes. Sending the same name or an empty object writes nothing. Send the ETag from getIntegrationAuthentication as If-Match to make sure nobody changed it in between. Requires workspace-level integration management permission.","operationId":"updateIntegrationAuthentication","parameters":[{"in":"path","name":"integrationAuthenticationId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^iau_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIntegrationAuthentication"}},"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateIntegrationAuthentication"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationAuthentication"}}},"description":"Authentication metadata updated.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Rename an integration authentication","tags":["Integration Authentications"]}},"/v2/integration-authentications/{integrationAuthenticationId}/azure-branches":{"get":{"description":"Lists the branches of an Azure repository, one page at a time, each with its latest commit. Pass a branch's `commit_sha` to listAzureDirectoryEntries to browse its folders. Azure doesn't report branch protection, so `is_protected` is always null. Requires workspace-level stack management or integration management permission, or stack-level settings management permission on any stack.","operationId":"listAzureBranches","parameters":[{"in":"path","name":"integrationAuthenticationId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^iau_[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}$","type":"string"}},{"description":"The repository's `namespace` from listAzureRepositories.","example":"company/App","in":"query","name":"repository_namespace","required":true,"schema":{"maxLength":4096,"minLength":0,"type":"string"}},{"description":"The repository's `name`.","example":"app","in":"query","name":"repository_name","required":true,"schema":{"maxLength":1024,"minLength":0,"type":"string"}},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"commit_sha":"e89d9270a7c0b3f1d2e4f5a6b7c8d9e0f1a2b3c4","git_branch":"main","is_protected":null,"object_type":"GIT_PROVIDER_BRANCH"}],"has_more":true,"next_cursor":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","object_type":"LIST"},"schema":{"$ref":"#/components/schemas/GitProviderBranchCollection"}}},"description":"Provider discovery page retrieved.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`git_integration_unauthorized`: the git host refused the connection's credentials, or the GitHub App installation is suspended or uninstalled.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"502":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_error`: the git host failed, or answered with more or other data than LingoHub accepts.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"504":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_timeout`: the git host didn't answer in time.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}}},"security":[{"bearerAuth":[]}],"summary":"List Azure branches","tags":["Azure Integrations"]}},"/v2/integration-authentications/{integrationAuthenticationId}/azure-directory-entries":{"get":{"description":"Lists the files and folders directly inside one folder of an Azure repository at a given commit (up to 1,000; more fails with 502). Each file comes with hints, the languages and file formats its name suggests, to help you choose `path_filters`. Leave `path` empty for the root; take `commit_sha` from listAzureBranches. Requires workspace-level stack management or integration management permission, or stack-level settings management permission on any stack.","operationId":"listAzureDirectoryEntries","parameters":[{"in":"path","name":"integrationAuthenticationId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^iau_[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}$","type":"string"}},{"description":"The repository's `namespace` from listAzureRepositories.","example":"company/App","in":"query","name":"repository_namespace","required":true,"schema":{"maxLength":4096,"minLength":0,"type":"string"}},{"description":"The repository's `name`.","example":"app","in":"query","name":"repository_name","required":true,"schema":{"maxLength":1024,"minLength":0,"type":"string"}},{"description":"The branch's latest commit from listAzureBranches.","example":"e89d9270a7c0b3f1d2e4f5a6b7c8d9e0f1a2b3c4","in":"query","name":"commit_sha","required":true,"schema":{"pattern":"[0-9a-f]{40}|[0-9a-f]{64}","type":"string"}},{"description":"The folder, relative to the repository root, without leading or trailing slashes; empty for the root.","example":"locales","in":"query","name":"path","required":false,"schema":{"default":"","maxLength":4096,"minLength":0,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"detected_language_codes":["en"],"object_type":"GIT_DIRECTORY_ENTRY","path":"locales/en.json","possible_project_types":["STANDARD_JSON","I18NEXT_JSON"],"type":"FILE"}],"has_more":false,"next_cursor":null,"object_type":"LIST"},"schema":{"$ref":"#/components/schemas/GitDirectoryEntryCollection"}}},"description":"Provider discovery results retrieved.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`git_integration_unauthorized`: the git host refused the connection's credentials, or the GitHub App installation is suspended or uninstalled.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"502":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_error`: the git host failed, or answered with more or other data than LingoHub accepts.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"504":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_timeout`: the git host didn't answer in time.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}}},"security":[{"bearerAuth":[]}],"summary":"List Azure directory entries","tags":["Azure Integrations"]}},"/v2/integration-authentications/{integrationAuthenticationId}/azure-organizations":{"get":{"description":"Lists the Azure DevOps organizations the connection can see, all at once (up to 1,000; more fails with 502). Pass an organization's `name` to listAzureProjects. The connection's token must be allowed to read the user's profile. Requires workspace-level stack management or integration management permission, or stack-level settings management permission on any stack.","operationId":"listAzureOrganizations","parameters":[{"in":"path","name":"integrationAuthenticationId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^iau_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"key":"eb6e4656-77fc-42a1-9181-4c6d8e9da5d1","name":"company","object_type":"AZURE_ORGANIZATION"}],"has_more":false,"next_cursor":null,"object_type":"LIST"},"schema":{"$ref":"#/components/schemas/AzureOrganizationCollection"}}},"description":"Provider organizations retrieved.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`git_integration_unauthorized`: the git host refused the connection's credentials, or the GitHub App installation is suspended or uninstalled.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"502":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_error`: the git host failed, or answered with more or other data than LingoHub accepts.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"504":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_timeout`: the git host didn't answer in time.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}}},"security":[{"bearerAuth":[]}],"summary":"List Azure organizations","tags":["Azure Integrations"]}},"/v2/integration-authentications/{integrationAuthenticationId}/azure-projects":{"get":{"description":"Lists the projects of an Azure DevOps organization, one page at a time in Azure's order. Pass a project's `key` or `name` as `project_key` to listAzureRepositories. Requires workspace-level stack management or integration management permission, or stack-level settings management permission on any stack.","operationId":"listAzureProjects","parameters":[{"in":"path","name":"integrationAuthenticationId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^iau_[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}$","type":"string"}},{"description":"The organization's `name` from listAzureOrganizations.","example":"company","in":"query","name":"organization","required":true,"schema":{"maxLength":1024,"minLength":0,"type":"string"}},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AzureProjectCollection"}}},"description":"Provider discovery page retrieved.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`git_integration_unauthorized`: the git host refused the connection's credentials, or the GitHub App installation is suspended or uninstalled.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"502":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_error`: the git host failed, or answered with more or other data than LingoHub accepts.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"504":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_timeout`: the git host didn't answer in time.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}}},"security":[{"bearerAuth":[]}],"summary":"List Azure projects","tags":["Azure Integrations"]}},"/v2/integration-authentications/{integrationAuthenticationId}/azure-repositories":{"get":{"description":"Lists all repositories of an Azure DevOps project at once (up to 1,000; more fails with 502). Pass a repository's `namespace` and `name` to createProjectGitIntegration and to the branch and folder lookups. Requires workspace-level stack management or integration management permission, or stack-level settings management permission on any stack.","operationId":"listAzureRepositories","parameters":[{"in":"path","name":"integrationAuthenticationId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^iau_[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}$","type":"string"}},{"description":"The organization's `name` from listAzureOrganizations.","example":"company","in":"query","name":"organization","required":true,"schema":{"maxLength":1024,"minLength":0,"type":"string"}},{"description":"The project's `key` or `name` from listAzureProjects.","example":"App","in":"query","name":"project_key","required":true,"schema":{"maxLength":1024,"minLength":0,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"name":"app","namespace":"company/App","object_type":"GIT_REPOSITORY","url":"https://dev.azure.com/company/App/_git/app"}],"has_more":false,"next_cursor":null,"object_type":"LIST"},"schema":{"$ref":"#/components/schemas/GitRepositoryCollection"}}},"description":"Provider discovery results retrieved.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`git_integration_unauthorized`: the git host refused the connection's credentials, or the GitHub App installation is suspended or uninstalled.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"502":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_error`: the git host failed, or answered with more or other data than LingoHub accepts.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"504":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_timeout`: the git host didn't answer in time.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}}},"security":[{"bearerAuth":[]}],"summary":"List Azure repositories","tags":["Azure Integrations"]}},"/v2/integration-authentications/{integrationAuthenticationId}/bitbucket-branches":{"get":{"description":"Lists the branches of a Bitbucket repository, one page at a time, each with its latest commit. Pass a branch's `commit_sha` to listBitbucketDirectoryEntries to browse its folders. Bitbucket doesn't report branch protection, so `is_protected` is always null. Requires workspace-level stack management or integration management permission, or stack-level settings management permission on any stack.","operationId":"listBitbucketBranches","parameters":[{"in":"path","name":"integrationAuthenticationId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^iau_[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}$","type":"string"}},{"description":"The workspace slug.","example":"company","in":"query","name":"repository_namespace","required":true,"schema":{"maxLength":4096,"minLength":0,"type":"string"}},{"description":"The repository's `name`.","example":"app","in":"query","name":"repository_name","required":true,"schema":{"maxLength":1024,"minLength":0,"type":"string"}},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"commit_sha":"e89d9270a7c0b3f1d2e4f5a6b7c8d9e0f1a2b3c4","git_branch":"main","is_protected":null,"object_type":"GIT_PROVIDER_BRANCH"}],"has_more":true,"next_cursor":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","object_type":"LIST"},"schema":{"$ref":"#/components/schemas/GitProviderBranchCollection"}}},"description":"Provider discovery page retrieved.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`git_integration_unauthorized`: the git host refused the connection's credentials, or the GitHub App installation is suspended or uninstalled.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"502":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_error`: the git host failed, or answered with more or other data than LingoHub accepts.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"504":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_timeout`: the git host didn't answer in time.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}}},"security":[{"bearerAuth":[]}],"summary":"List Bitbucket branches","tags":["Bitbucket Integrations"]}},"/v2/integration-authentications/{integrationAuthenticationId}/bitbucket-directory-entries":{"get":{"description":"Lists the files and folders directly inside one folder of a Bitbucket repository at a given commit, one page at a time. Each file comes with hints, the languages and file formats its name suggests, to help you choose `path_filters`. Leave `path` empty for the root; take `commit_sha` from listBitbucketBranches. Requires workspace-level stack management or integration management permission, or stack-level settings management permission on any stack.","operationId":"listBitbucketDirectoryEntries","parameters":[{"in":"path","name":"integrationAuthenticationId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^iau_[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}$","type":"string"}},{"description":"The workspace slug.","example":"company","in":"query","name":"repository_namespace","required":true,"schema":{"maxLength":4096,"minLength":0,"type":"string"}},{"description":"The repository's `name`.","example":"app","in":"query","name":"repository_name","required":true,"schema":{"maxLength":1024,"minLength":0,"type":"string"}},{"description":"The branch's latest commit from listBitbucketBranches.","example":"e89d9270a7c0b3f1d2e4f5a6b7c8d9e0f1a2b3c4","in":"query","name":"commit_sha","required":true,"schema":{"pattern":"[0-9a-f]{40}|[0-9a-f]{64}","type":"string"}},{"description":"The folder, relative to the repository root, without leading or trailing slashes; empty for the root.","example":"locales","in":"query","name":"path","required":false,"schema":{"default":"","maxLength":4096,"minLength":0,"type":"string"}},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GitDirectoryEntryCollection"}}},"description":"Directory entries retrieved.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`git_integration_unauthorized`: the git host refused the connection's credentials, or the GitHub App installation is suspended or uninstalled.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"502":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_error`: the git host failed, or answered with more or other data than LingoHub accepts.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"504":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_timeout`: the git host didn't answer in time.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}}},"security":[{"bearerAuth":[]}],"summary":"List Bitbucket directory entries","tags":["Bitbucket Integrations"]}},"/v2/integration-authentications/{integrationAuthenticationId}/bitbucket-repositories":{"get":{"description":"Lists the repositories of a Bitbucket workspace that the connection's user is a member of, one page at a time. Pass a repository's `namespace` and `name` to createProjectGitIntegration and to the branch and folder lookups. Requires workspace-level stack management or integration management permission, or stack-level settings management permission on any stack.","operationId":"listBitbucketRepositories","parameters":[{"in":"path","name":"integrationAuthenticationId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^iau_[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}$","type":"string"}},{"description":"The workspace's `key` (its slug) from listBitbucketWorkspaces.","example":"company","in":"query","name":"workspace_key","required":true,"schema":{"maxLength":1024,"minLength":0,"type":"string"}},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"name":"app","namespace":"company","object_type":"GIT_REPOSITORY","url":"https://bitbucket.org/company/app"}],"has_more":true,"next_cursor":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","object_type":"LIST"},"schema":{"$ref":"#/components/schemas/GitRepositoryCollection"}}},"description":"Provider discovery page retrieved.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`git_integration_unauthorized`: the git host refused the connection's credentials, or the GitHub App installation is suspended or uninstalled.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"502":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_error`: the git host failed, or answered with more or other data than LingoHub accepts.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"504":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_timeout`: the git host didn't answer in time.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}}},"security":[{"bearerAuth":[]}],"summary":"List Bitbucket repositories","tags":["Bitbucket Integrations"]}},"/v2/integration-authentications/{integrationAuthenticationId}/bitbucket-workspaces":{"get":{"description":"Lists the Bitbucket workspaces the connection can see, one page at a time. Pass a workspace's `key` (its slug) as `workspace_key` to listBitbucketRepositories. Requires workspace-level stack management or integration management permission, or stack-level settings management permission on any stack.","operationId":"listBitbucketWorkspaces","parameters":[{"in":"path","name":"integrationAuthenticationId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^iau_[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}$","type":"string"}},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BitbucketWorkspaceCollection"}}},"description":"Provider discovery page retrieved.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`git_integration_unauthorized`: the git host refused the connection's credentials, or the GitHub App installation is suspended or uninstalled.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"502":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_error`: the git host failed, or answered with more or other data than LingoHub accepts.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"504":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_timeout`: the git host didn't answer in time.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}}},"security":[{"bearerAuth":[]}],"summary":"List Bitbucket workspaces","tags":["Bitbucket Integrations"]}},"/v2/integration-authentications/{integrationAuthenticationId}/codecommit-branch":{"get":{"description":"Returns one branch of a CodeCommit repository with its latest commit, which the branch list doesn't include. Pass `commit_sha` to listCodeCommitDirectoryEntries to browse its folders. Requires workspace-level stack management or integration management permission, or stack-level settings management permission on any stack.","operationId":"getCodeCommitBranch","parameters":[{"in":"path","name":"integrationAuthenticationId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^iau_[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}$","type":"string"}},{"description":"The repository's `name` from listCodeCommitRepositories.","example":"app","in":"query","name":"repository_name","required":true,"schema":{"maxLength":1024,"minLength":0,"type":"string"}},{"description":"The branch's `git_branch` from listCodeCommitBranches.","example":"feature/translations","in":"query","name":"git_branch","required":true,"schema":{"maxLength":1024,"minLength":0,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"commit_sha":"e89d9270a7c0b3f1d2e4f5a6b7c8d9e0f1a2b3c4","git_branch":"main","is_protected":null,"object_type":"GIT_PROVIDER_BRANCH"},"schema":{"$ref":"#/components/schemas/GitProviderBranch"}}},"description":"Provider branch retrieved.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`git_integration_unauthorized`: the git host refused the connection's credentials, or the GitHub App installation is suspended or uninstalled.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`validation_failed`: a repository, branch, commit or folder that doesn't exist is `not_found` on the parameter that names it.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"502":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_error`: the git host failed, or answered with more or other data than LingoHub accepts.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"504":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_timeout`: the git host didn't answer in time.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}}},"security":[{"bearerAuth":[]}],"summary":"Retrieve a CodeCommit branch","tags":["CodeCommit Integrations"]}},"/v2/integration-authentications/{integrationAuthenticationId}/codecommit-branches":{"get":{"description":"Lists the branch names of a CodeCommit repository, one page at a time (AWS decides the page size). AWS returns names only, so `commit_sha` and `is_protected` are always null: use getCodeCommitBranch to get a branch's latest commit. Requires workspace-level stack management or integration management permission, or stack-level settings management permission on any stack.","operationId":"listCodeCommitBranches","parameters":[{"in":"path","name":"integrationAuthenticationId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^iau_[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}$","type":"string"}},{"description":"The repository's `name` from listCodeCommitRepositories.","example":"app","in":"query","name":"repository_name","required":true,"schema":{"maxLength":1024,"minLength":0,"type":"string"}},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"commit_sha":null,"git_branch":"main","is_protected":null,"object_type":"GIT_PROVIDER_BRANCH"}],"has_more":false,"next_cursor":null,"object_type":"LIST"},"schema":{"$ref":"#/components/schemas/GitProviderBranchCollection"}}},"description":"Provider discovery results retrieved.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`git_integration_unauthorized`: the git host refused the connection's credentials, or the GitHub App installation is suspended or uninstalled.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`validation_failed`: a repository, branch, commit or folder that doesn't exist is `not_found` on the parameter that names it.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"502":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_error`: the git host failed, or answered with more or other data than LingoHub accepts.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"504":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_timeout`: the git host didn't answer in time.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}}},"security":[{"bearerAuth":[]}],"summary":"List CodeCommit branches","tags":["CodeCommit Integrations"]}},"/v2/integration-authentications/{integrationAuthenticationId}/codecommit-directory-entries":{"get":{"description":"Lists the files and folders directly inside one folder of a CodeCommit repository at a given commit (up to 1,000; more fails with 502). Each file comes with hints, the languages and file formats its name suggests, to help you choose `path_filters`. Leave `path` empty for the root; get `commit_sha` from getCodeCommitBranch. Requires workspace-level stack management or integration management permission, or stack-level settings management permission on any stack.","operationId":"listCodeCommitDirectoryEntries","parameters":[{"in":"path","name":"integrationAuthenticationId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^iau_[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}$","type":"string"}},{"description":"The repository's `name` from listCodeCommitRepositories.","example":"app","in":"query","name":"repository_name","required":true,"schema":{"maxLength":1024,"minLength":0,"type":"string"}},{"description":"The branch's latest commit from getCodeCommitBranch.","example":"e89d9270a7c0b3f1d2e4f5a6b7c8d9e0f1a2b3c4","in":"query","name":"commit_sha","required":true,"schema":{"pattern":"[0-9a-f]{40}|[0-9a-f]{64}","type":"string"}},{"description":"The folder, relative to the repository root, without leading or trailing slashes; empty for the root.","example":"locales","in":"query","name":"path","required":false,"schema":{"default":"","maxLength":4096,"minLength":0,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"detected_language_codes":["en"],"object_type":"GIT_DIRECTORY_ENTRY","path":"locales/en.json","possible_project_types":["STANDARD_JSON","I18NEXT_JSON"],"type":"FILE"}],"has_more":false,"next_cursor":null,"object_type":"LIST"},"schema":{"$ref":"#/components/schemas/GitDirectoryEntryCollection"}}},"description":"Provider discovery results retrieved.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`git_integration_unauthorized`: the git host refused the connection's credentials, or the GitHub App installation is suspended or uninstalled.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`validation_failed`: a repository, branch, commit or folder that doesn't exist is `not_found` on the parameter that names it.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"502":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_error`: the git host failed, or answered with more or other data than LingoHub accepts.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"504":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_timeout`: the git host didn't answer in time.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}}},"security":[{"bearerAuth":[]}],"summary":"List CodeCommit directory entries","tags":["CodeCommit Integrations"]}},"/v2/integration-authentications/{integrationAuthenticationId}/codecommit-repositories":{"get":{"description":"Lists the CodeCommit repositories in the connection's AWS region, one page at a time (AWS decides the page size, up to 1,000). CodeCommit has no namespaces or web addresses, so `namespace` is empty and `url` null; pass the repository's `name` on. Requires workspace-level stack management or integration management permission, or stack-level settings management permission on any stack.","operationId":"listCodeCommitRepositories","parameters":[{"in":"path","name":"integrationAuthenticationId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^iau_[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}$","type":"string"}},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"name":"app","namespace":"","object_type":"GIT_REPOSITORY","url":null}],"has_more":false,"next_cursor":null,"object_type":"LIST"},"schema":{"$ref":"#/components/schemas/GitRepositoryCollection"}}},"description":"Provider discovery results retrieved.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`git_integration_unauthorized`: the git host refused the connection's credentials, or the GitHub App installation is suspended or uninstalled.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"502":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_error`: the git host failed, or answered with more or other data than LingoHub accepts.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"504":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_timeout`: the git host didn't answer in time.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}}},"security":[{"bearerAuth":[]}],"summary":"List CodeCommit repositories","tags":["CodeCommit Integrations"]}},"/v2/integration-authentications/{integrationAuthenticationId}/contentful-environments":{"get":{"description":"Lists the environments of a Contentful space, one page at a time. Pass an environment's `key` to listContentfulLanguages and to createContentfulProject, where it also becomes the name of the project's default branch. Requires workspace-level stack or integration management permission.","operationId":"listContentfulEnvironments","parameters":[{"in":"path","name":"integrationAuthenticationId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^iau_[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}$","type":"string"}},{"description":"External Contentful space key.","example":"space1","in":"query","name":"space_key","required":true,"schema":{"pattern":"[A-Za-z0-9_-]{1,255}","type":"string"}},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentfulEnvironmentCollection"}}},"description":"Provider page retrieved.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"502":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The provider could not complete discovery or returned an invalid page (`upstream_error`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List Contentful environments","tags":["Contentful Integrations"]}},"/v2/integration-authentications/{integrationAuthenticationId}/contentful-languages":{"get":{"description":"Lists the locales of a Contentful space environment, one page at a time, each with the LingoHub `language_code` it maps to (null when LingoHub doesn't support it). Use these codes for `source_language_code` and `target_language_codes` in createContentfulProject; Contentful's default locale (`is_source`) is usually the source. Requires workspace-level stack or integration management permission.","operationId":"listContentfulLanguages","parameters":[{"in":"path","name":"integrationAuthenticationId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^iau_[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}$","type":"string"}},{"description":"External Contentful space key.","example":"space1","in":"query","name":"space_key","required":true,"schema":{"pattern":"[A-Za-z0-9_-]{1,255}","type":"string"}},{"description":"External Contentful environment key.","example":"master","in":"query","name":"environment_key","required":true,"schema":{"pattern":"[A-Za-z0-9_-]{1,255}","type":"string"}},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"code":"en-US","fallback_code":null,"is_source":true,"language_code":"en-US","object_type":"CONTENTFUL_LANGUAGE"},{"code":"de-DE","fallback_code":"en-US","is_source":false,"language_code":"de-DE","object_type":"CONTENTFUL_LANGUAGE"}],"has_more":false,"next_cursor":null,"object_type":"LIST"},"schema":{"$ref":"#/components/schemas/ContentfulLanguageCollection"}}},"description":"Provider page retrieved.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"502":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The provider could not complete discovery or returned an invalid page (`upstream_error`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List Contentful languages","tags":["Contentful Integrations"]}},"/v2/integration-authentications/{integrationAuthenticationId}/contentful-spaces":{"get":{"description":"Lists the Contentful spaces the connection can see, one page at a time. Pass a space's `key` to listContentfulEnvironments and listContentfulLanguages, and to createContentfulProject. Requires workspace-level stack or integration management permission.","operationId":"listContentfulSpaces","parameters":[{"in":"path","name":"integrationAuthenticationId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^iau_[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}$","type":"string"}},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentfulSpaceCollection"}}},"description":"Provider page retrieved.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"502":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The provider could not complete discovery or returned an invalid page (`upstream_error`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List Contentful spaces","tags":["Contentful Integrations"]}},"/v2/integration-authentications/{integrationAuthenticationId}/credentials":{"put":{"description":"Replaces the token or keys of a connection entered by hand; send the complete set, in the same shape as when creating it. Content-platform credentials are checked with the provider first; git tokens are stored as given. GitHub App installations and OAuth sign-ins can't be changed here (409). Send the ETag from getIntegrationAuthentication as If-Match to make sure nobody changed the connection in between. Requires workspace-level integration management permission.","operationId":"setIntegrationAuthenticationCredentials","parameters":[{"in":"path","name":"integrationAuthenticationId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^iau_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetIntegrationAuthenticationCredentials"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"created_at":"2025-01-15T10:30:00.123Z","id":"iau_0197c8f2-5a6b-7cde-8f12-3456789abcde","is_self_hosted":false,"name":"Company GitLab","object_type":"INTEGRATION_AUTHENTICATION","provider":"GITLAB","provider_origin":"https://gitlab.com","provider_region":null,"status":"ACTIVE","type":"MANUAL","updated_at":"2025-01-15T10:30:00.123Z"},"schema":{"$ref":"#/components/schemas/IntegrationAuthentication"}}},"description":"Credential-free metadata. GET the authentication for its current ETag.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`conflict`: only manually provisioned credentials can be replaced.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Replace integration authentication credentials","tags":["Integration Authentications"]}},"/v2/integration-authentications/{integrationAuthenticationId}/github-branches":{"get":{"description":"Lists the branches of a GitHub repository, one page at a time, each with its latest commit and whether it's protected (a protected branch takes pull requests only). Pass a branch's `commit_sha` to listGitHubDirectoryEntries to browse its folders. Requires workspace-level stack management or integration management permission, or stack-level settings management permission on any stack.","operationId":"listGitHubBranches","parameters":[{"in":"path","name":"integrationAuthenticationId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^iau_[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}$","type":"string"}},{"description":"The repository's owner (user or organization).","example":"company","in":"query","name":"repository_namespace","required":true,"schema":{"maxLength":4096,"minLength":0,"type":"string"}},{"description":"The repository's `name`.","example":"app","in":"query","name":"repository_name","required":true,"schema":{"maxLength":1024,"minLength":0,"type":"string"}},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GitProviderBranchCollection"}}},"description":"Provider discovery page retrieved.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`git_integration_unauthorized`: the git host refused the connection's credentials, or the GitHub App installation is suspended or uninstalled.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"502":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_error`: the git host failed, or answered with more or other data than LingoHub accepts.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"504":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_timeout`: the git host didn't answer in time.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}}},"security":[{"bearerAuth":[]}],"summary":"List GitHub branches","tags":["GitHub Integrations"]}},"/v2/integration-authentications/{integrationAuthenticationId}/github-directory-entries":{"get":{"description":"Lists the files and folders directly inside one folder of a GitHub repository at a given commit (up to 999; a larger folder fails with 502). Each file comes with hints, the languages and file formats its name suggests, to help you choose `path_filters`. Leave `path` empty for the root; take `commit_sha` from listGitHubBranches. Requires workspace-level stack management or integration management permission, or stack-level settings management permission on any stack.","operationId":"listGitHubDirectoryEntries","parameters":[{"in":"path","name":"integrationAuthenticationId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^iau_[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}$","type":"string"}},{"description":"The repository's owner (user or organization).","example":"company","in":"query","name":"repository_namespace","required":true,"schema":{"maxLength":4096,"minLength":0,"type":"string"}},{"description":"The repository's `name`.","example":"app","in":"query","name":"repository_name","required":true,"schema":{"maxLength":1024,"minLength":0,"type":"string"}},{"description":"The branch's latest commit from listGitHubBranches.","example":"e89d9270a7c0b3f1d2e4f5a6b7c8d9e0f1a2b3c4","in":"query","name":"commit_sha","required":true,"schema":{"pattern":"[0-9a-f]{40}|[0-9a-f]{64}","type":"string"}},{"description":"The folder, relative to the repository root, without leading or trailing slashes; empty for the root.","example":"locales","in":"query","name":"path","required":false,"schema":{"default":"","maxLength":4096,"minLength":0,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"detected_language_codes":["en"],"object_type":"GIT_DIRECTORY_ENTRY","path":"locales/en.json","possible_project_types":["STANDARD_JSON","I18NEXT_JSON"],"type":"FILE"}],"has_more":false,"next_cursor":null,"object_type":"LIST"},"schema":{"$ref":"#/components/schemas/GitDirectoryEntryCollection"}}},"description":"Provider discovery results retrieved.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`git_integration_unauthorized`: the git host refused the connection's credentials, or the GitHub App installation is suspended or uninstalled.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"502":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_error`: the git host failed, or answered with more or other data than LingoHub accepts.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"504":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_timeout`: the git host didn't answer in time.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}}},"security":[{"bearerAuth":[]}],"summary":"List GitHub directory entries","tags":["GitHub Integrations"]}},"/v2/integration-authentications/{integrationAuthenticationId}/github-repositories":{"get":{"description":"Lists the repositories the LingoHub GitHub App may access through this installation, one page at a time. A repository that's missing must be granted to the app on GitHub, in the installation's settings. Pass a repository's `namespace` (its owner) and `name` to createProjectGitIntegration and to the branch and folder lookups. Requires workspace-level stack management or integration management permission, or stack-level settings management permission on any stack.","operationId":"listGitHubRepositories","parameters":[{"in":"path","name":"integrationAuthenticationId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^iau_[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}$","type":"string"}},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GitRepositoryCollection"}}},"description":"Provider discovery page retrieved.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`git_integration_unauthorized`: the git host refused the connection's credentials, or the GitHub App installation is suspended or uninstalled.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"502":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_error`: the git host failed, or answered with more or other data than LingoHub accepts.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"504":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_timeout`: the git host didn't answer in time.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}}},"security":[{"bearerAuth":[]}],"summary":"List GitHub repositories","tags":["GitHub Integrations"]}},"/v2/integration-authentications/{integrationAuthenticationId}/gitlab-branches":{"get":{"description":"Lists the branches of a GitLab project, one page at a time, each with its latest commit and whether it's protected (a protected branch takes merge requests only). Pass a branch's `commit_sha` to listGitLabDirectoryEntries to browse its folders. Requires workspace-level stack management or integration management permission, or stack-level settings management permission on any stack.","operationId":"listGitLabBranches","parameters":[{"in":"path","name":"integrationAuthenticationId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^iau_[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}$","type":"string"}},{"description":"The project's `namespace` from listGitLabRepositories; nested groups use slashes.","example":"company/web","in":"query","name":"repository_namespace","required":true,"schema":{"maxLength":4096,"minLength":0,"type":"string"}},{"description":"The project's `name`.","example":"app","in":"query","name":"repository_name","required":true,"schema":{"maxLength":1024,"minLength":0,"type":"string"}},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GitProviderBranchCollection"}}},"description":"Provider discovery page retrieved.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`git_integration_unauthorized`: the git host refused the connection's credentials, or the GitHub App installation is suspended or uninstalled.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"502":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_error`: the git host failed, or answered with more or other data than LingoHub accepts.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"504":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_timeout`: the git host didn't answer in time.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}}},"security":[{"bearerAuth":[]}],"summary":"List GitLab branches","tags":["GitLab Integrations"]}},"/v2/integration-authentications/{integrationAuthenticationId}/gitlab-directory-entries":{"get":{"description":"Lists the files and folders directly inside one folder of a GitLab project at a given commit, one page at a time. Each file comes with hints, the languages and file formats its name suggests, to help you choose `path_filters`. Leave `path` empty for the root; take `commit_sha` from listGitLabBranches. Requires workspace-level stack management or integration management permission, or stack-level settings management permission on any stack.","operationId":"listGitLabDirectoryEntries","parameters":[{"in":"path","name":"integrationAuthenticationId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^iau_[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}$","type":"string"}},{"description":"The project's `namespace` from listGitLabRepositories; nested groups use slashes.","example":"company/web","in":"query","name":"repository_namespace","required":true,"schema":{"maxLength":4096,"minLength":0,"type":"string"}},{"description":"The project's `name`.","example":"app","in":"query","name":"repository_name","required":true,"schema":{"maxLength":1024,"minLength":0,"type":"string"}},{"description":"The branch's latest commit from listGitLabBranches.","example":"e89d9270a7c0b3f1d2e4f5a6b7c8d9e0f1a2b3c4","in":"query","name":"commit_sha","required":true,"schema":{"pattern":"[0-9a-f]{40}|[0-9a-f]{64}","type":"string"}},{"description":"The folder, relative to the repository root, without leading or trailing slashes; empty for the root.","example":"locales","in":"query","name":"path","required":false,"schema":{"default":"","maxLength":4096,"minLength":0,"type":"string"}},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GitDirectoryEntryCollection"}}},"description":"Directory entries retrieved.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`git_integration_unauthorized`: the git host refused the connection's credentials, or the GitHub App installation is suspended or uninstalled.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"502":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_error`: the git host failed, or answered with more or other data than LingoHub accepts.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"504":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_timeout`: the git host didn't answer in time.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}}},"security":[{"bearerAuth":[]}],"summary":"List GitLab directory entries","tags":["GitLab Integrations"]}},"/v2/integration-authentications/{integrationAuthenticationId}/gitlab-repositories":{"get":{"description":"Lists the GitLab projects the connection's user is a member of, one page at a time, oldest first; on gitlab.com or the connection's self-hosted server. `namespace` can contain subgroups (`group/subgroup`). Pass a project's `namespace` and `name` to createProjectGitIntegration and to the branch and folder lookups. Requires workspace-level stack management or integration management permission, or stack-level settings management permission on any stack.","operationId":"listGitLabRepositories","parameters":[{"in":"path","name":"integrationAuthenticationId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^iau_[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}$","type":"string"}},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"name":"app","namespace":"company/web","object_type":"GIT_REPOSITORY","url":"https://gitlab.com/company/web/app"}],"has_more":true,"next_cursor":"1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q","object_type":"LIST"},"schema":{"$ref":"#/components/schemas/GitRepositoryCollection"}}},"description":"Provider discovery page retrieved.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`git_integration_unauthorized`: the git host refused the connection's credentials, or the GitHub App installation is suspended or uninstalled.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"502":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_error`: the git host failed, or answered with more or other data than LingoHub accepts.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"504":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_timeout`: the git host didn't answer in time.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}}},"security":[{"bearerAuth":[]}],"summary":"List GitLab repositories","tags":["GitLab Integrations"]}},"/v2/integrations/contentful/projects":{"post":{"description":"Creates a project connected to a Contentful space environment and starts its first sync, which imports the entries `path_filters` select in the chosen languages. The project goes into `stack_id`, or into a new stack of its own. The environment becomes the name of the default branch. The connection, space and environment aren't checked up front: if they're wrong, the first sync fails. Requires workspace-level stack management permission; `stack_id` also requires stack-level settings and language management permissions on that stack.","operationId":"createContentfulProject","parameters":[{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateContentfulProject"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}},"description":"The project was created; its first sync is the newest import of its default branch.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the created project.","schema":{"type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Create a Contentful project","tags":["Contentful Integrations"]}},"/v2/integrations/crisp-helpdesk/projects":{"post":{"description":"Creates a project connected to the Crisp Helpdesk of the connection's website and starts its first sync, which imports all of its articles in the chosen languages. `is_publish_on_push` decides whether pushed translations are published right away or saved as drafts in Crisp; it can't be changed later. The project goes into `stack_id`, or into a new stack of its own. Requires workspace-level stack management permission; `stack_id` also requires stack-level settings and language management permissions on that stack.","operationId":"createCrispHelpdeskProject","parameters":[{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCrispHelpdeskProject"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}},"description":"The project was created; its first sync is the newest import of its default branch.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the created project.","schema":{"type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Create a Crisp Helpdesk project","tags":["Crisp Helpdesk Integrations"]}},"/v2/integrations/github/installation-link":{"get":{"description":"Returns the link that installs the LingoHub GitHub App for this workspace. A person opens it in a browser and installs the app on GitHub; LingoHub then finishes the installation, and the new connection appears in listIntegrationAuthentications. Requires workspace-level integration management permission.","operationId":"getGitHubInstallationLink","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GitHubInstallationLink"}}},"description":"Installation link retrieved.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`resource_not_found`: the workspace has no GitHub integration.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve the GitHub installation link","tags":["GitHub Integrations"]}},"/v2/integrations/hubspot/projects":{"post":{"description":"Creates a project connected to the connection's HubSpot account and starts its first sync, which imports the content of the `enabled_content_types` that `path_filters` select, in the chosen languages. `is_publish_on_push` decides whether pushed translations are published right away or saved as drafts; it can't be changed later. The project goes into `stack_id`, or into a new stack of its own. Requires workspace-level stack management permission; `stack_id` also requires stack-level settings and language management permissions on that stack.","operationId":"createHubSpotProject","parameters":[{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateHubSpotProject"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}},"description":"The project was created; its first sync is the newest import of its default branch.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the created project.","schema":{"type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Create a HubSpot project","tags":["HubSpot Integrations"]}},"/v2/integrations/storyblok/projects":{"post":{"description":"Creates a project connected to a Storyblok space and starts its first sync, which imports the stories `path_filters` select, in the chosen languages. `space_key` is the space id from Storyblok's settings. The project goes into `stack_id`, or into a new stack of its own. Requires workspace-level stack management permission; `stack_id` also requires stack-level settings and language management permissions on that stack.","operationId":"createStoryblokProject","parameters":[{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateStoryblokProject"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}},"description":"The project was created; its first sync is the newest import of its default branch.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the created project.","schema":{"type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Create a Storyblok project","tags":["Storyblok Integrations"]}},"/v2/integrations/stripo/projects":{"post":{"description":"Creates a project connected to the connection's Stripo account and starts its first sync, which imports the email templates whose names `path_filters` match, in the chosen languages. The project goes into `stack_id`, or into a new stack of its own. Requires workspace-level stack management permission; `stack_id` also requires stack-level settings and language management permissions on that stack.","operationId":"createStripoProject","parameters":[{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateStripoProject"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}},"description":"The project was created; its first sync is the newest import of its default branch.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the created project.","schema":{"type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Create a Stripo project","tags":["Stripo Integrations"]}},"/v2/integrations/zendesk/projects":{"post":{"description":"Creates a project connected to the connection's Zendesk Help Center and starts its first sync, which imports the categories, sections and articles whose name paths (`Category/Section/Article`) `path_filters` match, in the chosen languages. The project goes into `stack_id`, or into a new stack of its own. Requires workspace-level stack management permission; `stack_id` also requires stack-level settings and language management permissions on that stack.","operationId":"createZendeskProject","parameters":[{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateZendeskProject"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}},"description":"The project was created; its first sync is the newest import of its default branch.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the created project.","schema":{"type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Create a Zendesk project","tags":["Zendesk Integrations"]}},"/v2/invitations":{"get":{"description":"Lists the workspace's email invitations in every state (pending, accepted, declined, expired). Invite links aren't included. Requires workspace-level members view permission.","operationId":"listInvitations","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvitationFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `InvitationFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `invitation[accepted_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | – |\n| `invitation[created_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `invitation[declined_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | – |\n| `invitation[email]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | – |\n| `invitation[expires_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `invitation[id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `invitation[invitee_name]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | – |\n| `invitation[is_stack_assignment_configured]` | boolean | `_true` `_false` | – |\n| `invitation[message]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | – |\n| `invitation[status]` | ACCEPTED \\| DECLINED \\| EXPIRED \\| PENDING | `_eq` `_ne` `_in` `_nin` | – |\n| `invitation[updated_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `invitation[workspace_role_id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvitationCollection"}}},"description":"Email invitations retrieved.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List email invitations","tags":["Invitations"]},"post":{"description":"Invites one email address to the workspace. LingoHub sends an invitation email, or a notification if the person already has an account. The invitation expires after 7 days; the API key is recorded as the inviter. Owners can't be invited here. With `stack_assignment`, the person is added to those stacks on acceptance, which needs settings-management permission on each stack. Returns 409 if the email is already a member or has an open invitation. Requires workspace-level members management permission.","operationId":"createInvitation","parameters":[{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInvitation"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invitation"}}},"description":"Invitation created and existing notification flow invoked.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"Invitation metadata URL.","schema":{"format":"uri-reference","type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`conflict`: invitation or membership state prevents this operation. `owner_membership_protected`: owners must be managed outside the API. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Create an email invitation","tags":["Invitations"]}},"/v2/invitations/{invitationId}":{"delete":{"description":"Deletes an email invitation; its link stops working and its open invitation tasks are closed. If it was already accepted, the membership stays. Requires workspace-level members management permission.","operationId":"deleteInvitation","parameters":[{"in":"path","name":"invitationId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^svi_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Email invitation removed.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Remove an email invitation","tags":["Invitations"]},"get":{"description":"Returns one email invitation of the workspace. Its status can change to EXPIRED without `updated_at` changing. Requires workspace-level members view permission.","operationId":"getInvitation","parameters":[{"in":"path","name":"invitationId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^svi_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invitation"}}},"description":"Email invitation retrieved.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve an email invitation","tags":["Invitations"]}},"/v2/invitations/{invitationId}/resend":{"post":{"description":"Sends a pending or expired email invitation again and renews it for 7 days. The original inviter, role and stack assignment stay. Accepted or declined invitations and owner invitations can't be resent (409). A retry with the same Idempotency-Key doesn't send again. Requires workspace-level members management permission.","operationId":"resendInvitation","parameters":[{"in":"path","name":"invitationId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^svi_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invitation"}}},"description":"Refreshed invitation metadata after the existing dispatch workflow completed; this is not proof of recipient delivery.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"conflict: the invitation is already accepted/declined or its assignment changed; owner_membership_protected: owner invitations cannot be resent through the API. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The Idempotency-Key belongs to a different request (`idempotency_key_mismatch`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Resend an email invitation","tags":["Invitations"]}},"/v2/invitations/{invitationId}/stack-assignment":{"delete":{"description":"Removes the stack assignment from a pending or expired invitation, so the person joins only the workspace on acceptance. The invitation stays and isn't resent. Does nothing if there's no assignment. Needs settings-management permission on every assigned stack. Requires workspace-level members management permission.","operationId":"deleteInvitationStackAssignment","parameters":[{"in":"path","name":"invitationId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^svi_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Assignment removed or already absent.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`conflict`: invitation is closed, its assignment changed or is unavailable. `owner_membership_protected`: owner management must happen outside the API.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Remove invitation stack assignment","tags":["Invitations"]},"get":{"description":"Shows which stacks the invited person will join on acceptance, with which stack role and language permissions. `availability` is NOT_CONFIGURED when the invitation adds no stacks, and UNAVAILABLE when a stack or the role no longer exists or your key lacks settings-management permission on one of the stacks; `assignment` is then null. Requires workspace-level members view permission.","operationId":"getInvitationStackAssignment","parameters":[{"in":"path","name":"invitationId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^svi_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvitationStackAssignmentDetails"}}},"description":"Assignment availability retrieved successfully.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve invitation stack assignment","tags":["Invitations"]},"put":{"description":"Replaces the stacks, stack role and language permissions the invited person gets on acceptance. Works on pending and expired invitations; it doesn't resend or extend them. Needs settings-management permission on every stack in the old and the new assignment. Owner roles can't be assigned here. Requires workspace-level members management permission.","operationId":"setInvitationStackAssignment","parameters":[{"in":"path","name":"invitationId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^svi_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetInvitationStackAssignment"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvitationStackAssignmentDetails"}}},"description":"Current stored assignment.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`conflict`: invitation or membership state prevents this operation. `owner_membership_protected`: owners must be managed outside the API.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Replace invitation stack assignment","tags":["Invitations"]}},"/v2/keys/{keyId}":{"delete":{"description":"Removes a key from its file. The segment, its texts and the file's other keys stay. If it was the segment's last key, the segment becomes deactivated: it still counts toward your hosted characters and serves the translation memory, an import that brings the same source text back reuses its translations, and it is deleted when the stack's retention period ends. Removing keys isn't available in single-language CSV, document, subtitle, Storyblok or integration projects (`is_delete_allowed` is false). Send the ETag from getKey as If-Match to make sure nobody changed the key in between. Requires stack-level segment and key management and resource view permissions.","operationId":"deleteKey","parameters":[{"description":"Public identifier of the key to remove.","in":"path","name":"keyId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^ress_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Key removed.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`conflict`: the project or the file's format doesn't allow removing keys, or another change to the file's keys is in progress (retry).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Delete a key","tags":["Keys"]},"get":{"description":"Returns one key: where a segment appears in a file. Send its ETag as If-Match to updateKey or deleteKey so the change fails if someone changed the key in between. Requires the segment, key and file view permissions.","operationId":"getKey","parameters":[{"description":"Public identifier of the key.","in":"path","name":"keyId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^ress_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Key"}}},"description":"Retrieved successfully.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve a key","tags":["Keys"]},"patch":{"description":"Renames a key with JSON merge-patch. `key` is the full key, as createKey takes it; `group_key` sets the group in formats with one group (PO, Qt TS, INI, Twine), and null removes it. The project's key normalization applies, and an unchanged key writes nothing. A key moved to another group goes after that group's last key. The segment, its texts and the file's other keys stay unchanged; automations that match the new key can add labels. Renaming isn't available in single-language CSV, document, subtitle, Storyblok or integration projects (`is_rename_allowed` is false). Send the ETag from getKey as If-Match to make sure nobody changed the key in between. Requires stack-level segment and key management and resource view permissions.","operationId":"updateKey","parameters":[{"description":"Public identifier of the key.","in":"path","name":"keyId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^ress_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateKey"}},"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateKey"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Key"}}},"description":"The key after the change.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`already_exists`: the file has the new key. `conflict`: the project or the file's format doesn't allow renaming, the file has no format, the current key is too long for the key history, the key is an entry of a group its format keeps on its own (such as a string array), or another change to the file's keys is in progress (retry).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Update a key","tags":["Keys"]}},"/v2/labels":{"get":{"description":"Lists the workspace's labels, oldest first. To find a label by name, filter `label[name]` with `_eq`. Requires workspace-level label view permission.","operationId":"listLabels","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabelFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `LabelFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `label[created_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `label[id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `label[name]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | yes |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabelCollection"}}},"description":"Labels retrieved successfully.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List labels","tags":["Labels"]},"post":{"description":"Creates a label in the workspace. Its name must be unique in the workspace, ignoring case. Without `color`, the label gets one of the default label colors, as in the app. Requires workspace-level label management permission.","operationId":"createLabel","parameters":[{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLabel"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Label"}}},"description":"Label created successfully.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the created label.","schema":{"type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"A label with this name already exists (`already_exists` on `name`). An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Create a label","tags":["Labels"]}},"/v2/labels/{labelId}":{"delete":{"description":"Deletes a label and removes it from all segments. Automation rules that add this label are deleted too, in every stack of the workspace. This can't be undone. Send the ETag from getLabel as If-Match to make sure nobody changed the label in between. Requires workspace-level label management permission.","operationId":"deleteLabel","parameters":[{"description":"Unique identifier of the label.","example":"la_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"labelId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a label, a valid value would be : la_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^la_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Label deleted successfully.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Delete a label","tags":["Labels"]},"get":{"description":"Returns one label. Send its ETag as If-Match to updateLabel or deleteLabel so the change fails if someone changed the label in between. Requires workspace-level label view permission.","operationId":"getLabel","parameters":[{"description":"Unique identifier of the label.","example":"la_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"labelId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a label, a valid value would be : la_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^la_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Label"}}},"description":"Label retrieved successfully.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve a label","tags":["Labels"]},"patch":{"description":"Changes a label with JSON merge-patch: leaving out a field keeps it, and `ai_context: null` clears it. The name must stay unique in the workspace, ignoring case. Send the ETag from getLabel as If-Match to make sure nobody changed the label in between. Requires workspace-level label management permission.","operationId":"updateLabel","parameters":[{"description":"Unique identifier of the label.","example":"la_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"labelId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a label, a valid value would be : la_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^la_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLabel"}},"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateLabel"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Label"}}},"description":"Label updated successfully.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"A label with this name already exists (`already_exists` on `name`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Update a label","tags":["Labels"]}},"/v2/lina-executions/{linaExecutionId}":{"get":{"description":"Returns one LINA run started through the API. Poll it while `status` is `QUEUED` or `PROCESSING`. A run that ends `PARTIALLY_SUCCEEDED` translated part of the selection; `failure` says why the rest wasn't done. Runs can no longer be read once the plan's LINA run history ends or their branch is deleted. Requires stack-level texts view permission.","operationId":"getLinaExecution","parameters":[{"in":"path","name":"linaExecutionId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^tp_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinaExecution"}}},"description":"The run.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve a LINA run","tags":["LINA Executions"]}},"/v2/linas":{"get":{"description":"Lists the workspace's LINAs, oldest first: the AI translators with their engines, context sources and the stacks they may work in. Requires workspace-level AI translation view permission.","operationId":"listLinas","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinaFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `LinaFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `lina[created_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `lina[engine_mode]` | CUSTOMER_MANAGED \\| LINGOHUB_MANAGED | `_eq` `_ne` `_in` `_nin` | – |\n| `lina[id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `lina[name]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | yes |\n| `lina[updated_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinaCollection"}}},"description":"The LINAs.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List LINAs","tags":["LINAs"]},"post":{"description":"Creates a LINA whose engines you choose; LingoHub-managed LINAs are set up by LingoHub. Only `name` and `linguistic_engine_id` are required; the context sources default to what the engine supports. The name must be unique in the workspace, ignoring case. The LINA gets its own actor, which its translations are attributed to, and default quality-check settings. Requires workspace-level AI translation management permission.","operationId":"createLina","parameters":[{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLina"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lina"}}},"description":"The LINA was created.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the new LINA.","schema":{"format":"uri-reference","type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`already_exists`: another LINA of the workspace has this name (`#/name`). An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"An engine isn't in the workspace (`not_found`) or is disabled (`not_supported`); the glossary, style guide or a stack isn't in the workspace (`not_found`); a language or stack is listed twice (`uniqueItems`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Create a LINA","tags":["LINAs"]}},"/v2/linas/{linaId}":{"delete":{"description":"Deletes a LINA. Stacks that used it are left without a LINA: their quality checks use the default settings, and their languages' LINA role goes back to assistant. Its quality settings and per-language engines go with it. Work it already did stays and is shown as done by a deleted LINA. This can't be undone. Send the ETag from getLina as If-Match to make sure nobody changed the LINA in between. Requires workspace-level AI translation management permission.","operationId":"deleteLina","parameters":[{"in":"path","name":"linaId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^lina_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"The LINA was deleted.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Delete a LINA","tags":["LINAs"]},"get":{"description":"Returns one LINA, the same object as in listLinas. For a LingoHub-managed LINA, `linguistic_engine_id` is its default engine; LingoHub may choose another one for each translation. Requires workspace-level AI translation view permission.","operationId":"getLina","parameters":[{"in":"path","name":"linaId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^lina_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lina"}}},"description":"The LINA.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve a LINA","tags":["LINAs"]},"patch":{"description":"Changes a LINA with JSON merge-patch: leaving out a field keeps it, `null` clears the description, glossary, style guide or stack restriction, and lists replace the whole list. Sending only the current values changes nothing. For a LingoHub-managed LINA the engine and per-language engines can't be changed. The name must stay unique in the workspace, ignoring case. Send the ETag from getLina as If-Match to make sure nobody changed the LINA in between. Requires workspace-level AI translation management permission.","operationId":"updateLina","parameters":[{"in":"path","name":"linaId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^lina_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLina"}},"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateLina"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lina"}}},"description":"The LINA.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`already_exists`: another LINA of the workspace has this name (`#/name`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"An engine isn't in the workspace (`not_found`) or is disabled (`not_supported`); the glossary, style guide or a stack isn't in the workspace (`not_found`); a language or stack is listed twice (`uniqueItems`); the engine or per-language engines of a LingoHub-managed LINA were changed (`not_supported`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Update a LINA","tags":["LINAs"]}},"/v2/linas/{linaId}/quality-check-settings":{"get":{"description":"Returns the LINA's quality-check settings: which of the ten rules run, how severe their findings are, and how HTML attributes are checked. They apply to every stack that uses this LINA; a stack without a LINA uses the defaults. Requires workspace-level AI translation view permission.","operationId":"getLinaQualityCheckSettings","parameters":[{"in":"path","name":"linaId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^lina_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinaQualitySettings"}}},"description":"The settings.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve LINA quality settings","tags":["LINAs"]},"patch":{"description":"Changes the LINA's quality-check settings with JSON merge-patch: leaving out a rule or field keeps it, and `translatable_html_attributes` replaces the whole list. Sending only the current values changes nothing. The settings apply to every stack that uses this LINA from its next check; results already computed stay until the text is checked again. Send the ETag from getLinaQualityCheckSettings as If-Match to make sure nobody changed them in between. Requires workspace-level AI translation management permission.","operationId":"updateLinaQualityCheckSettings","parameters":[{"in":"path","name":"linaId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^lina_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLinaQualitySettings"}},"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateLinaQualitySettings"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinaQualitySettings"}}},"description":"The settings.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Update LINA quality settings","tags":["LINAs"]}},"/v2/linas/{linaId}/translate":{"post":{"description":"Translates up to ten plain texts with the LINA right away, outside any project, using its engines and its glossary, style guide and translation-memory context. Nothing is stored. Results come back in the order of `texts`; check `is_translated` on every item, because a 200 can contain failed texts (`failure` says why, e.g. `CREDIT_LIMIT_REACHED`). Costs AI credits. LINAs restricted to stacks can't be used here. Retry with the same Idempotency-Key to avoid paying twice. Requires workspace-level AI translation management permission.","operationId":"translateLina","parameters":[{"in":"path","name":"linaId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^lina_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranslateLina"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinaTranslateResult"}}},"description":"The translations, also of texts that failed.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`conflict`: the LINA may only be used in certain stacks. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Translate plain texts with a LINA","tags":["LINAs"]}},"/v2/linguistic-engines":{"get":{"description":"Returns a cursor-paginated collection of workspace-visible engine capabilities, including unavailable engines. Archived engines aren't listed; getLinguisticEngine still returns them. Requires workspace-level AI translation view permission.","operationId":"listLinguisticEngines","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinguisticEngineFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `LinguisticEngineFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `linguistic_engine[created_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `linguistic_engine[id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `linguistic_engine[model]` | MT_GOOGLE_TRANSLATE_V3 \\| MT_DEEPL_TRANSLATE_V1 \\| MT_AWS_TRANSLATE \\| AI_GPT_5_4 \\| AI_GPT_5_4_MINI \\| AI_GPT_5_4_NANO \\| AI_GPT_5_6_SOL \\| AI_GPT_5_6_TERRA \\| AI_GPT_5_6_LUNA \\| AI_GEMINI_2_5_FLASH \\| AI_GEMINI_2_5_PRO \\| AI_GEMINI_3_6_FLASH \\| AI_GEMINI_3_5_FLASH_LITE \\| AI_CLAUDE_OPUS_4_7 \\| AI_CLAUDE_SONNET_4_6 \\| AI_CLAUDE_HAIKU_4_5 \\| AI_CLAUDE_OPUS_5 \\| AI_CLAUDE_SONNET_5 \\| AI_MISTRAL_LARGE_3 \\| AI_MISTRAL_SMALL_4 \\| AI_MISTRAL_MEDIUM_3_5 \\| AI_MISTRAL_LARGE_4 \\| AI_GPT_6_LUNA \\| AI_GPT_6_1_TERRA \\| AI_GPT_6_1_SOL \\| AI_GEMINI_3_8_FLASH \\| AI_CLAUDE_OPUS_5_5 \\| AI_CLAUDE_SONNET_5_5 \\| AI_CLAUDE_HAIKU_5_5 | `_eq` `_ne` `_in` `_nin` | – |\n| `linguistic_engine[updated_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinguisticEngineCollection"}}},"description":"Collection retrieved.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List linguistic engines","tags":["Linguistic Engines"]}},"/v2/linguistic-engines/{linguisticEngineId}":{"get":{"description":"Returns the engine if this workspace can see it. Archived engines are still returned here, so older references resolve. Requires workspace-level AI translation view permission.","operationId":"getLinguisticEngine","parameters":[{"in":"path","name":"linguisticEngineId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^engine_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinguisticEngine"}}},"description":"Resource retrieved.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve a linguistic engine","tags":["Linguistic Engines"]}},"/v2/locales":{"get":{"description":"Returns a cursor-paginated list of every locale supported by LingoHub, ordered by language code. Iterate by passing `next_cursor` of the previous page via the `cursor` query parameter until `has_more` is false.","operationId":"listLocales","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocaleFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `LocaleFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `locale[direction]` | LTR \\| RTL | `_eq` `_ne` `_in` `_nin` | – |\n| `locale[english_name]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | yes |\n| `locale[language_code]` | language code | `_eq` `_ne` `_in` `_nin` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | yes |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupportedLocaleCollection"}}},"description":"Locales retrieved successfully.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List locales","tags":["Locales"]}},"/v2/members":{"get":{"description":"Returns workspace memberships with public account and role identities and basic current profile fields. Includes owner memberships without permitting owner changes. Requires workspace-level members view permission.","operationId":"listMembers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `MemberFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `member[created_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `member[email]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | – |\n| `member[first_name]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | – |\n| `member[id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `member[last_name]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | – |\n| `member[updated_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `member[workspace_role_id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberCollection"}}},"description":"Workspace members retrieved.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List workspace members","tags":["Members"]}},"/v2/members/{memberId}":{"delete":{"description":"Removes the member from the workspace. Their API keys are deactivated; their stack memberships and personal settings in this workspace are deleted; their language assignments are cleared, and stacks they were responsible for are handed to another member shortly after. The user account and the history of their work remain. Workspace and stack owners can't be removed here (409). A user's own API key can't remove that user (403). Requires workspace-level members management permission.","operationId":"deleteMember","parameters":[{"in":"path","name":"memberId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^wsu_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Membership removed.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Workspace or stack owner memberships cannot be removed through the API (`owner_membership_protected`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Remove a workspace member","tags":["Members"]},"get":{"description":"Returns a member in the authenticated workspace. Timestamps describe membership metadata; the ETag also covers current profile fields. Private account and editor settings are excluded. Requires workspace-level members view permission.","operationId":"getMember","parameters":[{"in":"path","name":"memberId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^wsu_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Member"}}},"description":"Workspace member retrieved.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve a workspace member","tags":["Members"]},"patch":{"description":"Changes the member's workspace role. Owners can't be changed and nobody can be made owner here. If the new role loses access, the member's language assignments it no longer covers are removed, stacks they were responsible for are handed to another member, and the people involved are notified. A user's own API key can't change that user's role. Requires workspace-level members management permission.","operationId":"updateMember","parameters":[{"in":"path","name":"memberId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^wsu_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMember"}},"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateMember"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Member"}}},"description":"Current member metadata.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The member is a workspace owner, or the request would make them one (`owner_membership_protected`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Update a workspace member","tags":["Members"]}},"/v2/project-moves/{projectMoveId}":{"get":{"description":"Returns a project move or detach and its status; poll it until the status is final, only `SUCCEEDED` means it's complete. Access follows the project's current stack: a key limited to the old stack can't read the result once the project has moved (404). Requires project-level settings management permission.","operationId":"getProjectMove","parameters":[{"in":"path","name":"projectMoveId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^rsy_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectMove"}}},"description":"Move retrieved.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve a project move","tags":["Project Moves"]}},"/v2/projects":{"get":{"description":"Returns a cursor-paginated list of projects in the workspace that the API key belongs to. Results are limited to projects the API key has permission to view. Use `filter` to search projects; iterate by passing `next_cursor` of the previous page via the `cursor` query parameter until `has_more` is false. Requires workspace-level general view permission.","operationId":"listProjects","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `ProjectFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `project[created_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `project[id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `project[name]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | yes |\n| `project[stack_id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `project[type]` | ANDROID_XML \\| IOS_STRINGS \\| IOS_STRINGS_CATALOG \\| STANDARD_PROPERTIES \\| GETTEXT_PO \\| WINDOWS_RESX \\| QT_LINGUIST_TS \\| DEFINE_PHP \\| STANDARD_INI \\| STANDARD_ARB \\| RAILS_YAML \\| SYMFONY_YAML \\| STANDARD_JSON \\| ANGULAR_TRANSLATE_JSON \\| CHROME_I18N_JSON \\| GO_I18N_JSON \\| I18NEXT_JSON \\| REACT_INTL_JSON \\| STANDARD_CSV \\| SINGLE_LANGUAGE_CSV \\| KEY_VALUE_CSV \\| STANDARD_XLIFF \\| STANDARD_XLIFF_2 \\| STANDARD_TXT \\| TWINE_TXT \\| STANDARD_MARKDOWN \\| STANDARD_HTML \\| FIGMA \\| ZENDESK \\| STORYBLOK \\| STORYBLOK_JSON \\| CONTENTFUL \\| SUBTITLE_SRT \\| SUBTITLE_VTT \\| HUBSPOT \\| STRIPO \\| CRISP_HELPDESK \\| DOCUMENT \\| VUE_I18N_JSON | `_eq` `_ne` `_in` `_nin` | – |\n| `project[updated_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectCollection"}}},"description":"Projects retrieved successfully.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List projects","tags":["Projects"]},"post":{"description":"Creates a project with its source and target languages. Without `stack_id` it gets its own private stack; with `stack_id` it joins that stack: the source language must match, and target languages the stack doesn't have yet are added to the stack. Integration projects (Contentful, Zendesk, …) are created with their own endpoints. Requires workspace-level stack management permission; with `stack_id` also stack-level settings and languages management permission on that stack.","operationId":"createProject","parameters":[{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProject"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}},"description":"Project created successfully.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the created project.","schema":{"format":"uri-reference","type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Another project of the workspace already has this name, or a name with the same URL slug, such as one that differs only in case (`already_exists` on `name`). An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Create a project","tags":["Projects"]}},"/v2/projects/{projectId}":{"delete":{"description":"Deletes the project with its branches, files and keys; it's gone from the API immediately, cleaned up in the background, and can't be undone. If the project has its own private stack, that stack and all its texts are deleted too, and API keys limited to it stop working. In a shared stack the texts stay for the other projects. A translation order in progress blocks the deletion (409); orders that haven't started are cancelled. Requires stack-level settings management permission.","operationId":"deleteProject","parameters":[{"description":"Unique identifier of the project.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Project deleted successfully.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"A translation order of the project is in progress (`translation_order_pending`). Orders that have not started are cancelled with the project.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Delete a project","tags":["Projects"]},"get":{"description":"Returns one project. A project the key can't see returns 404, the same as one that doesn't exist. Requires stack-level general view permission.","operationId":"getProject","parameters":[{"description":"Unique identifier of the project.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}},"description":"Project retrieved successfully.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve a project","tags":["Projects"]},"patch":{"description":"Changes a project's name, colour, AI context or website (JSON merge-patch; `null` removes the AI context or website). Requires stack-level settings management permission.","operationId":"updateProject","parameters":[{"description":"Unique identifier of the project.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProject"}},"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateProject"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}},"description":"Project updated successfully.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Another project of the workspace already has this name, or a name with the same URL slug, such as one that differs only in case (`already_exists` on `name`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Update a project","tags":["Projects"]}},"/v2/projects/{projectId}/backup-settings":{"delete":{"description":"Turns automatic backups off: the schedule and the branch selection are removed. Existing backups and restores are kept, and a backup that's already running finishes. Does nothing if automatic backups are already off. Requires project-level settings management permission.","operationId":"deleteBackupSettings","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Automatic backup settings removed or already disabled.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Delete automatic backup settings","tags":["Backup Settings"]},"get":{"description":"Returns the project's automatic-backup schedule (daily or weekly, at a UTC time) and the branches it backs up. Without a schedule, `is_enabled` is false and the schedule fields are null. Requires project-level settings management permission.","operationId":"getBackupSettings","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackupSettings"}}},"description":"Current automatic-backup settings retrieved successfully.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve automatic backup settings","tags":["Backup Settings"]},"put":{"description":"Turns on automatic backups or replaces the schedule and branch selection. `day_of_week` is required for WEEKLY and must be null for DAILY; the time is in UTC. Saving doesn't start a backup; the next run is recalculated. Use DELETE to turn automatic backups off. Requires project-level settings management permission.","operationId":"setBackupSettings","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetBackupSettings"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackupSettings"}}},"description":"Automatic backup settings saved.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Set automatic backup settings","tags":["Backup Settings"]}},"/v2/projects/{projectId}/backups":{"get":{"description":"Lists the project's backups, newest first, including those of deleted branches. A backup is a snapshot of one branch: its files, keys and texts in the listed languages. Backups are kept until they are deleted. Requires project-level settings management permission.","operationId":"listBackups","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackupFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `BackupFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `backup[branch_id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `backup[branch_name]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | yes |\n| `backup[created_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `backup[id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `backup[name]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | yes |\n| `backup[status]` | QUEUED \\| PROCESSING \\| SUCCEEDED \\| FAILED | `_eq` `_ne` `_in` `_nin` | – |\n| `backup[updated_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackupCollection"}}},"description":"The project's backups.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List backups","tags":["Backups"]}},"/v2/projects/{projectId}/branches":{"get":{"description":"Returns a cursor-paginated list of branches in the given project. Use `filter` to search branches; iterate by passing `next_cursor` of the previous page via the `cursor` query parameter until `has_more` is false. Requires project-level general view permission.","operationId":"listBranches","parameters":[{"description":"Unique identifier of the project.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BranchFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `BranchFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `branch[created_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `branch[id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `branch[is_default]` | boolean | `_true` `_false` | – |\n| `branch[name]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | yes |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BranchCollection"}}},"description":"Branches retrieved successfully.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List branches","tags":["Branches"]},"post":{"description":"Creates a branch in the project. Without `starting_point_branch_id` it starts empty, with only the source language. With it, LingoHub copies that branch's files, keys, languages and texts into the new branch in the background: 201 means the branch exists, not that the copy is done. Poll the branch at `Location` until `initialization_status` is final. Until it's SUCCEEDED you can rename or delete it, but not import, export, change its languages or make it the default. Requires project-level settings management permission.","operationId":"createBranch","parameters":[{"description":"Unique identifier of the project.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBranch"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Branch"}}},"description":"Branch created successfully.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the created branch.","schema":{"format":"uri-reference","type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"A branch with this name already exists (`already_exists` on `name`), or the project has reached its branch limit (`branch_limit_reached`). The branch has not completed initialization (`branch_not_ready`); poll its initialization_status before retrying. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Create a branch","tags":["Branches"]}},"/v2/projects/{projectId}/capabilities":{"get":{"description":"Returns the project's type, the largest file it imports and its native file formats with their extensions, and whether files and keys can be created in each format without an upload. It doesn't list the project's files. Requires project-level resource view permission.","operationId":"getProjectCapabilities","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Capabilities"}}},"description":"Project capabilities retrieved.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve project capabilities","tags":["Capabilities"]}},"/v2/projects/{projectId}/context-images":{"get":{"description":"Lists the project's context images, newest first. `attachments` lists the segments each image is attached to; a match LingoHub only suggested counts once someone accepts it. Requires project-level context-image view permission.","operationId":"listContextImages","parameters":[{"description":"Unique identifier of the project.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContextImageFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `ContextImageFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `context_image[capture_key]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | – |\n| `context_image[captured_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | – |\n| `context_image[created_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `context_image[has_attachments]` | boolean | `_true` `_false` | – |\n| `context_image[id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `context_image[language_code]` | language code | `_eq` `_ne` `_in` `_nin` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` `_gt` | – |\n| `context_image[name]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | yes |\n| `context_image[updated_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `context_image[upload_status]` | PROCESSING \\| DONE \\| ERROR | `_eq` `_ne` `_in` `_nin` | – |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContextImageCollection"}}},"description":"Context images retrieved successfully.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List context images","tags":["Context Images"]},"post":{"description":"Uploads an image, at most 10 MB, that shows the UI text of one project language.\n\n- Without `rendered_strings`, LingoHub reads the text in the image after the upload and links the segments it finds; with `auto_connect_suggestions: false` they stay suggestions to review in the app. Those links aren't in the response yet.\n- With `rendered_strings`, as the iOS and Android SDKs send them, the image is linked right away to the segments whose keys or text match, and no text recognition runs. `[]` uploads the image without links.\n- With `capture_key`, uploading the same screen again keeps the image's id: identical bytes change nothing (200 `UNCHANGED`); changed bytes replace the file and rebuild all its links, including ones added by hand (200 `REPLACED`). A new image answers 201 `CREATED`.\n\nEvery stored upload counts toward the workspace's monthly context image uploads. A segment keeps its three most recently linked images; linking a fourth detaches the oldest. Requires project-level context-image management permission.","operationId":"createContextImage","parameters":[{"description":"Unique identifier of the project.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"app_version":{"description":"Application version of this capture.","example":"2.1.0","maxLength":256,"type":"string"},"auto_connect_suggestions":{"default":true,"description":"How the segments matched by OCR text-detection are connected: `true` (the default) connects them to the image, `false` creates suggestions that require manual review in the web editor.","example":true,"type":"boolean"},"capture_key":{"description":"Stable capture identity within this project language. Same bytes are a no-op; changed bytes replace all links at the same image id.","example":"checkout/payment-sheet","maxLength":512,"type":"string"},"description":{"description":"What the image shows, at most 4096 characters.","example":"Screenshot of the checkout screen showing the payment options.","maxLength":4096,"type":"string"},"file":{"description":"The image, at most 10 MB.","format":"binary","type":"string"},"language_code":{"description":"Language of the UI text shown in the image. The image can only be attached to segment texts of this language, and the language must be configured for the project.","example":"en","type":"string"},"name":{"description":"Display name of the context image, at most 4096 characters. Omit it to use the uploaded file's name.","example":"checkout-screen.png","maxLength":4096,"type":"string"},"rendered_strings":{"description":"JSON array part with Content-Type application/json, at most 1000 strings. `[]` uploads the image without links; leave it out to let LingoHub read the text in the image.","items":{"$ref":"#/components/schemas/ContextImageRenderedString"},"maxItems":1000,"type":"array"}},"required":["file","language_code"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContextImageUpload"}}},"description":"Capture replaced or unchanged.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the context image.","schema":{"type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContextImageUpload"}}},"description":"Context image uploaded successfully.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the created context image.","schema":{"type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The workspace has used up the monthly context image uploads of its plan (`context_image_limit_reached`). An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The upload exceeds the maximum size.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"A form field is invalid; `errors` names it. For `file`: `format` when it is not an image, `file_too_large` over 10 MB. `language_code` is not a language code (`format`) or not a language of the project (`not_found`). `name` and `description` are longer than 4096 characters (`maxLength`); `auto_connect_suggestions` is neither true nor false (`type`). A `rendered_strings` box outside the image is `maximum` on its `width` or `height`.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"502":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The image service failed to store the image (`upstream_error`); retry later.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Upload a context image","tags":["Context Images"]}},"/v2/projects/{projectId}/detach":{"post":{"description":"Takes the project out of its shared stack into a new private stack of its own, in the background; poll the URL in `Location` (getProjectMove). The new stack gets copies of the project's texts and languages and the shared stack's members, language permissions, API key permissions and automations, but no LINA. API keys limited to the shared stack don't reach the detached project any more. A project that already has its own stack can't be detached (409). Requires project-level settings management permission.","operationId":"detachProject","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"responses":{"202":{"content":{"application/json":{"examples":{"queued":{"description":"queued","value":{"data":{"created_at":"2026-01-01T10:00:00.000Z","id":"rsy_0197c8f2-5a6b-7cde-8f12-3456789abcde","object_type":"PROJECT_MOVE","project_id":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","source_stack_id":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","status":"QUEUED","status_details":null,"target_stack_id":null,"type":"DETACH","updated_at":"2026-01-01T10:00:00.000Z"},"job_type":"PROJECT_MOVE","object_type":"JOB"}}},"schema":{"$ref":"#/components/schemas/ProjectMoveJob"}}},"description":"Detachment queued.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the project move to poll.","schema":{"format":"uri-reference","type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The project cannot currently detach: its stack is already private or it has active work. No move was queued. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The Idempotency-Key belongs to a different request (`idempotency_key_mismatch`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Detach a project","tags":["Project Moves"]}},"/v2/projects/{projectId}/distributions":{"get":{"description":"Lists the project's distributions, newest first. A distribution delivers releases of the project's translations over the CDN: an app gets the distribution of its environment and type whose version range contains the app version, otherwise the fallback. List a distribution's releases to see which one is live. Requires project-level settings management permission.","operationId":"listDistributions","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistributionFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `DistributionFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `distribution[created_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `distribution[environment]` | DEVELOPMENT \\| TEST \\| STAGING \\| PRODUCTION | `_eq` `_ne` `_in` `_nin` | – |\n| `distribution[id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `distribution[is_fallback]` | boolean | `_true` `_false` | yes |\n| `distribution[name]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | yes |\n| `distribution[type]` | NATIVE_FORMAT \\| MOBILE_SDK_ANDROID \\| MOBILE_SDK_IOS | `_eq` `_ne` `_in` `_nin` | – |\n| `distribution[updated_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `distribution[version_from]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | – |\n| `distribution[version_to]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | – |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistributionCollection"}}},"description":"The project's distributions.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List distributions","tags":["Distributions"]}},"/v2/projects/{projectId}/integrations/contentful":{"get":{"description":"Returns the project's Contentful integration: the connection, space and environment it syncs with, which entries it selects, and when it last pulled and pushed. Requires stack-level settings management permission.","operationId":"getProjectContentfulIntegration","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectContentfulIntegration"}}},"description":"The project's Contentful integration.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve the Contentful integration","tags":["Contentful Integrations"]},"patch":{"description":"Changes which Contentful entries the project syncs (JSON merge-patch; `path_filters` is replaced as a whole). A changed selection starts a sync of the default branch right away, which imports newly selected entries and removes content that is no longer selected. Sending the same selection changes nothing. Requires stack-level settings management permission.","operationId":"updateProjectContentfulIntegration","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateContentIntegration"}},"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateContentIntegration"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectContentfulIntegration"}}},"description":"The changed Contentful integration.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`branch_not_ready`: the default branch is still being created.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Update the Contentful integration","tags":["Contentful Integrations"]}},"/v2/projects/{projectId}/integrations/contentful/pull":{"post":{"description":"Pulls the project's Contentful entries into its default branch in the background, all of them or the `resource_ids` and `language_codes` you choose; poll the import at the URL in `Location`. To pick up newly selected entries or remove deselected ones, use the sync instead. Requires stack-level resource management permission.","operationId":"pullContentfulIntegration","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferContentIntegration"}}}},"responses":{"202":{"content":{"application/json":{"example":{"data":{"branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","created_at":"2026-01-15T10:30:00.123Z","git_source":null,"id":"rin_0197c8f2-5a6b-7cde-8f12-3456789abcde","keys_deactivated":0,"keys_reactivated":0,"keys_renamed":0,"object_type":"IMPORT","status":"QUEUED","status_details":null,"texts_created":0,"texts_updated":0,"updated_at":"2026-01-15T10:30:00.123Z"},"job_type":"IMPORT","object_type":"JOB"},"schema":{"$ref":"#/components/schemas/ImportJob"}}},"description":"The pull is queued.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"$ref":"#/components/headers/Location"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`branch_not_ready`: the default branch is still being created. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Pull from Contentful","tags":["Contentful Integrations"]}},"/v2/projects/{projectId}/integrations/contentful/push":{"post":{"description":"Pushes the translations of the project's default branch into Contentful in the background, for all entries and languages or the `resource_ids` and `language_codes` you choose; poll the export at the URL in `Location`. Some entries can be written while others fail: the export then ends `PARTIALLY_SUCCEEDED`. Requires stack-level resource management permission.","operationId":"pushContentfulIntegration","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferContentIntegration"}}}},"responses":{"202":{"content":{"application/json":{"example":{"data":{"branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","created_at":"2026-09-30T10:00:00.123Z","download_url":null,"download_url_expires_at":null,"git_result":null,"id":"reg_0197c8f2-5a6b-7cde-8f12-3456789abcde","language_codes":null,"object_type":"EXPORT","status":"QUEUED","status_details":null,"updated_at":"2026-09-30T10:00:00.123Z"},"job_type":"EXPORT","object_type":"JOB"},"schema":{"$ref":"#/components/schemas/ExportJob"}}},"description":"The push is queued.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the export to poll.","schema":{"type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`branch_not_ready`: the default branch is still being created. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Push to Contentful","tags":["Contentful Integrations"]}},"/v2/projects/{projectId}/integrations/contentful/sync":{"post":{"description":"Brings the project's default branch in line with the Contentful entries its selection covers, in the background: entries that are no longer selected or no longer exist are removed from the project, and new ones are imported right away if `is_import_new_resources` is true. Poll the import at the URL in `Location`. Requires stack-level resource management permission.","operationId":"syncContentfulIntegration","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncContentIntegration"}}},"required":true},"responses":{"202":{"content":{"application/json":{"example":{"data":{"branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","created_at":"2026-01-15T10:30:00.123Z","git_source":null,"id":"rin_0197c8f2-5a6b-7cde-8f12-3456789abcde","keys_deactivated":0,"keys_reactivated":0,"keys_renamed":0,"object_type":"IMPORT","status":"QUEUED","status_details":null,"texts_created":0,"texts_updated":0,"updated_at":"2026-01-15T10:30:00.123Z"},"job_type":"IMPORT","object_type":"JOB"},"schema":{"$ref":"#/components/schemas/ImportJob"}}},"description":"The sync is queued.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"$ref":"#/components/headers/Location"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`branch_not_ready`: the default branch is still being created. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Sync with Contentful","tags":["Contentful Integrations"]}},"/v2/projects/{projectId}/integrations/crisp-helpdesk":{"get":{"description":"Returns the project's Crisp Helpdesk integration: the connection it syncs with, whether pushed translations are published or saved as drafts, and when it last pulled and pushed. Requires stack-level settings management permission.","operationId":"getProjectCrispHelpdeskIntegration","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectCrispHelpdeskIntegration"}}},"description":"The project's Crisp Helpdesk integration.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve the Crisp Helpdesk integration","tags":["Crisp Helpdesk Integrations"]}},"/v2/projects/{projectId}/integrations/crisp-helpdesk/pull":{"post":{"description":"Pulls the project's Crisp Helpdesk categories, sections and articles into its default branch in the background, all of them or the `resource_ids` and `language_codes` you choose; poll the import at the URL in `Location`. To pick up new ones or remove deleted ones, use the sync instead. Requires stack-level resource management permission.","operationId":"pullCrispHelpdeskIntegration","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferContentIntegration"}}}},"responses":{"202":{"content":{"application/json":{"example":{"data":{"branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","created_at":"2026-01-15T10:30:00.123Z","git_source":null,"id":"rin_0197c8f2-5a6b-7cde-8f12-3456789abcde","keys_deactivated":0,"keys_reactivated":0,"keys_renamed":0,"object_type":"IMPORT","status":"QUEUED","status_details":null,"texts_created":0,"texts_updated":0,"updated_at":"2026-01-15T10:30:00.123Z"},"job_type":"IMPORT","object_type":"JOB"},"schema":{"$ref":"#/components/schemas/ImportJob"}}},"description":"The pull is queued.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"$ref":"#/components/headers/Location"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`branch_not_ready`: the default branch is still being created. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Pull from Crisp Helpdesk","tags":["Crisp Helpdesk Integrations"]}},"/v2/projects/{projectId}/integrations/crisp-helpdesk/push":{"post":{"description":"Pushes the translations of the project's default branch into Crisp Helpdesk in the background, for all categories, sections and articles and languages or the `resource_ids` and `language_codes` you choose; poll the export at the URL in `Location`. Some categories, sections and articles can be written while others fail: the export then ends `PARTIALLY_SUCCEEDED`. Articles that don't exist in a language yet are created in Crisp; they're published right away if the integration has `is_publish_on_push`, otherwise they stay drafts. Requires stack-level resource management permission.","operationId":"pushCrispHelpdeskIntegration","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferContentIntegration"}}}},"responses":{"202":{"content":{"application/json":{"example":{"data":{"branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","created_at":"2026-09-30T10:00:00.123Z","download_url":null,"download_url_expires_at":null,"git_result":null,"id":"reg_0197c8f2-5a6b-7cde-8f12-3456789abcde","language_codes":null,"object_type":"EXPORT","status":"QUEUED","status_details":null,"updated_at":"2026-09-30T10:00:00.123Z"},"job_type":"EXPORT","object_type":"JOB"},"schema":{"$ref":"#/components/schemas/ExportJob"}}},"description":"The push is queued.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the export to poll.","schema":{"type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`branch_not_ready`: the default branch is still being created. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Push to Crisp Helpdesk","tags":["Crisp Helpdesk Integrations"]}},"/v2/projects/{projectId}/integrations/crisp-helpdesk/sync":{"post":{"description":"Brings the project's default branch in line with the Crisp Helpdesk categories, sections and articles, in the background: those that no longer exist are removed from the project, and new ones are imported right away if `is_import_new_resources` is true. Poll the import at the URL in `Location`. Requires stack-level resource management permission.","operationId":"syncCrispHelpdeskIntegration","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncContentIntegration"}}},"required":true},"responses":{"202":{"content":{"application/json":{"example":{"data":{"branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","created_at":"2026-01-15T10:30:00.123Z","git_source":null,"id":"rin_0197c8f2-5a6b-7cde-8f12-3456789abcde","keys_deactivated":0,"keys_reactivated":0,"keys_renamed":0,"object_type":"IMPORT","status":"QUEUED","status_details":null,"texts_created":0,"texts_updated":0,"updated_at":"2026-01-15T10:30:00.123Z"},"job_type":"IMPORT","object_type":"JOB"},"schema":{"$ref":"#/components/schemas/ImportJob"}}},"description":"The sync is queued.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"$ref":"#/components/headers/Location"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`branch_not_ready`: the default branch is still being created. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Sync with Crisp Helpdesk","tags":["Crisp Helpdesk Integrations"]}},"/v2/projects/{projectId}/integrations/git":{"delete":{"description":"Disconnects the project from its repository: its git settings, schedules and the links between its branches and remote branches are removed. The project, its branches and texts stay, and so does the connection for other projects. LingoHub removes its webhooks from the repository; a pull or push that is already running still finishes. Send the ETag from getProjectGitIntegration as If-Match to make sure nobody changed the integration in between. Requires stack-level settings management permission.","operationId":"deleteProjectGitIntegration","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Project Git integration disconnected.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`conflict`: the integration's connection changed meanwhile; read it again and retry.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Disconnect a project's Git integration","tags":["Git Integrations"]},"get":{"description":"Returns the project's git integration: the repository and connection, when LingoHub pulls and pushes, how it pushes, and which files and branches it syncs. Requires stack-level settings management permission.","operationId":"getProjectGitIntegration","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectGitIntegration"}}},"description":"The project's git integration.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve the project's git integration","tags":["Git Integrations"]},"patch":{"description":"Changes the project's git integration (JSON merge-patch): connection, sync schedule, push settings or selection; send only what changes, lists are replaced as a whole. All changes apply together or not at all. Selection changes have side effects: turning branching off deletes every branch except the default one, new branch filters add or remove tracked branches, and new path filters start an import on every branch. A new `git_branch` renames the default branch. Requires stack-level settings management permission.","operationId":"updateProjectGitIntegration","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProjectGitIntegration"}},"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateProjectGitIntegration"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectGitIntegration"}}},"description":"The changed git integration.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`git_integration_unauthorized`: the git host refused the connection's credentials. `branch_not_ready`: the default branch is still being created. `conflict`: the integration changed while the git host was asked; read it again and retry.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`validation_failed`: every invalid field at once, also the combinations the sections must agree on (a `PERIODIC` mode needs its schedule, `ON_COMPLETION` a push type for at least one kind of branch, branch filters need branching). A repository or remote branch the git host does not know is `not_found` on `name` or `git_branch`.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"502":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_error`: the git host failed, or answered with more or other data than LingoHub accepts.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"504":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_timeout`: the git host didn't answer in time.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}}},"security":[{"bearerAuth":[]}],"summary":"Update the project's git integration","tags":["Git Integrations"]},"post":{"description":"Connects the project to a git repository and starts the first pull from `git_branch`; poll the import at the URL in `Location`. The project's default branch is renamed to the remote branch's name. `path_filters` choose the files; an empty list connects without importing any. A project has one git integration: a second one answers 409 `already_exists`. Requires stack-level settings management permission.","operationId":"createProjectGitIntegration","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProjectGitIntegration"}}},"required":true},"responses":{"202":{"content":{"application/json":{"example":{"data":{"branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","created_at":"2026-01-15T10:30:00.123Z","git_source":null,"id":"rin_0197c8f2-5a6b-7cde-8f12-3456789abcde","keys_deactivated":0,"keys_reactivated":0,"keys_renamed":0,"object_type":"IMPORT","status":"QUEUED","status_details":null,"texts_created":0,"texts_updated":0,"updated_at":"2026-01-15T10:30:00.123Z"},"job_type":"IMPORT","object_type":"JOB"},"schema":{"$ref":"#/components/schemas/ImportJob"}}},"description":"Connected; the first pull is queued.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"$ref":"#/components/headers/Location"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`already_exists`: the project already has a git integration. `git_integration_unauthorized`: the git host refused the connection's credentials. `branch_not_ready`: the default branch is still being created. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"502":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_error`: the git host failed, or answered with more or other data than LingoHub accepts.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"503":{"$ref":"#/components/responses/ServiceUnavailable"},"504":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`upstream_timeout`: the git host didn't answer in time.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}}},"security":[{"bearerAuth":[]}],"summary":"Connect a project to Git","tags":["Git Integrations"]}},"/v2/projects/{projectId}/integrations/hubspot":{"get":{"description":"Returns the project's HubSpot integration: the connection it syncs with, which content types and paths it selects, whether pushed translations are published or saved as drafts, and when it last pulled and pushed. Requires stack-level settings management permission.","operationId":"getProjectHubSpotIntegration","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectHubSpotIntegration"}}},"description":"The project's HubSpot integration.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve the HubSpot integration","tags":["HubSpot Integrations"]},"patch":{"description":"Changes which HubSpot content the project syncs (JSON merge-patch; lists are replaced as a whole). New `path_filters` start a sync of the default branch right away; new `enabled_content_types` are saved and apply from the next sync. A sync imports newly selected content and removes content that is no longer selected. Requires stack-level settings management permission.","operationId":"updateProjectHubSpotIntegration","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProjectHubSpotIntegration"}},"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateProjectHubSpotIntegration"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectHubSpotIntegration"}}},"description":"The changed HubSpot integration.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`branch_not_ready`: the default branch is still being created.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Update the HubSpot integration","tags":["HubSpot Integrations"]}},"/v2/projects/{projectId}/integrations/hubspot/pull":{"post":{"description":"Pulls the project's HubSpot content items into its default branch in the background, all of them or the `resource_ids` and `language_codes` you choose; poll the import at the URL in `Location`. To pick up newly selected content items or remove deselected ones, use the sync instead. Requires stack-level resource management permission.","operationId":"pullHubSpotIntegration","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferContentIntegration"}}}},"responses":{"202":{"content":{"application/json":{"example":{"data":{"branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","created_at":"2026-01-15T10:30:00.123Z","git_source":null,"id":"rin_0197c8f2-5a6b-7cde-8f12-3456789abcde","keys_deactivated":0,"keys_reactivated":0,"keys_renamed":0,"object_type":"IMPORT","status":"QUEUED","status_details":null,"texts_created":0,"texts_updated":0,"updated_at":"2026-01-15T10:30:00.123Z"},"job_type":"IMPORT","object_type":"JOB"},"schema":{"$ref":"#/components/schemas/ImportJob"}}},"description":"The pull is queued.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"$ref":"#/components/headers/Location"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`branch_not_ready`: the default branch is still being created. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Pull from HubSpot","tags":["HubSpot Integrations"]}},"/v2/projects/{projectId}/integrations/hubspot/push":{"post":{"description":"Pushes the translations of the project's default branch into HubSpot in the background, for all content items and languages or the `resource_ids` and `language_codes` you choose; poll the export at the URL in `Location`. Some content items can be written while others fail: the export then ends `PARTIALLY_SUCCEEDED`. Language variants that don't exist in HubSpot yet are created; translations go live right away if the integration has `is_publish_on_push`, otherwise they stay drafts. Requires stack-level resource management permission.","operationId":"pushHubSpotIntegration","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferContentIntegration"}}}},"responses":{"202":{"content":{"application/json":{"example":{"data":{"branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","created_at":"2026-09-30T10:00:00.123Z","download_url":null,"download_url_expires_at":null,"git_result":null,"id":"reg_0197c8f2-5a6b-7cde-8f12-3456789abcde","language_codes":null,"object_type":"EXPORT","status":"QUEUED","status_details":null,"updated_at":"2026-09-30T10:00:00.123Z"},"job_type":"EXPORT","object_type":"JOB"},"schema":{"$ref":"#/components/schemas/ExportJob"}}},"description":"The push is queued.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the export to poll.","schema":{"type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`branch_not_ready`: the default branch is still being created. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Push to HubSpot","tags":["HubSpot Integrations"]}},"/v2/projects/{projectId}/integrations/hubspot/sync":{"post":{"description":"Brings the project's default branch in line with the HubSpot content items its selection covers, in the background: content items that are no longer selected or no longer exist are removed from the project, and new ones are imported right away if `is_import_new_resources` is true. Poll the import at the URL in `Location`. Requires stack-level resource management permission.","operationId":"syncHubSpotIntegration","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncContentIntegration"}}},"required":true},"responses":{"202":{"content":{"application/json":{"example":{"data":{"branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","created_at":"2026-01-15T10:30:00.123Z","git_source":null,"id":"rin_0197c8f2-5a6b-7cde-8f12-3456789abcde","keys_deactivated":0,"keys_reactivated":0,"keys_renamed":0,"object_type":"IMPORT","status":"QUEUED","status_details":null,"texts_created":0,"texts_updated":0,"updated_at":"2026-01-15T10:30:00.123Z"},"job_type":"IMPORT","object_type":"JOB"},"schema":{"$ref":"#/components/schemas/ImportJob"}}},"description":"The sync is queued.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"$ref":"#/components/headers/Location"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`branch_not_ready`: the default branch is still being created. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Sync with HubSpot","tags":["HubSpot Integrations"]}},"/v2/projects/{projectId}/integrations/storyblok":{"get":{"description":"Returns the project's Storyblok integration: the connection and space it syncs with, which stories its `path_filters` select, and when it last pulled and pushed. Requires stack-level settings management permission.","operationId":"getProjectStoryblokIntegration","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectStoryblokIntegration"}}},"description":"The project's Storyblok integration.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve the Storyblok integration","tags":["Storyblok Integrations"]},"patch":{"description":"Changes which Storyblok stories the project syncs (JSON merge-patch; `path_filters`, matched against story paths, is replaced as a whole). A changed selection starts a sync of the default branch right away, which imports newly selected stories and removes stories that are no longer selected. Sending the same selection changes nothing. Requires stack-level settings management permission.","operationId":"updateProjectStoryblokIntegration","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateContentIntegration"}},"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateContentIntegration"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectStoryblokIntegration"}}},"description":"The changed Storyblok integration.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`branch_not_ready`: the default branch is still being created.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Update the Storyblok integration","tags":["Storyblok Integrations"]}},"/v2/projects/{projectId}/integrations/storyblok/pull":{"post":{"description":"Pulls the project's Storyblok stories into its default branch in the background, all of them or the `resource_ids` and `language_codes` you choose; poll the import at the URL in `Location`. To pick up newly selected stories or remove deselected ones, use the sync instead. Requires stack-level resource management permission.","operationId":"pullStoryblokIntegration","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferContentIntegration"}}}},"responses":{"202":{"content":{"application/json":{"example":{"data":{"branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","created_at":"2026-01-15T10:30:00.123Z","git_source":null,"id":"rin_0197c8f2-5a6b-7cde-8f12-3456789abcde","keys_deactivated":0,"keys_reactivated":0,"keys_renamed":0,"object_type":"IMPORT","status":"QUEUED","status_details":null,"texts_created":0,"texts_updated":0,"updated_at":"2026-01-15T10:30:00.123Z"},"job_type":"IMPORT","object_type":"JOB"},"schema":{"$ref":"#/components/schemas/ImportJob"}}},"description":"The pull is queued.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"$ref":"#/components/headers/Location"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`branch_not_ready`: the default branch is still being created. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Pull from Storyblok","tags":["Storyblok Integrations"]}},"/v2/projects/{projectId}/integrations/storyblok/push":{"post":{"description":"Pushes the translations of the project's default branch into Storyblok in the background, for all stories and languages or the `resource_ids` and `language_codes` you choose; poll the export at the URL in `Location`. Some stories can be written while others fail: the export then ends `PARTIALLY_SUCCEEDED`. Translations are written into each story's fields for that language; LingoHub doesn't publish anything in Storyblok, so publishing stays a step there. Requires stack-level resource management permission.","operationId":"pushStoryblokIntegration","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferContentIntegration"}}}},"responses":{"202":{"content":{"application/json":{"example":{"data":{"branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","created_at":"2026-09-30T10:00:00.123Z","download_url":null,"download_url_expires_at":null,"git_result":null,"id":"reg_0197c8f2-5a6b-7cde-8f12-3456789abcde","language_codes":null,"object_type":"EXPORT","status":"QUEUED","status_details":null,"updated_at":"2026-09-30T10:00:00.123Z"},"job_type":"EXPORT","object_type":"JOB"},"schema":{"$ref":"#/components/schemas/ExportJob"}}},"description":"The push is queued.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the export to poll.","schema":{"type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`branch_not_ready`: the default branch is still being created. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Push to Storyblok","tags":["Storyblok Integrations"]}},"/v2/projects/{projectId}/integrations/storyblok/sync":{"post":{"description":"Brings the project's default branch in line with the Storyblok stories its selection covers, in the background: stories that are no longer selected or no longer exist are removed from the project, and new ones are imported right away if `is_import_new_resources` is true. Poll the import at the URL in `Location`. Requires stack-level resource management permission.","operationId":"syncStoryblokIntegration","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncContentIntegration"}}},"required":true},"responses":{"202":{"content":{"application/json":{"example":{"data":{"branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","created_at":"2026-01-15T10:30:00.123Z","git_source":null,"id":"rin_0197c8f2-5a6b-7cde-8f12-3456789abcde","keys_deactivated":0,"keys_reactivated":0,"keys_renamed":0,"object_type":"IMPORT","status":"QUEUED","status_details":null,"texts_created":0,"texts_updated":0,"updated_at":"2026-01-15T10:30:00.123Z"},"job_type":"IMPORT","object_type":"JOB"},"schema":{"$ref":"#/components/schemas/ImportJob"}}},"description":"The sync is queued.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"$ref":"#/components/headers/Location"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`branch_not_ready`: the default branch is still being created. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Sync with Storyblok","tags":["Storyblok Integrations"]}},"/v2/projects/{projectId}/integrations/stripo":{"get":{"description":"Returns the project's Stripo integration: the connection it syncs with, which email templates its `path_filters` select by name, and when it last pulled and pushed. Requires stack-level settings management permission.","operationId":"getProjectStripoIntegration","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectStripoIntegration"}}},"description":"The project's Stripo integration.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve the Stripo integration","tags":["Stripo Integrations"]},"patch":{"description":"Changes which Stripo email templates the project syncs (JSON merge-patch; `path_filters`, matched against template names, is replaced as a whole). A changed selection starts a sync of the default branch right away, which imports newly matching templates and removes templates that no longer match. Sending the same selection changes nothing. Requires stack-level settings management permission.","operationId":"updateProjectStripoIntegration","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateContentIntegration"}},"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateContentIntegration"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectStripoIntegration"}}},"description":"The changed Stripo integration.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`branch_not_ready`: the default branch is still being created.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Update the Stripo integration","tags":["Stripo Integrations"]}},"/v2/projects/{projectId}/integrations/stripo/pull":{"post":{"description":"Pulls the project's Stripo email templates into its default branch in the background, all of them or the `resource_ids` and `language_codes` you choose; poll the import at the URL in `Location`. To pick up newly selected email templates or remove deselected ones, use the sync instead. Requires stack-level resource management permission.","operationId":"pullStripoIntegration","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferContentIntegration"}}}},"responses":{"202":{"content":{"application/json":{"example":{"data":{"branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","created_at":"2026-01-15T10:30:00.123Z","git_source":null,"id":"rin_0197c8f2-5a6b-7cde-8f12-3456789abcde","keys_deactivated":0,"keys_reactivated":0,"keys_renamed":0,"object_type":"IMPORT","status":"QUEUED","status_details":null,"texts_created":0,"texts_updated":0,"updated_at":"2026-01-15T10:30:00.123Z"},"job_type":"IMPORT","object_type":"JOB"},"schema":{"$ref":"#/components/schemas/ImportJob"}}},"description":"The pull is queued.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"$ref":"#/components/headers/Location"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`branch_not_ready`: the default branch is still being created. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Pull from Stripo","tags":["Stripo Integrations"]}},"/v2/projects/{projectId}/integrations/stripo/push":{"post":{"description":"Pushes the translations of the project's default branch into Stripo in the background, for all email templates and languages or the `resource_ids` and `language_codes` you choose; poll the export at the URL in `Location`. Some email templates can be written while others fail: the export then ends `PARTIALLY_SUCCEEDED`. Each template gets one translation version per language in Stripo; missing versions are created, then the translations are applied to them. Requires stack-level resource management permission.","operationId":"pushStripoIntegration","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferContentIntegration"}}}},"responses":{"202":{"content":{"application/json":{"example":{"data":{"branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","created_at":"2026-09-30T10:00:00.123Z","download_url":null,"download_url_expires_at":null,"git_result":null,"id":"reg_0197c8f2-5a6b-7cde-8f12-3456789abcde","language_codes":null,"object_type":"EXPORT","status":"QUEUED","status_details":null,"updated_at":"2026-09-30T10:00:00.123Z"},"job_type":"EXPORT","object_type":"JOB"},"schema":{"$ref":"#/components/schemas/ExportJob"}}},"description":"The push is queued.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the export to poll.","schema":{"type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`branch_not_ready`: the default branch is still being created. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Push to Stripo","tags":["Stripo Integrations"]}},"/v2/projects/{projectId}/integrations/stripo/sync":{"post":{"description":"Brings the project's default branch in line with the Stripo email templates its selection covers, in the background: email templates that are no longer selected or no longer exist are removed from the project, and new ones are imported right away if `is_import_new_resources` is true. Poll the import at the URL in `Location`. Requires stack-level resource management permission.","operationId":"syncStripoIntegration","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncContentIntegration"}}},"required":true},"responses":{"202":{"content":{"application/json":{"example":{"data":{"branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","created_at":"2026-01-15T10:30:00.123Z","git_source":null,"id":"rin_0197c8f2-5a6b-7cde-8f12-3456789abcde","keys_deactivated":0,"keys_reactivated":0,"keys_renamed":0,"object_type":"IMPORT","status":"QUEUED","status_details":null,"texts_created":0,"texts_updated":0,"updated_at":"2026-01-15T10:30:00.123Z"},"job_type":"IMPORT","object_type":"JOB"},"schema":{"$ref":"#/components/schemas/ImportJob"}}},"description":"The sync is queued.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"$ref":"#/components/headers/Location"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`branch_not_ready`: the default branch is still being created. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Sync with Stripo","tags":["Stripo Integrations"]}},"/v2/projects/{projectId}/integrations/zendesk":{"get":{"description":"Returns the project's Zendesk integration: the connection it syncs with, which categories, sections and articles its `path_filters` select by name path, and when it last pulled and pushed. Requires stack-level settings management permission.","operationId":"getProjectZendeskIntegration","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectZendeskIntegration"}}},"description":"The project's Zendesk integration.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve the Zendesk integration","tags":["Zendesk Integrations"]},"patch":{"description":"Changes which Zendesk categories, sections and articles the project syncs (JSON merge-patch; `path_filters`, matched against `Category/Section/Article` name paths, is replaced as a whole). A changed selection starts a sync of the default branch right away, which imports newly selected articles and removes those no longer selected. Sending the same selection changes nothing. Requires stack-level settings management permission.","operationId":"updateProjectZendeskIntegration","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateContentIntegration"}},"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateContentIntegration"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectZendeskIntegration"}}},"description":"The changed Zendesk integration.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`branch_not_ready`: the default branch is still being created.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Update the Zendesk integration","tags":["Zendesk Integrations"]}},"/v2/projects/{projectId}/integrations/zendesk/pull":{"post":{"description":"Pulls the project's Zendesk categories, sections and articles into its default branch in the background, all of them or the `resource_ids` and `language_codes` you choose; poll the import at the URL in `Location`. To pick up newly selected categories, sections and articles or remove deselected ones, use the sync instead. Requires stack-level resource management permission.","operationId":"pullZendeskIntegration","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferContentIntegration"}}}},"responses":{"202":{"content":{"application/json":{"example":{"data":{"branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","created_at":"2026-01-15T10:30:00.123Z","git_source":null,"id":"rin_0197c8f2-5a6b-7cde-8f12-3456789abcde","keys_deactivated":0,"keys_reactivated":0,"keys_renamed":0,"object_type":"IMPORT","status":"QUEUED","status_details":null,"texts_created":0,"texts_updated":0,"updated_at":"2026-01-15T10:30:00.123Z"},"job_type":"IMPORT","object_type":"JOB"},"schema":{"$ref":"#/components/schemas/ImportJob"}}},"description":"The pull is queued.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"$ref":"#/components/headers/Location"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`branch_not_ready`: the default branch is still being created. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Pull from Zendesk","tags":["Zendesk Integrations"]}},"/v2/projects/{projectId}/integrations/zendesk/push":{"post":{"description":"Pushes the translations of the project's default branch into Zendesk in the background, for all categories, sections and articles and languages or the `resource_ids` and `language_codes` you choose; poll the export at the URL in `Location`. Some categories, sections and articles can be written while others fail: the export then ends `PARTIALLY_SUCCEEDED`. Each category, section and article gets its translation created or updated in the help center. Requires stack-level resource management permission.","operationId":"pushZendeskIntegration","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferContentIntegration"}}}},"responses":{"202":{"content":{"application/json":{"example":{"data":{"branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","created_at":"2026-09-30T10:00:00.123Z","download_url":null,"download_url_expires_at":null,"git_result":null,"id":"reg_0197c8f2-5a6b-7cde-8f12-3456789abcde","language_codes":null,"object_type":"EXPORT","status":"QUEUED","status_details":null,"updated_at":"2026-09-30T10:00:00.123Z"},"job_type":"EXPORT","object_type":"JOB"},"schema":{"$ref":"#/components/schemas/ExportJob"}}},"description":"The push is queued.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the export to poll.","schema":{"type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`branch_not_ready`: the default branch is still being created. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Push to Zendesk","tags":["Zendesk Integrations"]}},"/v2/projects/{projectId}/integrations/zendesk/sync":{"post":{"description":"Brings the project's default branch in line with the Zendesk categories, sections and articles its selection covers, in the background: categories, sections and articles that are no longer selected or no longer exist are removed from the project, and new ones are imported right away if `is_import_new_resources` is true. Poll the import at the URL in `Location`. Requires stack-level resource management permission.","operationId":"syncZendeskIntegration","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncContentIntegration"}}},"required":true},"responses":{"202":{"content":{"application/json":{"example":{"data":{"branch_id":"prb_0197c8f2-5a6b-7cde-8f12-3456789abcde","created_at":"2026-01-15T10:30:00.123Z","git_source":null,"id":"rin_0197c8f2-5a6b-7cde-8f12-3456789abcde","keys_deactivated":0,"keys_reactivated":0,"keys_renamed":0,"object_type":"IMPORT","status":"QUEUED","status_details":null,"texts_created":0,"texts_updated":0,"updated_at":"2026-01-15T10:30:00.123Z"},"job_type":"IMPORT","object_type":"JOB"},"schema":{"$ref":"#/components/schemas/ImportJob"}}},"description":"The sync is queued.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"$ref":"#/components/headers/Location"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`branch_not_ready`: the default branch is still being created. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Sync with Zendesk","tags":["Zendesk Integrations"]}},"/v2/projects/{projectId}/move":{"post":{"description":"Moves the project into another stack in the background; poll the URL in `Location` (getProjectMove). The destination gets the project's languages it doesn't have yet. The project keeps its own texts (nothing is merged) and from then on runs the destination's automations. Members and their language permissions aren't copied, so someone who was only a member of the old stack can lose access. API key permissions the destination lacks are copied. A project with its own private stack can join any stack (a private destination becomes shared) and its old stack is removed; a project in a shared stack can only move to another shared stack. Needs settings-management permission on the project and on the destination stack.","operationId":"moveProject","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoveProject"}}},"required":true},"responses":{"202":{"content":{"application/json":{"examples":{"queued":{"description":"queued","value":{"data":{"created_at":"2026-01-01T10:00:00.000Z","id":"rsy_0197c8f2-5a6b-7cde-8f12-3456789abcde","object_type":"PROJECT_MOVE","project_id":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","source_stack_id":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","status":"QUEUED","status_details":null,"target_stack_id":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcdf","type":"MOVE","updated_at":"2026-01-01T10:00:00.000Z"},"job_type":"PROJECT_MOVE","object_type":"JOB"}}},"schema":{"$ref":"#/components/schemas/ProjectMoveJob"}}},"description":"Move queued.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the project move to poll.","schema":{"format":"uri-reference","type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The project cannot currently move: active work, incompatible source state or the same destination. No move was queued. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Move a project","tags":["Project Moves"]}},"/v2/projects/{projectId}/settings":{"get":{"description":"Returns all settings of the project: export and import defaults, file-format options, key normalisation, placeholder recognition and, if the project has an integration, the integration settings. Imports and exports use these defaults unless they override them; one that already ran keeps the settings it ran with. Requires project-level settings management permission.","operationId":"getProjectSettings","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectSettings"}}},"description":"The project's settings.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve project settings","tags":["Project Settings"]},"patch":{"description":"Changes any of the project's settings (JSON merge-patch): send only the sections and fields that change; lists are replaced as a whole. Imports and exports that start, or are queued without their own settings, use the new values; existing keys and texts aren't rewritten. Integration settings apply from the next sync. All changes are applied together or not at all. Requires project-level settings management permission.","operationId":"updateProjectSettings","parameters":[{"in":"path","name":"projectId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProjectSettings"}},"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateProjectSettings"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectSettings"}}},"description":"The project's settings after the change.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Update project settings","tags":["Project Settings"]}},"/v2/resources/{resourceId}":{"delete":{"description":"Deletes a file or folder with everything below it, including its keys. The segments and their texts stay in the stack; a segment whose only key was in this file has no key afterwards. Import and export history is kept. In a project connected to Git, a file still in the repository comes back with the next pull. This can't be undone, except by restoring a backup of the branch. A resource the key can't see returns 404, the same as one that doesn't exist. Requires project-level resource management permission.","operationId":"deleteResource","parameters":[{"description":"Unique identifier of the resource.","example":"rc_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"resourceId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a resource container, a valid value would be : rc_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Resource deleted successfully.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Another resource tree mutation is in progress (`conflict`). Refresh and retry.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Delete a resource","tags":["Resources"]},"get":{"description":"Returns one file or folder with its per-language counts and content versions. A resource the key can't see returns 404, the same as one that doesn't exist. Requires project-level resource view permission.","operationId":"getResource","parameters":[{"description":"Unique identifier of the resource.","example":"rc_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"resourceId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a resource container, a valid value would be : rc_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}},"description":"Resource retrieved successfully.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve a resource","tags":["Resources"]},"patch":{"description":"Renames or moves a file or folder (JSON merge-patch); moving a folder moves everything below it. Exports and Git pushes use the new path from then on. `language_code_separator` sets how the language is joined to the file name (`_`, `-` or `.`; Android XML also `-r`). Requires project-level resource management permission.","operationId":"updateResource","parameters":[{"description":"Unique identifier of the resource.","example":"rc_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"resourceId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a resource container, a valid value would be : rc_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateResource"}},"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateResource"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}},"description":"Resource updated successfully.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Another resource already has this path (`already_exists`), an ancestor is a file, or another tree mutation is in progress (`conflict`). Refresh and retry a tree conflict.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Update a resource","tags":["Resources"]}},"/v2/resources/{resourceId}/keys":{"get":{"description":"Lists the keys of a file in file order. A key is where a segment appears in this file; `segment_id` leads to its texts. To find one key, filter `key[key]` with `_eq` and the full key, as you'd send it to createKey. Requires stack-level segment, key and resource view permissions.","operationId":"listKeys","parameters":[{"description":"Public identifier of the file.","in":"path","name":"resourceId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a resource container, a valid value would be : rc_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^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}$","type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceKeyFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `ResourceKeyFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `key[created_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `key[id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `key[key]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | – |\n| `key[position]` | integer | `_eq` `_ne` `_in` `_nin` `_gt` `_lt` `_gte` `_lte` `_within` `_null` `_nnull` | yes |\n| `key[segment_id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `key[updated_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyCollection"}}},"description":"Retrieved successfully.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List keys","tags":["Keys"]},"post":{"description":"Creates a key after the last key of its group in the file, with a new segment and its source text. The stack's automations set the statuses and labels, as for a key created in the editor; without a matching automation the texts start as NEW. The new key is never linked to an existing segment with the same text. Single-language CSV files only take complete rows; import the file instead. Requires stack-level segment and key management and resource view permissions.","operationId":"createKey","parameters":[{"description":"Public identifier of the file.","in":"path","name":"resourceId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a resource container, a valid value would be : rc_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateKey"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Key"}}},"description":"The created key.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the created key.","schema":{"type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`conflict`: the file is a single-language CSV file, which only takes complete rows (import it instead); the file's format or project doesn't take keys created by hand; another change to the file's keys is in progress (retry); or an automation that runs on new keys adds a label that was deleted. `already_exists`: the file has the key. `branch_not_ready`: the branch hasn't finished initializing. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Create a key","tags":["Keys"]}},"/v2/resources/{resourceId}/keys/bulk-create":{"post":{"description":"Creates up to 150 keys in one file, each with a new segment and its source text, in the order given. Either all keys are created or none: the first problem stops the batch, and its error points at the item. Requires stack-level segment and key management and resource view permissions.","operationId":"createKeysBulk","parameters":[{"description":"Public identifier of the file.","in":"path","name":"resourceId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a resource container, a valid value would be : rc_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateKeysBulk"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyList"}}},"description":"The created keys, in the order of the request.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`conflict`: the file is a single-language CSV file, which only takes complete rows (import it instead); the file's format or project doesn't take keys created by hand; another change to the file's keys is in progress (retry); or an automation that runs on new keys adds a label that was deleted. `already_exists`: the file has the key. `branch_not_ready`: the branch hasn't finished initializing. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Create keys in a batch","tags":["Keys"]}},"/v2/segments/{segmentId}":{"get":{"description":"Returns a segment with its texts in all languages of its stack, or in the languages named by `language_codes`. Deactivated segments, which are in no file, can be read too. Its keys are listed by listSegmentKeys. Requires stack-level segment and text view permissions.","operationId":"getSegment","parameters":[{"description":"Public identifier of the segment.","in":"path","name":"segmentId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a segment, a valid value would be : seg_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^seg_[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}$","type":"string"}},{"description":"Language codes of the texts to show, separated by commas; the stack's languages when left out.","example":["de","fr"],"explode":false,"in":"query","name":"language_codes","required":false,"schema":{"items":{"type":"string"},"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Segment"}}},"description":"Retrieved successfully.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve a segment","tags":["Segments"]},"patch":{"description":"Changes a segment and its texts with JSON merge-patch; changes apply to every key of the segment. `texts` takes only the languages you change: `variants` replaces that language's text and an empty list clears it. Texts are processed with the placeholder settings and automations of `project_id`, by default the project of the segment's oldest key. Becoming singular keeps the OTHER form and removes the other plural forms in all languages. Send the ETag from getSegment as If-Match to make sure nobody changed the segment in between. Requires stack-level segment and text view permissions, segment management to change the segment and text management to change its texts.","operationId":"updateSegment","parameters":[{"description":"Public identifier of the segment.","in":"path","name":"segmentId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a segment, a valid value would be : seg_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^seg_[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}$","type":"string"}},{"description":"Project whose placeholder settings and automations process the texts. It must have a key of the segment; the project of the segment's oldest key when left out.","example":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"query","name":"project_id","required":false,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^pr_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSegment"}},"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateSegment"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Segment"}}},"description":"The segment after the change, with its texts in all languages of its stack.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`conflict`: the segment is deactivated (it is in no file) so its texts can't be changed, the project's edit settings refer to something that no longer exists, or another change to the segment's texts is in progress (retry).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Update a segment","tags":["Segments"]}},"/v2/segments/{segmentId}/keys":{"get":{"description":"Lists every key of a segment, in all projects and branches of its stack, oldest first. A change to the segment's texts shows in all of them. An empty list means the segment is deactivated: it is in no file any more. Requires stack-level segment, key and resource view permissions.","operationId":"listSegmentKeys","parameters":[{"description":"Public identifier of the segment.","in":"path","name":"segmentId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a segment, a valid value would be : seg_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^seg_[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}$","type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentKeyFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `SegmentKeyFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `key[branch_id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `key[created_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `key[id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `key[key]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | – |\n| `key[resource_id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `key[updated_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyCollection"}}},"description":"Retrieved successfully.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List segment keys","tags":["Keys"]}},"/v2/segments/{segmentId}/transition":{"post":{"description":"Changes the status of one text: APPROVE, REOPEN, MARK_TRANSLATED or REJECT. The source text takes only APPROVE and REOPEN. Approving dismisses its quality findings, and any action stops LINA's automatic retries for that text. The text's content stays unchanged and is not checked: a text without content can be approved or marked translated, as in the editor. Requires stack-level text management and segment and text view permissions.","operationId":"transitionSegment","parameters":[{"description":"Public identifier of the segment.","in":"path","name":"segmentId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a segment, a valid value would be : seg_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^seg_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransitionSegment"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Segment"}}},"description":"The segment after the change, with its texts in all languages of its stack.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`conflict`: another change to the segment's texts is in progress (retry). An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Change the status of a text","tags":["Segments"]}},"/v2/stack-roles":{"get":{"description":"Lists the workspace's stack roles, built-in and custom. A stack role sets what a member can do inside a stack; the same roles apply in every stack. Use a role's id for stack members and invitation stack assignments. The owner role is listed but can't be assigned through the API. Requires workspace-level members view permission.","operationId":"listStackRoles","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackRoleFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `StackRoleFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `stack_role[created_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `stack_role[description]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | – |\n| `stack_role[id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `stack_role[name]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | yes |\n| `stack_role[type]` | OWNER \\| LOCALIZATION_MANAGER \\| MEMBER \\| CUSTOM | `_eq` `_ne` `_in` `_nin` | – |\n| `stack_role[updated_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackRoleCollection"}}},"description":"Stack roles retrieved.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List stack roles","tags":["Stack Roles"]}},"/v2/stack-roles/{stackRoleId}":{"get":{"description":"Returns one stack role of the workspace. The owner role can be read but not assigned through the API. Requires workspace-level members view permission.","operationId":"getStackRole","parameters":[{"in":"path","name":"stackRoleId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^stackr_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackRole"}}},"description":"Stack role retrieved.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve a stack role","tags":["Stack Roles"]}},"/v2/stacks":{"get":{"description":"Lists the workspace's stacks that the key can see. Each project without a shared stack has its own private stack, which is listed too (`type: PRIVATE`; filter with `stack[type]`). Requires workspace-level general view permission.","operationId":"listStacks","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `StackFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `stack[created_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `stack[id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `stack[name]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | yes |\n| `stack[type]` | PRIVATE \\| PUBLIC | `_eq` `_ne` `_in` `_nin` | – |\n| `stack[updated_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackCollection"}}},"description":"Stacks retrieved successfully.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List stacks","tags":["Stacks"]},"post":{"description":"Creates a shared (`PUBLIC`) stack in the workspace. A project's own private stack is created with the project (createProject without `stack_id`). Requires workspace-level stack management permission.","operationId":"createStack","parameters":[{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateStack"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Stack"}}},"description":"Stack created successfully.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the created stack.","schema":{"format":"uri-reference","type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Create a stack","tags":["Stacks"]}},"/v2/stacks/{stackId}":{"delete":{"description":"Permanently deletes an empty stack and everything that belongs to it; this can't be undone. Delete its projects or move them to another stack first (moveProject), otherwise 409 `stack_not_empty`. API keys limited to this stack stop working. Requires workspace-level stack management permission.","operationId":"deleteStack","parameters":[{"description":"Unique identifier of the stack.","example":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"stackId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a stack, a valid value would be : stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stack_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Stack deleted successfully.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The stack still contains projects (`stack_not_empty`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Delete a stack","tags":["Stacks"]},"get":{"description":"Returns one stack. A stack the key can't see returns 404, the same as one that doesn't exist. Requires stack-level general view permission.","operationId":"getStack","parameters":[{"description":"Unique identifier of the stack.","example":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"stackId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a stack, a valid value would be : stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stack_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Stack"}}},"description":"Stack retrieved successfully.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve a stack","tags":["Stacks"]},"patch":{"description":"Changes a stack's name, colour, AI context or LINA (JSON merge-patch; omitted fields stay unchanged). `null` removes the AI context or the LINA; the stack languages keep their LINA role. Requires stack-level settings management permission.","operationId":"updateStack","parameters":[{"description":"Unique identifier of the stack.","example":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"stackId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a stack, a valid value would be : stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stack_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateStack"}},"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateStack"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Stack"}}},"description":"Stack updated successfully.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Update a stack","tags":["Stacks"]}},"/v2/stacks/{stackId}/automation-settings":{"get":{"description":"Returns the stack's automation rules in the order they run, and the maximum number of rules allowed. The rules apply to every project of the stack and run grouped by type: text replacements first, then status changes, then labels. A label action whose label was deleted shows `label_id: null`. Requires stack-level settings management permission.","operationId":"getStackAutomationSettings","parameters":[{"in":"path","name":"stackId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a stack, a valid value would be : stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stack_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackAutomationSettings"}}},"description":"Current automation settings retrieved.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve stack automation settings","tags":["Stacks"]},"put":{"description":"Replaces all automation rules of the stack with the given list, in order; an empty list removes them all. Send a rule's `rule_key` to keep its identity; new rules get one. The number of rules is limited by the plan (`max_rules`). Saving doesn't run the rules on existing content. Requires stack-level settings management permission.","operationId":"setStackAutomationSettings","parameters":[{"in":"path","name":"stackId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a stack, a valid value would be : stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stack_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetStackAutomationSettings"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackAutomationSettings"}}},"description":"Saved automation configuration. GET for the current ETag.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The list has more rules than the plan allows (`automation_limit_reached`); `max_rules` is the limit.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Replace stack automation settings","tags":["Stacks"]}},"/v2/stacks/{stackId}/languages":{"get":{"description":"Lists the stack's languages: the source language first, then the target languages by language code. Requires stack-level languages view permission.","operationId":"listStackLanguages","parameters":[{"description":"Unique identifier of the stack.","example":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"stackId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a stack, a valid value would be : stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stack_[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}$","type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackLanguageFilter"}}},"description":"Filters the list: URL-encoded JSON of the schema `StackLanguageFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. This list cannot be sorted. An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators |\n|---|---|---|\n| `stack_language[is_source]` | boolean | `_true` `_false` |\n| `stack_language[language_code]` | language code | `_eq` `_ne` `_in` `_nin` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` `_gt` |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackLanguageCollection"}}},"description":"Stack languages retrieved successfully.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List stack languages","tags":["Stack Languages"]}},"/v2/stacks/{stackId}/languages/{languageCode}":{"delete":{"description":"Permanently removes a target language from the stack, together with every translation in that language and the language in all projects of the stack; this can't be undone. The source language can't be removed (409 `source_language_protected`), nor a language with an active translation order (409 `translation_order_pending`). Languages that used it as fallback lose their fallback. Requires stack-level languages management permission.","operationId":"deleteStackLanguage","parameters":[{"description":"Unique identifier of the stack.","example":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"stackId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a stack, a valid value would be : stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stack_[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}$","type":"string"}},{"description":"Language code that uniquely identifies a locale.","example":"de-AT","in":"path","name":"languageCode","required":true,"schema":{"description":"Language code that uniquely identifies a locale. Valid examples would be 'en', 'en-GB', 'de', 'de-DE' etc. according to [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Stack language removed successfully.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The language is the source language (`source_language_protected`), or a translation order for it is still active (`translation_order_pending`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Remove a stack language","tags":["Stack Languages"]},"get":{"description":"Returns the stack language identified by its language code. Requires stack-level languages view permission.","operationId":"getStackLanguage","parameters":[{"description":"Unique identifier of the stack.","example":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"stackId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a stack, a valid value would be : stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stack_[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}$","type":"string"}},{"description":"Language code that uniquely identifies a locale.","example":"de-AT","in":"path","name":"languageCode","required":true,"schema":{"description":"Language code that uniquely identifies a locale. Valid examples would be 'en', 'en-GB', 'de', 'de-DE' etc. according to [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackLanguage"}}},"description":"Stack language retrieved successfully.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve a stack language","tags":["Stack Languages"]},"patch":{"description":"Changes the LINA role of a stack language (JSON merge-patch). The role only has an effect while the stack has a LINA. Set `fallback_language_code` to the language used when a translation is missing (another stack language; loops rejected); it applies to every project of the stack. The source language can't be changed here; switching the source is a separate action that the API doesn't offer. Requires stack-level languages management permission.","operationId":"updateStackLanguage","parameters":[{"description":"Unique identifier of the stack.","example":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"stackId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a stack, a valid value would be : stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stack_[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}$","type":"string"}},{"description":"Language code that uniquely identifies a locale.","example":"de-AT","in":"path","name":"languageCode","required":true,"schema":{"description":"Language code that uniquely identifies a locale. Valid examples would be 'en', 'en-GB', 'de', 'de-DE' etc. according to [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateStackLanguage"}},"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateStackLanguage"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackLanguage"}}},"description":"Stack language updated successfully.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Update a stack language","tags":["Stack Languages"]},"put":{"description":"Adds a target language to the stack. If the stack already has it, it's returned unchanged with 200; otherwise 201 with a `Location` header. The stack's projects don't get the language automatically; add it to a project branch with addProjectLanguages. Set a fallback language or LINA role afterwards with updateStackLanguage. The source language can't be changed here; switching the source is a separate action that the API doesn't offer. Requires stack-level languages management permission.","operationId":"addStackLanguage","parameters":[{"description":"Unique identifier of the stack.","example":"stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"stackId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a stack, a valid value would be : stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stack_[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}$","type":"string"}},{"description":"Language code that uniquely identifies a locale.","example":"de-AT","in":"path","name":"languageCode","required":true,"schema":{"description":"Language code that uniquely identifies a locale. Valid examples would be 'en', 'en-GB', 'de', 'de-DE' etc. according to [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackLanguage"}}},"description":"The stack already had the language.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackLanguage"}}},"description":"Stack language added.","headers":{"Location":{"description":"URL of the added stack language.","schema":{"format":"uri-reference","type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The language code is not a supported locale (`invalid_parameter`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Add a stack language","tags":["Stack Languages"]}},"/v2/stacks/{stackId}/member-permissions/{memberId}":{"get":{"description":"Shows what a workspace member can actually do in the stack: access from their workspace role, their stack role and the default language permissions, also for members who weren't added to the stack explicitly. It only reads; nothing changes. Requires stack-level settings management permission.","operationId":"getStackMemberPermissions","parameters":[{"in":"path","name":"stackId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a stack, a valid value would be : stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stack_[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}$","type":"string"}},{"in":"path","name":"memberId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^wsu_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackMemberPermissions"}}},"description":"Effective member permissions retrieved successfully.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve effective stack member permissions","tags":["Stack Member Permissions"]}},"/v2/stacks/{stackId}/members":{"get":{"description":"Lists the members explicitly added to the stack, with their stack role and language permissions. People who reach the stack through their workspace role (for example admins) aren't listed unless they were added. For what a member can actually do in the stack, use getStackMemberPermissions. Requires stack-level settings management permission.","operationId":"listStackMembers","parameters":[{"in":"path","name":"stackId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a stack, a valid value would be : stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stack_[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}$","type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackMemberFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `StackMemberFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `stack_member[created_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `stack_member[email]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | – |\n| `stack_member[first_name]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | – |\n| `stack_member[id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `stack_member[last_name]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | – |\n| `stack_member[stack_role_id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `stack_member[updated_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackMemberCollection"}}},"description":"Stack members retrieved.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List explicit stack members","tags":["Stack Members"]}},"/v2/stacks/{stackId}/members/{memberId}":{"delete":{"description":"Removes a member's explicit assignment from the stack, with its language permissions. Their language assignments in this stack are cleared and their stack responsibilities handed to another member. The workspace membership stays, and access through the workspace role (for example as admin) remains. Owners can't be removed here (409), and a personal API key can't remove its own member. Requires stack-level settings management permission.","operationId":"deleteStackMember","parameters":[{"in":"path","name":"stackId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a stack, a valid value would be : stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stack_[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}$","type":"string"}},{"in":"path","name":"memberId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^wsu_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Explicit stack assignment removed.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Workspace or targeted stack owner membership is protected (`owner_membership_protected`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Remove an explicit stack member","tags":["Stack Members"]},"get":{"description":"Returns one member's explicit assignment in the stack. A member who only reaches the stack through their workspace role (for example an admin) has no assignment and returns 404; use getStackMemberPermissions for what they can do. Requires stack-level settings management permission.","operationId":"getStackMember","parameters":[{"in":"path","name":"stackId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a stack, a valid value would be : stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stack_[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}$","type":"string"}},{"in":"path","name":"memberId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^wsu_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackMember"}}},"description":"Stack member retrieved.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve an explicit stack member","tags":["Stack Members"]},"patch":{"description":"Changes an existing member's stack role or individual language permissions (JSON merge-patch): listed languages are set, a language set to `null` is removed, all others stay. Use setStackMember to replace everything at once. Owners can't be changed here (409), and a personal API key can't change its own member. Requires stack-level settings management permission.","operationId":"updateStackMember","parameters":[{"in":"path","name":"stackId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a stack, a valid value would be : stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stack_[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}$","type":"string"}},{"in":"path","name":"memberId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^wsu_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateStackMember"}},"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateStackMember"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackMember"}}},"description":"Current stack assignment.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Owner membership changes are protected (`owner_membership_protected`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Update an explicit stack member","tags":["Stack Members"]},"put":{"description":"Adds a workspace member to the stack, or replaces their stack role and language permissions. Send the complete language map; `{}` removes all explicit language permissions. Returns 201 when the member was added, 200 when updated or unchanged. Owners can't be set or changed here (409), and a personal API key can't change its own member. Requires stack-level settings management permission.","operationId":"setStackMember","parameters":[{"in":"path","name":"stackId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a stack, a valid value would be : stack_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^stack_[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}$","type":"string"}},{"in":"path","name":"memberId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^wsu_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetStackMember"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackMember"}}},"description":"Assignment replaced or already identical.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackMember"}}},"description":"Explicit assignment created.","headers":{"Location":{"description":"URL of the stack member.","schema":{"format":"uri-reference","type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Owner membership changes are protected (`owner_membership_protected`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Set an explicit stack member","tags":["Stack Members"]}},"/v2/style-guides":{"get":{"description":"Lists the workspace's style guides, oldest first, with their general rules. A LINA uses a style guide for translation and for the style checks. Rules for single languages and language variants are set per language. Requires workspace-level style guides view permission.","operationId":"listStyleGuides","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StyleGuideFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `StyleGuideFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `style_guide[created_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `style_guide[id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `style_guide[name]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | yes |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StyleGuideCollection"}}},"description":"The style guides.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List style guides","tags":["Style Guides"]},"post":{"description":"Creates a style guide with its general rules; rules left out are `NOT_SPECIFIED`. Names don't have to be unique. Set rules for single languages and language variants afterwards per language. To use it for translation, set it as a LINA's `style_guide_id`. Requires workspace-level style guides management permission.","operationId":"createStyleGuide","parameters":[{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateStyleGuide"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StyleGuide"}}},"description":"The style guide was created.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the new style guide.","schema":{"format":"uri-reference","type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Create a style guide","tags":["Style Guides"]}},"/v2/style-guides/{styleGuideId}":{"delete":{"description":"Deletes a style guide with its rules for single languages and its language variants. LINAs that used it continue without a style guide: translations no longer follow it, and the style checks no longer use its rules. This can't be undone. Send the ETag from getStyleGuide as If-Match to make sure nobody changed it in between. Requires workspace-level style guides management permission.","operationId":"deleteStyleGuide","parameters":[{"description":"Unique identifier of the style guide.","example":"sg_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"styleGuideId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a style guide, a valid value would be : sg_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^sg_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"The style guide was deleted.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Delete a style guide","tags":["Style Guides"]},"get":{"description":"Returns one style guide, the same object as in listStyleGuides. `rule_language_codes` and `language_variants` show which languages have their own rules or a variant; read those per language. Requires workspace-level style guides view permission.","operationId":"getStyleGuide","parameters":[{"description":"Unique identifier of the style guide.","example":"sg_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"styleGuideId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a style guide, a valid value would be : sg_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^sg_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StyleGuide"}}},"description":"The style guide.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve a style guide","tags":["Style Guides"]},"patch":{"description":"Changes a style guide with JSON merge-patch: leaving out a field keeps it, and `null` clears `ai_context` or `audience_description`. In `rules`, a rule left out keeps its value and `null` resets it to `NOT_SPECIFIED`. Rules for single languages and language variants have their own endpoints. Sending only the current values changes nothing. Send the ETag from getStyleGuide as If-Match to make sure nobody changed it in between. Requires workspace-level style guides management permission.","operationId":"updateStyleGuide","parameters":[{"description":"Unique identifier of the style guide.","example":"sg_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"styleGuideId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a style guide, a valid value would be : sg_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^sg_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateStyleGuide"}},"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateStyleGuide"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StyleGuide"}}},"description":"The style guide.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Update a style guide","tags":["Style Guides"]}},"/v2/style-guides/{styleGuideId}/language-variants/{languageCode}":{"delete":{"description":"Removes the regional variant for a language; texts translated into it no longer follow a regional variant. Answers 204 also when none was set. Send the ETag from getStyleGuideLanguageVariant as If-Match to make sure nobody changed it in between. Requires workspace-level style guides management permission.","operationId":"deleteStyleGuideLanguageVariant","parameters":[{"description":"Unique identifier of the style guide.","example":"sg_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"styleGuideId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a style guide, a valid value would be : sg_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^sg_[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}$","type":"string"}},{"description":"General language code the variant is configured for.","example":"en","in":"path","name":"languageCode","required":true,"schema":{"description":"Language code that uniquely identifies a locale. Valid examples would be 'en', 'en-GB', 'de', 'de-DE' etc. according to [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"The language variant was removed, or none was set.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Delete a style guide language variant","tags":["Style Guide Language Variants"]},"get":{"description":"Returns the regional variant the style guide sets for a language: when a text is translated into the general language (e.g. `de`), LINA writes this variant (e.g. `de-AT`) and machine translation engines are asked for it. Answers 404 when the style guide sets none for that language. Requires workspace-level style guides view permission.","operationId":"getStyleGuideLanguageVariant","parameters":[{"description":"Unique identifier of the style guide.","example":"sg_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"styleGuideId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a style guide, a valid value would be : sg_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^sg_[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}$","type":"string"}},{"description":"General language code the variant is configured for.","example":"en","in":"path","name":"languageCode","required":true,"schema":{"description":"Language code that uniquely identifies a locale. Valid examples would be 'en', 'en-GB', 'de', 'de-DE' etc. according to [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StyleGuideLanguageVariant"}}},"description":"The language variant.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve a style guide language variant","tags":["Style Guide Language Variants"]},"put":{"description":"Sets the regional variant for a language, e.g. `en` → `en-GB`, creating or replacing it; the variant must be a supported regional locale of that language. Texts translated into the general language are then written in this variant, by LINA and by machine translation engines. Send the ETag from getStyleGuideLanguageVariant as If-Match to make sure nobody changed it; `If-Match: *` only replaces an existing variant. Requires workspace-level style guides management permission.","operationId":"setStyleGuideLanguageVariant","parameters":[{"description":"Unique identifier of the style guide.","example":"sg_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"styleGuideId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a style guide, a valid value would be : sg_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^sg_[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}$","type":"string"}},{"description":"General language code the variant is configured for.","example":"en","in":"path","name":"languageCode","required":true,"schema":{"description":"Language code that uniquely identifies a locale. Valid examples would be 'en', 'en-GB', 'de', 'de-DE' etc. according to [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetStyleGuideLanguageVariant"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StyleGuideLanguageVariant"}}},"description":"The language variant.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`variant_language_code` isn't a supported locale (`enum`) or isn't a regional variant of the language (`pattern`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Set a style guide language variant","tags":["Style Guide Language Variants"]}},"/v2/style-guides/{styleGuideId}/rules/{languageCode}":{"delete":{"description":"Removes the style guide's rules for one language; the language then follows only the general rules. Answers 204 also when it had none. Send the ETag from getStyleGuideLanguageRules as If-Match to make sure nobody changed them in between. Requires workspace-level style guides management permission.","operationId":"deleteStyleGuideLanguageRules","parameters":[{"description":"Unique identifier of the style guide.","example":"sg_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"styleGuideId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a style guide, a valid value would be : sg_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^sg_[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}$","type":"string"}},{"description":"Language code that uniquely identifies a locale","example":"en-US","in":"path","name":"languageCode","required":true,"schema":{"description":"Language code that uniquely identifies a locale. Valid examples would be 'en', 'en-GB', 'de', 'de-DE' etc. according to [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"The language rules were removed, or there were none.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Delete style guide language rules","tags":["Style Guide Language Rules"]},"get":{"description":"Returns the style guide's rules for one language: date and time formats, number separators, quotes, Oxford comma, gender-inclusive language, honorifics for Japanese and Korean, and overrides of formality, voice and language complexity. A field that is null isn't set for this language; for formality, voice and complexity the style guide's general rule then applies. Rules apply to exactly this language code: rules for `de` don't apply to `de-AT`. Requires workspace-level style guides view permission.","operationId":"getStyleGuideLanguageRules","parameters":[{"description":"Unique identifier of the style guide.","example":"sg_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"styleGuideId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a style guide, a valid value would be : sg_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^sg_[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}$","type":"string"}},{"description":"Language code that uniquely identifies a locale","example":"en-US","in":"path","name":"languageCode","required":true,"schema":{"description":"Language code that uniquely identifies a locale. Valid examples would be 'en', 'en-GB', 'de', 'de-DE' etc. according to [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StyleGuideLanguageRules"}}},"description":"The language rules.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve style guide language rules","tags":["Style Guide Language Rules"]},"put":{"description":"Sets the style guide's rules for one language, replacing all it had: a field left out or null is not set, and for formality, voice and complexity the general rule then applies. The language must be a supported locale; rules apply to exactly this code. Honorific levels only apply to Japanese and Korean. Send the ETag from getStyleGuideLanguageRules as If-Match to make sure nobody changed them; `If-Match: *` only replaces existing rules. Requires workspace-level style guides management permission.","operationId":"setStyleGuideLanguageRules","parameters":[{"description":"Unique identifier of the style guide.","example":"sg_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"styleGuideId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a style guide, a valid value would be : sg_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^sg_[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}$","type":"string"}},{"description":"Language code that uniquely identifies a locale","example":"en-US","in":"path","name":"languageCode","required":true,"schema":{"description":"Language code that uniquely identifies a locale. Valid examples would be 'en', 'en-GB', 'de', 'de-DE' etc. according to [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetStyleGuideLanguageRules"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StyleGuideLanguageRules"}}},"description":"The language rules.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The language isn't a supported locale (`enum` on `languageCode`), or an honorific level is set for a language other than Japanese or Korean (`not_supported`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Set style guide language rules","tags":["Style Guide Language Rules"]}},"/v2/term-forms/{termFormId}":{"delete":{"description":"Deletes a term form; languages that inherit it lose it too. A term keeps at least one form: deleting the last one answers 409, so delete the term instead. This can't be undone. Send the ETag from getTermForm as If-Match to make sure nobody changed it in between. Requires workspace-level glossaries management permission.","operationId":"deleteTermForm","parameters":[{"description":"Unique identifier of the term form.","example":"ter_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"termFormId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a term language, a valid value would be : ter_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^ter_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"The term form was deleted.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`conflict`: the form is the term's last form; delete the term instead.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Delete a term form","tags":["Terms"]},"get":{"description":"Returns one term form, the same object as in its term's `forms`. Requires workspace-level glossaries view permission.","operationId":"getTermForm","parameters":[{"description":"Unique identifier of the term form.","example":"ter_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"termFormId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a term language, a valid value would be : ter_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^ter_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TermForm"}}},"description":"The term form.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve a term form","tags":["Terms"]},"patch":{"description":"Changes a term form with JSON merge-patch: leaving out a field keeps it, and `null` clears a grammar field or the match expression. The language can't change; add a form in the other language and delete this one. `inherited_by` replaces the list of inheriting languages; a language taken off the list keeps its own copy of the form. A form that other languages inherit must stay preferred. Sending only the current values changes nothing. Send the ETag from getTermForm as If-Match to make sure nobody changed it in between. Requires workspace-level glossaries management permission.","operationId":"updateTermForm","parameters":[{"description":"Unique identifier of the term form.","example":"ter_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"termFormId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a term language, a valid value would be : ter_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^ter_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTermForm"}},"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateTermForm"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TermForm"}}},"description":"The term form.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`already_exists`: the language already has a preferred form (`#/usage_status`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"An inheriting language isn't a supported locale (`enum`) or not a language of the glossary (`not_found`); `AUTOMATIC` matching for a language without it, or a form that others inherit stops being preferred (`not_supported`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Update a term form","tags":["Terms"]}},"/v2/terms/{termId}":{"delete":{"description":"Deletes a term with all its forms; LINA and the terminology check no longer use it. This can't be undone. Send the ETag from getTerm as If-Match to make sure nobody changed the term in between. Requires workspace-level glossaries management permission.","operationId":"deleteTerm","parameters":[{"description":"Unique identifier of the term.","example":"te_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"termId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a term, a valid value would be : te_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^te_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"The term was deleted.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Delete a term","tags":["Terms"]},"get":{"description":"Returns one term with its forms, the same object as in listTerms. Requires workspace-level glossaries view permission.","operationId":"getTerm","parameters":[{"description":"Unique identifier of the term.","example":"te_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"termId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a term, a valid value would be : te_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^te_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Term"}}},"description":"The term.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve a term","tags":["Terms"]},"patch":{"description":"Changes a term's enforcement status and AI context with JSON merge-patch: leaving out a field keeps it, and `ai_context: null` clears it. The term's type can't be changed, and its forms have their own endpoints. Sending only the current values changes nothing. Send the ETag from getTerm as If-Match to make sure nobody changed the term in between. Requires workspace-level glossaries management permission.","operationId":"updateTerm","parameters":[{"description":"Unique identifier of the term.","example":"te_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"termId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a term, a valid value would be : te_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^te_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTerm"}},"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateTerm"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Term"}}},"description":"The term.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Update a term","tags":["Terms"]}},"/v2/terms/{termId}/forms":{"post":{"description":"Adds a form to the term: its text in another language, or an alternative in a language it already has. A language has at most one preferred form (a second one answers 409), and a language that inherits another language's form can't have its own. Left-out settings get the same defaults as in the app. Requires workspace-level glossaries management permission.","operationId":"createTermForm","parameters":[{"description":"Unique identifier of the term.","example":"te_0197c8f2-5a6b-7cde-8f12-3456789abcde","in":"path","name":"termId","required":true,"schema":{"description":"Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a term, a valid value would be : te_0197c8f2-5a6b-7cde-8f12-3456789abcde","pattern":"^te_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTermForm"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TermForm"}}},"description":"The form was added.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the new term form.","schema":{"format":"uri-reference","type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"`already_exists`: the language already has a preferred form (`#/usage_status`). An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The language or an inheriting language isn't a supported locale (`enum`) or not a language of the glossary (`not_found`); `AUTOMATIC` matching for a language without it, or the language inherits another form (`not_supported`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Add a term form","tags":["Terms"]}},"/v2/webhook-deliveries/{webhookDeliveryId}":{"get":{"description":"Returns one delivery: its status, attempts, next retry and the last response, plus the request that is sent (rebuilt from the event and the endpoint's current URL; the signature headers are not shown). Requires workspace-level API access view permission.","operationId":"getWebhookDelivery","parameters":[{"in":"path","name":"webhookDeliveryId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^whd_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDelivery"}}},"description":"The webhook delivery.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve a webhook delivery","tags":["Webhooks"]}},"/v2/webhook-deliveries/{webhookDeliveryId}/redeliver":{"post":{"description":"Sends a failed delivery again, in the background; poll it at the URL in `Location`. A delivery that used all its attempts gets one more; one that stopped early continues its retries. Attempt count and last error are kept. It goes out with the same `webhook-id` and the endpoint's current URL and secret. The endpoint must be enabled. Send the ETag from GET as If-Match to make sure nobody changed the delivery in between. Requires workspace-level API access management permission.","operationId":"redeliverWebhookDelivery","parameters":[{"in":"path","name":"webhookDeliveryId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^whd_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"202":{"content":{"application/json":{"examples":{"requeued":{"description":"requeued","summary":"A delivery that used all its attempts, queued for one more","value":{"data":{"attempt_count":8,"created_at":"2026-09-29T10:00:00.123Z","delivered_at":null,"event_id":"evt_0197c8f2-5a6b-7cde-8f12-3456789abcde","event_type":"project.created","id":"whd_0197c8f2-5a6b-7cde-8f12-3456789abcde","is_exhausted":false,"last_duration_ms":120,"last_error":"non-2xx response: 503","last_response_body":"Temporarily unavailable","last_response_status":503,"max_attempts":8,"next_attempt_at":"2026-09-30T12:00:00.123Z","object_type":"WEBHOOK_DELIVERY","request":{"body":"{\"id\":\"evt_0197c8f2-5a6b-7cde-8f12-3456789abcde\",\"type\":\"project.created\",\"api_version\":\"2026-07-01\",\"created_at\":\"2026-09-29T10:00:00.123+00:00\",\"workspace_id\":\"space_0197c8f2-5a6b-7cde-8f12-3456789abcde\",\"data\":{\"id\":\"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde\",\"title\":\"Website\"}}","headers":{"content-type":"application/json","user-agent":"LingoHub-Webhooks/1","webhook-id":"evt_0197c8f2-5a6b-7cde-8f12-3456789abcde"},"url":"https://example.com/lingohub/webhooks"},"status":"QUEUED","updated_at":"2026-09-30T12:00:00.123Z","webhook_endpoint_id":"whe_0197c8f2-5a6b-7cde-8f12-3456789abcde"},"job_type":"WEBHOOK_DELIVERY","object_type":"JOB"}}},"schema":{"$ref":"#/components/schemas/WebhookDeliveryJob"}}},"description":"The delivery is queued again; poll it at the URL in `Location`.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the queued delivery.","schema":{"example":"/v2/webhook-deliveries/whd_0197c8f2-5a6b-7cde-8f12-3456789abcde","format":"uri-reference","type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The delivery hasn't failed, or its endpoint isn't enabled (`conflict`). An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The Idempotency-Key belongs to a different request (`idempotency_key_mismatch`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Redeliver a webhook delivery","tags":["Webhooks"]}},"/v2/webhook-endpoints":{"get":{"description":"Lists the workspace's webhook endpoints, newest first. An endpoint receives the subscribed events of one stack, one project, or the whole workspace; LingoHub switches it off (`AUTO_DISABLED`) after 15 failed deliveries in a row. The signing secret is never listed. Requires workspace-level API access view permission.","operationId":"listWebhookEndpoints","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEndpointFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `WebhookEndpointFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `webhook_endpoint[created_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `webhook_endpoint[description]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | – |\n| `webhook_endpoint[id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `webhook_endpoint[project_id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `webhook_endpoint[stack_id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `webhook_endpoint[status]` | ENABLED \\| DISABLED \\| AUTO_DISABLED | `_eq` `_ne` `_in` `_nin` | – |\n| `webhook_endpoint[updated_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `webhook_endpoint[url]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | yes |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEndpointCollection"}}},"description":"The workspace's webhook endpoints.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List webhook endpoints","tags":["Webhooks"]},"post":{"description":"Creates an enabled webhook endpoint and returns it with its signing secret. The secret is shown only in this response; if the response gets lost, rotate the secret. The URL must be a public HTTPS address: private, loopback and link-local addresses are rejected, and the address is checked again at every delivery. Send `stack_id` to receive the events of one stack, `project_id` for one project, or neither for the whole workspace. Requires workspace-level API access management permission.","operationId":"createWebhookEndpoint","parameters":[{"description":"Optional unique key for best-effort duplicate suppression of this one-time response. The original successful response is returned to the caller but never retained in API log bodies or idempotent replays. Only an unresolved reservation is retained for 24 hours by default; a matching retry returns 409 `idempotency_outcome_unknown` without repeating the operation or revealing its secret. A concurrent request returns 409 `idempotency_key_in_use`; a changed request returns 422 `idempotency_key_mismatch`. An unavailable reservation store returns 503 before execution. A 4xx rejection releases its reservation; interruption after execution or loss of the success response requires inspection and a deliberate new operation. Expiry of the retained reservation or server-side disabling removes protection; this is not durable exactly-once execution. Use the target GET to inspect current metadata and obtain its validator, then a new key only when intentionally rotating again.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"project":{"description":"project","summary":"Receive the events of one project","value":{"description":"Localization notifications","event_types":["import.completed","export.completed"],"project_id":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","url":"https://example.com/lingohub/webhooks"}}},"schema":{"$ref":"#/components/schemas/CreateWebhookEndpoint"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEndpointWithSecret"}}},"description":"The created endpoint with its signing secret.","headers":{"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"Location":{"description":"URL of the created webhook endpoint.","schema":{"example":"/v2/webhook-endpoints/whe_0197c8f2-5a6b-7cde-8f12-3456789abcde","format":"uri-reference","type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"413":{"$ref":"#/components/responses/ContentTooLarge"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Create a webhook endpoint","tags":["Webhooks"]}},"/v2/webhook-endpoints/{webhookEndpointId}":{"delete":{"description":"Deletes the endpoint and its delivery history. This can't be undone. Nothing more is sent to it, though a request already on its way may still arrive. Other endpoints that subscribe to `webhook_endpoint.deleted` are notified. Send the ETag from GET as If-Match to make sure nobody changed the endpoint in between. Requires workspace-level API access management permission.","operationId":"deleteWebhookEndpoint","parameters":[{"in":"path","name":"webhookEndpointId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^whe_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"The endpoint was deleted.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Delete a webhook endpoint","tags":["Webhooks"]},"get":{"description":"Returns one webhook endpoint: its URL, subscribed events, scope, status and delivery health. The signing secret is never returned; rotate it to get a new one. An endpoint scoped to a project or stack is deleted together with that project or stack. Requires workspace-level API access view permission.","operationId":"getWebhookEndpoint","parameters":[{"in":"path","name":"webhookEndpointId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^whe_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEndpoint"}}},"description":"The webhook endpoint.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve a webhook endpoint","tags":["Webhooks"]},"patch":{"description":"Changes an endpoint's URL, description, events or scope (JSON merge-patch). Omitted fields stay; `null` clears description or scope; `event_types` replaces the whole list. To move an endpoint from a stack to a project or back, send the new id and `null` for the old one in the same request. A new URL is checked as on create. Status, delivery health, payload version and signing secret don't change: an `AUTO_DISABLED` endpoint stays off until you enable it. Requires workspace-level API access management permission.","operationId":"updateWebhookEndpoint","parameters":[{"in":"path","name":"webhookEndpointId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^whe_[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}$","type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"move":{"description":"move","summary":"Move the endpoint from its stack to a project","value":{"project_id":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","stack_id":null}}},"schema":{"$ref":"#/components/schemas/UpdateWebhookEndpoint"}},"application/merge-patch+json":{"examples":{"move":{"description":"move","summary":"Move the endpoint from its stack to a project","value":{"project_id":"pr_0197c8f2-5a6b-7cde-8f12-3456789abcde","stack_id":null}}},"schema":{"$ref":"#/components/schemas/UpdateWebhookEndpoint"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEndpoint"}}},"description":"The changed webhook endpoint.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"$ref":"#/components/responses/UnprocessableContent"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Update a webhook endpoint","tags":["Webhooks"]}},"/v2/webhook-endpoints/{webhookEndpointId}/deliveries":{"get":{"description":"Lists an endpoint's deliveries, newest first. Every event the endpoint subscribes to gets one delivery, retried up to 8 times over about a day until it succeeds. Deliveries are kept as long as the workspace's plan keeps API logs. Requires workspace-level API access view permission.","operationId":"listWebhookDeliveries","parameters":[{"in":"path","name":"webhookEndpointId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^whe_[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}$","type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDeliveryFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `WebhookDeliveryFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `webhook_delivery[attempt_count]` | integer | `_eq` `_ne` `_in` `_nin` `_gt` `_lt` `_gte` `_lte` `_within` `_null` `_nnull` | yes |\n| `webhook_delivery[created_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `webhook_delivery[event_id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `webhook_delivery[id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `webhook_delivery[status]` | QUEUED \\| PROCESSING \\| SUCCEEDED \\| FAILED | `_eq` `_ne` `_in` `_nin` | – |\n| `webhook_delivery[updated_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDeliveryCollection"}}},"description":"The endpoint's deliveries.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List webhook deliveries","tags":["Webhooks"]}},"/v2/webhook-endpoints/{webhookEndpointId}/disable":{"post":{"description":"Stops deliveries to the endpoint until it is enabled again. Events that happen while it is off are not sent, and deliveries still waiting for a retry fail; a request already on its way may still arrive. An auto-disabled endpoint becomes disabled and keeps its `disabled_at`. Does nothing if the endpoint is already disabled. Send the ETag from GET as If-Match to make sure nobody changed the endpoint in between. Requires workspace-level API access management permission.","operationId":"disableWebhookEndpoint","parameters":[{"in":"path","name":"webhookEndpointId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^whe_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEndpoint"}}},"description":"The disabled endpoint.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The Idempotency-Key belongs to a different request (`idempotency_key_mismatch`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Disable a webhook endpoint","tags":["Webhooks"]}},"/v2/webhook-endpoints/{webhookEndpointId}/enable":{"post":{"description":"Turns a disabled or auto-disabled endpoint back on and resets its failure count. Events that happened while it was off are not sent; resend failed deliveries with redeliver. Does nothing if the endpoint is already enabled. Send the ETag from GET as If-Match to make sure nobody changed the endpoint in between. Requires workspace-level API access management permission.","operationId":"enableWebhookEndpoint","parameters":[{"in":"path","name":"webhookEndpointId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^whe_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEndpoint"}}},"description":"The enabled endpoint.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The Idempotency-Key belongs to a different request (`idempotency_key_mismatch`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Enable a webhook endpoint","tags":["Webhooks"]}},"/v2/webhook-endpoints/{webhookEndpointId}/rotate-secret":{"post":{"description":"Replaces the endpoint's signing secret and returns the new one. It is shown only in this response. The old secret stops working at once: everything sent from now on, including retries of earlier events, is signed with the new one, so update your receiver right away. If the response gets lost, rotate again. Send the ETag from GET as If-Match to make sure nobody changed the endpoint in between. Requires workspace-level API access management permission.","operationId":"rotateWebhookEndpointSecret","parameters":[{"in":"path","name":"webhookEndpointId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^whe_[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}$","type":"string"}},{"description":"Optional unique key for best-effort duplicate suppression of this one-time response. The original successful response is returned to the caller but never retained in API log bodies or idempotent replays. Only an unresolved reservation is retained for 24 hours by default; a matching retry returns 409 `idempotency_outcome_unknown` without repeating the operation or revealing its secret. A concurrent request returns 409 `idempotency_key_in_use`; a changed request returns 422 `idempotency_key_mismatch`. An unavailable reservation store returns 503 before execution. A 4xx rejection releases its reservation; interruption after execution or loss of the success response requires inspection and a deliberate new operation. Expiry of the retained reservation or server-side disabling removes protection; this is not durable exactly-once execution. Use the target GET to inspect current metadata and obtain its validator, then a new key only when intentionally rotating again.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Optional precondition. Send the quoted ETag from a GET of this resource. The mutation only runs if a strong tag matches the current representation, checked under the write lock. A comma-separated list is allowed; '*' requires an existing representation. Weak tags never match. Omit this header for an unconditional write. For an action, use the ETag from GET of the target resource, without the action suffix. A stale tag returns 412; read the current state before retrying.","in":"header","name":"If-Match","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEndpointWithSecret"}}},"description":"The endpoint with its new signing secret.","headers":{"Cache-Control":{"$ref":"#/components/headers/Cache-Control"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"412":{"$ref":"#/components/responses/PreconditionFailed"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The Idempotency-Key belongs to a different request (`idempotency_key_mismatch`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Rotate a webhook signing secret","tags":["Webhooks"]}},"/v2/webhook-endpoints/{webhookEndpointId}/test":{"post":{"description":"Sends a signed `ping` event to this endpoint only, in the background; poll the delivery at the URL in `Location`. The endpoint must be enabled. The ping is an ordinary delivery: it appears in the endpoint's delivery list, is retried like any other, and its failed attempts count toward the 15 in a row that switch the endpoint off. Endpoints can't subscribe to `ping`. Requires workspace-level API access management permission.","operationId":"testWebhookEndpoint","parameters":[{"in":"path","name":"webhookEndpointId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^whe_[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}$","type":"string"}},{"description":"Optional unique key for best-effort POST retry protection. The key is reserved, the request runs with ordinary service transactions, then the successful response is retained 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`. Loss or expiry of the retained response 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.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"responses":{"202":{"content":{"application/json":{"examples":{"ping":{"description":"ping","summary":"A queued ping","value":{"data":{"attempt_count":0,"created_at":"2026-09-29T10:00:00.123Z","delivered_at":null,"event_id":"evt_0197c8f2-5a6b-7cde-8f12-3456789abcde","event_type":"ping","id":"whd_0197c8f2-5a6b-7cde-8f12-3456789abcde","is_exhausted":false,"last_duration_ms":null,"last_error":null,"last_response_body":null,"last_response_status":null,"max_attempts":8,"next_attempt_at":"2026-09-29T10:00:00.123Z","object_type":"WEBHOOK_DELIVERY","request":{"body":"{\"id\":\"evt_0197c8f2-5a6b-7cde-8f12-3456789abcde\",\"type\":\"ping\",\"api_version\":\"2026-07-01\",\"created_at\":\"2026-09-29T10:00:00.123+00:00\",\"workspace_id\":\"space_0197c8f2-5a6b-7cde-8f12-3456789abcde\",\"data\":{\"webhook_endpoint_id\":\"whe_0197c8f2-5a6b-7cde-8f12-3456789abcde\"}}","headers":{"content-type":"application/json","user-agent":"LingoHub-Webhooks/1","webhook-id":"evt_0197c8f2-5a6b-7cde-8f12-3456789abcde"},"url":"https://example.com/lingohub/webhooks"},"status":"QUEUED","updated_at":"2026-09-29T10:00:00.123Z","webhook_endpoint_id":"whe_0197c8f2-5a6b-7cde-8f12-3456789abcde"},"job_type":"WEBHOOK_DELIVERY","object_type":"JOB"}}},"schema":{"$ref":"#/components/schemas/WebhookDeliveryJob"}}},"description":"The ping is queued; poll the delivery at the URL in `Location`.","headers":{"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"},"Location":{"description":"URL of the queued delivery.","schema":{"example":"/v2/webhook-deliveries/whd_0197c8f2-5a6b-7cde-8f12-3456789abcde","format":"uri-reference","type":"string"},"style":"simple"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The endpoint is not enabled (`conflict`); enable it first. An unresolved request returns `idempotency_outcome_unknown` without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (`idempotency_key_in_use`); retry after the number of seconds in the `Retry-After` header.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"Retry-After":{"description":"Seconds to wait for an in-progress keyed request; absent for other conflicts.","schema":{"format":"int32","type":"integer"}}}},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The Idempotency-Key belongs to a different request (`idempotency_key_mismatch`).","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Test a webhook endpoint","tags":["Webhooks"]}},"/v2/webhook-event-types":{"get":{"description":"Lists the events a webhook endpoint can subscribe to, with a label and a category each. Every listed event is actually sent. Besides these, an endpoint can subscribe to `*` for all events; the `ping` sent by the test endpoint isn't a subscription. Requires workspace-level API access view permission.","operationId":"listWebhookEventTypes","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEventTypeFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `WebhookEventTypeFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `webhook_event_type[category]` | PROJECTS_AND_BRANCHES \\| LANGUAGES \\| RESOURCES \\| IMPORTS_AND_EXPORTS \\| KEYS \\| TEXTS \\| AUTOMATION_AND_AI \\| QUALITY \\| TRANSLATION_ORDERS \\| MEMBERS_AND_STACKS \\| TMS_ASSETS \\| PROJECT_CONFIG \\| PLATFORM | `_eq` `_ne` `_in` `_nin` | – |\n| `webhook_event_type[event_type]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | yes |\n| `webhook_event_type[name]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | yes |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEventTypeCollection"}}},"description":"The events an endpoint can subscribe to.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List webhook subscription event types","tags":["Webhooks"]}},"/v2/workspace":{"get":{"description":"Returns the workspace that this API key belongs to. Each API key is scoped to exactly one workspace, so no workspace ID parameter is required.","operationId":"getWorkspace","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace"}}},"description":"Workspace retrieved successfully.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve the workspace","tags":["Workspaces"]}},"/v2/workspace-roles":{"get":{"description":"Lists the workspace's built-in and custom roles. Use a role's id for invitations and member updates. The owner role is listed but can't be assigned through the API. Requires workspace-level members view permission.","operationId":"listWorkspaceRoles","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceRoleFilter"}}},"description":"Filters and sorts the list: URL-encoded JSON of the schema `WorkspaceRoleFilter`. `where` holds exactly one `_and` or `_or` with an array of clauses; a clause is another `_and`/`_or` or a field with exactly one operator. `sort` lists fields with `+` (ascending) or `-` (descending). An unsupported field, operator or value answers `400 invalid_filter` with a pointer into the filter.\n\n| Field | Type | Operators | Sort |\n|---|---|---|---|\n| `workspace_role[created_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n| `workspace_role[description]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | – |\n| `workspace_role[id]` | id | `_eq` `_ne` `_in` `_nin` | – |\n| `workspace_role[name]` | text | `_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank` | yes |\n| `workspace_role[type]` | OWNER \\| ADMIN \\| LOCALIZATION_MANAGER \\| MEMBER \\| CUSTOM | `_eq` `_ne` `_in` `_nin` | – |\n| `workspace_role[updated_at]` | timestamp | `_eq` `_lt` `_gt` `_lte` `_gte` `_within` `_null` `_nnull` | yes |\n","in":"query","name":"filter","required":false},{"description":"Opaque pagination cursor from the `next_cursor` field of a previous response. Omit for the first page.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Maximum number of items to return per page (1-100).","example":20,"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceRoleCollection"}}},"description":"Workspace roles retrieved.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"List workspace roles","tags":["Workspace Roles"]}},"/v2/workspace-roles/{workspaceRoleId}":{"get":{"description":"Returns one role of the workspace. The owner role can be read but not assigned through the API. Requires workspace-level members view permission.","operationId":"getWorkspaceRole","parameters":[{"in":"path","name":"workspaceRoleId","required":true,"schema":{"description":"Public id composed of the resource type prefix and its UUID.","pattern":"^rol_[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}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceRole"}}},"description":"Workspace role retrieved.","headers":{"ETag":{"$ref":"#/components/headers/ETag"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}},"security":[{"bearerAuth":[]}],"summary":"Retrieve a workspace role","tags":["Workspace Roles"]}}},"servers":[{"url":"/","description":"Use this backend origin or explicitly select your environment"}],"tags":[{"description":"Read the workspace your API key belongs to. A workspace holds your stacks, projects and members.","name":"Workspaces"},{"description":"List, update and remove the members of the workspace.","name":"Members"},{"description":"Invite people to the workspace by email, and manage pending invitations and the stacks they will join.","name":"Invitations"},{"description":"Read the roles a workspace member can have.","name":"Workspace Roles"},{"description":"Check the API key a request is made with, and read and rename the workspace's API keys.","name":"API Keys"},{"description":"Read the file formats a project uses and the largest file it imports.","name":"Capabilities"},{"description":"List every locale LingoHub supports, to find the language codes you can add to a project or stack.","name":"Locales"},{"description":"Manage stacks. A stack holds the languages, members and texts its projects share: a `PUBLIC` stack can serve several projects, a `PRIVATE` stack belongs to one project.","name":"Stacks"},{"description":"Manage who has explicit access to a stack, with which role and language permissions.","name":"Stack Members"},{"description":"Read the permissions a member effectively has in a stack.","name":"Stack Member Permissions"},{"description":"Read the roles a stack member can have.","name":"Stack Roles"},{"description":"Manage the target languages configured for a stack. The stack's languages are shared by every project assigned to that stack.","name":"Stack Languages"},{"description":"Manage the localization projects of the workspace. A project holds resource files, languages and texts.","name":"Projects"},{"description":"Read and change a project's settings: export and import defaults, file-format options, key normalisation, placeholder recognition and integration settings.","name":"Project Settings"},{"description":"Manage the target languages configured for a project. Project languages are scoped to a branch.","name":"Project Languages"},{"description":"Move a project to another stack, or detach it into a stack of its own, as an async job.","name":"Project Moves"},{"description":"Manage branches within a project. Branches isolate translation work; each project has exactly one default branch that cannot be deleted.","name":"Branches"},{"description":"List and manage the resource files of a project branch, with their format, path and translation status per language.","name":"Resources"},{"description":"List and manage the keys of a file. A key is where a segment appears in a file; the segment holds its texts.","name":"Keys"},{"description":"Read and change segments: a source text and its translations, which every key of the segment shows.","name":"Segments"},{"description":"Manage the labels of the workspace. Labels tag segments, so you can categorize and filter content.","name":"Labels"},{"description":"Upload screenshots that show translators and LINAs where a text appears. An image belongs to one project language and can be attached to segments of that project.","name":"Context Images"},{"description":"Import files into a branch in the background, and see what each import changed.","name":"Imports"},{"description":"Export the files of a branch in the background and download them.","name":"Exports"},{"description":"Manage the workspace's glossaries: the terms LINA uses for translation and the terminology check.","name":"Glossaries"},{"description":"Manage the terms of a glossary. Per language, a term has one preferred form and any number of alternatives; a language without forms of its own can inherit another language's preferred form. Untranslatable terms have forms without a language.","name":"Terms"},{"description":"Manage style guides: the tone, audience and language rules that guide AI translation.","name":"Style Guides"},{"description":"Override a style guide's rules for a single language.","name":"Style Guide Language Rules"},{"description":"Map a language to its regional variant within a style guide, for example `en` to `en-US`. A language can have a variant without rules, and rules without a variant.","name":"Style Guide Language Variants"},{"description":"Manage LINAs, LingoHub's AI translation agents, and translate texts with them.","name":"LINAs"},{"description":"Pre-translate texts of a branch with the stack's LINA in the background, and follow the runs.","name":"LINA Executions"},{"description":"Read the translation engines a LINA can use.","name":"Linguistic Engines"},{"description":"Read a project's distributions, which deliver its translations over the CDN.","name":"Distributions"},{"description":"Read the releases of a distribution and download their archives.","name":"Distribution Releases"},{"description":"Back up branches of a project, list the backups and delete them.","name":"Backups"},{"description":"Schedule automatic backups of a project's branches.","name":"Backup Settings"},{"description":"Restore languages of a backup into a branch in the background, and follow the restore.","name":"Backup Restores"},{"description":"Receive LingoHub events at your own endpoint: manage endpoints and signing secrets, and inspect or redeliver deliveries.","name":"Webhooks"},{"description":"Connect a project to a Git repository and sync files with it as async jobs.","name":"Git Integrations"},{"description":"Install the GitHub app, and list repositories, branches and folders for a Git integration.","name":"GitHub Integrations"},{"description":"List GitLab repositories, branches and folders for a Git integration.","name":"GitLab Integrations"},{"description":"List Bitbucket workspaces, repositories, branches and folders for a Git integration.","name":"Bitbucket Integrations"},{"description":"List Azure DevOps organizations, projects, repositories, branches and folders for a Git integration.","name":"Azure Integrations"},{"description":"List AWS CodeCommit repositories, branches and folders for a Git integration.","name":"CodeCommit Integrations"},{"description":"Manage the stored credentials LingoHub uses to connect to Git providers and content platforms.","name":"Integration Authentications"},{"description":"Connect a project to Contentful, choose what it translates, and sync, push or pull its content.","name":"Contentful Integrations"},{"description":"Connect a project to Storyblok, choose what it translates, and sync, push or pull its content.","name":"Storyblok Integrations"},{"description":"Connect a project to HubSpot, choose what it translates, and sync, push or pull its content.","name":"HubSpot Integrations"},{"description":"Connect a project to Zendesk, choose what it translates, and sync, push or pull its content.","name":"Zendesk Integrations"},{"description":"Connect a project to Stripo, choose what it translates, and sync, push or pull its content.","name":"Stripo Integrations"},{"description":"Connect a project to Crisp Helpdesk, and sync, push or pull its content.","name":"Crisp Helpdesk Integrations"},{"description":"Read the workspace's API request log. Each entry records one request, without its payload. How long entries are kept depends on the workspace's plan.","name":"API Logs"},{"description":"Read the workspace's audit log: who changed what, and when.","name":"Audit Logs"}]}