# Change the statuses of texts in a batch

`POST https://api.lingohub.com/v2/branches/{branchId}/segments/bulk-transition`

LingoHub API V2 (Beta) · [Segments](https://developers.lingohub.com/reference/v2/operations/tags/segments.md) · operation `transitionSegmentsBulk`

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.

## Parameters

| Parameter | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| `branchId` | path | yes | string | Public identifier of the branch. |
| `Idempotency-Key` | header | no | string | 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 n… |

## Example request

```sh
curl --request POST \
  --url https://api.lingohub.com/v2/branches/BRANCH_ID/segments/bulk-transition \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "items": [
    {
      "segment_id": "seg_0197c8f2-5a6b-7cde-8f12-3456789abcde",
      "language_code": "de",
      "action": "APPROVE"
    }
  ]
}'
```

## Responses

- `200`: The segments after the change, one per item of the request and in its order.
- `400`: 
- `401`: 
- `403`: 
- `404`: 
- `409`: `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 re…
- `413`: 
- `422`: 
- `429`: 
- `500`: 
- `503`: 

## OpenAPI definition

The complete definition of this operation, with every schema it references:

````json
{
  "openapi": "3.1.0",
  "info": {
    "title": "LingoHub API V2 (Beta)",
    "version": "2.0"
  },
  "servers": [
    {
      "url": "https://api.lingohub.com",
      "description": "LingoHub"
    }
  ],
  "tags": [
    {
      "name": "Segments",
      "description": "Read and change segments: a source text and its translations, which every key of the segment shows."
    }
  ],
  "paths": {
    "/v2/branches/{branchId}/segments/bulk-transition": {
      "post": {
        "tags": [
          "Segments"
        ],
        "summary": "Change the statuses of texts in a batch",
        "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": [
          {
            "name": "branchId",
            "in": "path",
            "description": "Public identifier of the branch.",
            "required": true,
            "schema": {
              "type": "string",
              "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}$"
            }
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "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.",
            "required": false,
            "schema": {
              "type": "string",
              "maxLength": 255,
              "minLength": 1
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TransitionSegmentsBulk"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "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"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SegmentList"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "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": {
              "Retry-After": {
                "description": "Seconds to wait for an in-progress keyed request; absent for other conflicts.",
                "schema": {
                  "type": "integer",
                  "format": "int32"
                }
              },
              "RateLimit": {
                "$ref": "#/components/headers/RateLimit"
              },
              "RateLimit-Policy": {
                "$ref": "#/components/headers/RateLimit-Policy"
              }
            },
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "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": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "TransitionSegmentsBulk": {
        "type": "object",
        "additionalProperties": false,
        "description": "Request body to change the status of up to 150 texts of a branch.",
        "properties": {
          "items": {
            "type": "array",
            "description": "The status changes, each text once.",
            "example": [
              {
                "segment_id": "seg_0197c8f2-5a6b-7cde-8f12-3456789abcde",
                "language_code": "de",
                "action": "APPROVE"
              }
            ],
            "items": {
              "$ref": "#/components/schemas/BulkTransitionSegmentItem"
            },
            "maxItems": 150,
            "minItems": 1
          }
        },
        "required": [
          "items"
        ]
      },
      "BulkTransitionSegmentItem": {
        "type": "object",
        "additionalProperties": false,
        "description": "Request body part naming a text of the branch and the status change to make.",
        "properties": {
          "segment_id": {
            "type": "string",
            "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}$"
          },
          "language_code": {
            "type": "string",
            "description": "Language of the text, one of the branch's languages.",
            "example": "de"
          },
          "action": {
            "$ref": "#/components/schemas/TextAction",
            "description": "APPROVE, REOPEN, MARK_TRANSLATED or REJECT; the source text takes only APPROVE and REOPEN.",
            "example": "APPROVE"
          }
        },
        "required": [
          "action",
          "language_code",
          "segment_id"
        ]
      },
      "TextAction": {
        "type": "string",
        "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"
        ]
      },
      "SegmentList": {
        "type": "object",
        "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": {
          "object_type": {
            "type": "string",
            "description": "Always `LIST`.",
            "enum": [
              "LIST"
            ],
            "example": "LIST"
          },
          "data": {
            "type": "array",
            "description": "The segments.",
            "example": [
              {
                "object_type": "SEGMENT",
                "id": "seg_0197c8f2-5a6b-7cde-8f12-3456789abcde",
                "stack_id": "stack_0197c8f2-5a6b-7cde-8f12-3456789abcde",
                "is_plural": false,
                "description": "Label on the sign-in button",
                "is_not_translatable": false,
                "not_translatable_reason": "RESOURCE_FILE",
                "label_ids": [
                  "la_0197c8f2-5a6b-7cde-8f12-3456789abcde"
                ],
                "texts": {
                  "en": {
                    "is_source": true,
                    "status": "APPROVED",
                    "stage": "DONE",
                    "variants": [
                      {
                        "content": "Sign in",
                        "device": "OTHER",
                        "plural_form": "OTHER"
                      }
                    ],
                    "updated_at": "2026-09-29T00:00:00.000Z",
                    "content_updated_at": "2026-09-29T00:00:00.000Z"
                  },
                  "de": {
                    "is_source": false,
                    "status": "TRANSLATED",
                    "stage": "NEEDS_REVIEW",
                    "variants": [
                      {
                        "content": "Anmelden",
                        "device": "OTHER",
                        "plural_form": "OTHER"
                      }
                    ],
                    "updated_at": "2026-09-29T00:00:00.000Z",
                    "content_updated_at": "2026-09-29T00:00:00.000Z"
                  }
                },
                "created_at": "2026-09-29T00:00:00.123Z",
                "updated_at": "2026-09-29T00:00:00.123Z"
              }
            ],
            "items": {
              "$ref": "#/components/schemas/Segment"
            }
          }
        },
        "required": [
          "data",
          "object_type"
        ]
      },
      "Segment": {
        "type": "object",
        "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": {
          "object_type": {
            "type": "string",
            "description": "Always `SEGMENT`.",
            "enum": [
              "SEGMENT"
            ],
            "example": "SEGMENT"
          },
          "id": {
            "type": "string",
            "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}$"
          },
          "stack_id": {
            "type": "string",
            "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}$"
          },
          "is_plural": {
            "type": "boolean",
            "description": "Whether the segment has plural forms.",
            "example": false
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "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"
          },
          "is_not_translatable": {
            "type": "boolean",
            "description": "Whether the segment is excluded from translation.",
            "example": false
          },
          "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"
              }
            ]
          },
          "label_ids": {
            "type": "array",
            "description": "Public identifiers of the segment's labels.",
            "example": [
              "la_0197c8f2-5a6b-7cde-8f12-3456789abcde"
            ],
            "items": {
              "type": "string",
              "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}$"
            }
          },
          "texts": {
            "type": "object",
            "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": {
              "en": {
                "is_source": true,
                "status": "APPROVED",
                "stage": "DONE",
                "variants": [
                  {
                    "content": "Sign in",
                    "device": "OTHER",
                    "plural_form": "OTHER"
                  }
                ],
                "updated_at": "2026-09-29T00:00:00.000Z",
                "content_updated_at": "2026-09-29T00:00:00.000Z"
              },
              "de": {
                "is_source": false,
                "status": "TRANSLATED",
                "stage": "NEEDS_REVIEW",
                "variants": [
                  {
                    "content": "Anmelden",
                    "device": "OTHER",
                    "plural_form": "OTHER"
                  }
                ],
                "updated_at": "2026-09-29T00:00:00.000Z",
                "content_updated_at": "2026-09-29T00:00:00.000Z"
              }
            }
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp when the segment was created.",
            "example": "2026-09-29T00:00:00.123Z"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "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"
          }
        },
        "required": [
          "created_at",
          "description",
          "id",
          "is_not_translatable",
          "is_plural",
          "label_ids",
          "not_translatable_reason",
          "object_type",
          "stack_id",
          "texts",
          "updated_at"
        ]
      },
      "NotTranslatableReason": {
        "type": "string",
        "description": "Origin of a segment's not-translatable flag: file syntax or an editor/bulk action.",
        "enum": [
          "RESOURCE_FILE",
          "EDITOR"
        ]
      },
      "SegmentText": {
        "type": "object",
        "description": "The text of a segment in one language, the source included: its variants and its workflow status.",
        "example": {
          "is_source": true,
          "status": "APPROVED",
          "stage": "DONE",
          "variants": [
            {
              "content": "Sign in",
              "device": "OTHER",
              "plural_form": "OTHER"
            }
          ],
          "updated_at": "2026-09-29T00:00:00.000Z",
          "content_updated_at": "2026-09-29T00:00:00.000Z"
        },
        "properties": {
          "is_source": {
            "type": "boolean",
            "description": "Whether this is the stack's source language.",
            "example": true
          },
          "status": {
            "$ref": "#/components/schemas/TextStatus",
            "description": "Workflow status of the text.",
            "example": "APPROVED"
          },
          "stage": {
            "$ref": "#/components/schemas/TextStage",
            "description": "Workflow stage of the status.",
            "example": "DONE"
          },
          "variants": {
            "type": "array",
            "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"
            }
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "When the text, its status or its counts last changed.",
            "example": "2026-09-29T00:00:00.123Z"
          },
          "content_updated_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "description": "When the variants last changed. Null before the text ever had content.",
            "example": "2026-09-29T00:00:00.123Z"
          }
        },
        "required": [
          "content_updated_at",
          "is_source",
          "stage",
          "status",
          "updated_at",
          "variants"
        ]
      },
      "TextStatus": {
        "type": "string",
        "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"
        ]
      },
      "TextStage": {
        "type": "string",
        "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"
        ]
      },
      "TextVariant": {
        "type": "object",
        "description": "One variant of a text: its content for a device and a plural form.",
        "properties": {
          "content": {
            "type": "string",
            "description": "The text, with its placeholders and markup.",
            "example": "Sign in"
          },
          "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"
        ]
      },
      "VariantDevice": {
        "type": "string",
        "description": "Device of a text variant.",
        "enum": [
          "PHONE",
          "MUSIC_PLAYER",
          "TABLET",
          "WATCH",
          "TV",
          "GLASSES",
          "PC",
          "OTHER"
        ]
      },
      "VariantPluralForm": {
        "type": "string",
        "description": "Plural form of a text variant.",
        "enum": [
          "ZERO",
          "ONE",
          "TWO",
          "FEW",
          "MANY",
          "OTHER"
        ]
      },
      "Error": {
        "type": "object",
        "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": {
          "type": {
            "type": "string",
            "description": "URL identifying the problem type and pointing to its documentation.",
            "example": "https://api.lingohub.com/errors/resource-not-found"
          },
          "title": {
            "type": "string",
            "description": "Short, constant summary of the problem type.",
            "example": "Resource not found"
          },
          "status": {
            "type": "integer",
            "format": "int32",
            "description": "HTTP status code.",
            "example": 404
          },
          "detail": {
            "type": "string",
            "description": "Human-readable explanation of this occurrence of the problem.",
            "example": "Resource with ID 'pr_0197c8f2-5a6b-7cde-8f12-3456789abcde' was not found."
          },
          "instance": {
            "type": "string",
            "description": "Path of the request that produced the problem.",
            "example": "/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde"
          },
          "code": {
            "$ref": "#/components/schemas/ErrorCode",
            "description": "Machine-readable problem type.",
            "example": "resource_not_found"
          },
          "request_id": {
            "type": "string",
            "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"
          },
          "errors": {
            "type": "array",
            "description": "Rejected fields or parameters. Present when the problem concerns specific fields or parameters.",
            "example": [
              {
                "detail": "must be at least 2 characters long",
                "pointer": "#/name",
                "parameter": "limit",
                "code": "minLength"
              }
            ],
            "items": {
              "$ref": "#/components/schemas/FieldError"
            }
          },
          "required_permission": {
            "$ref": "#/components/schemas/RequiredPermission",
            "description": "The permission the API key lacks. Present on 403 responses."
          }
        },
        "required": [
          "code",
          "detail",
          "instance",
          "request_id",
          "status",
          "title",
          "type"
        ]
      },
      "ErrorCode": {
        "type": "string",
        "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"
        ]
      },
      "FieldError": {
        "type": "object",
        "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": {
          "detail": {
            "type": "string",
            "description": "Human-readable description of the problem.",
            "example": "must be at least 2 characters long"
          },
          "pointer": {
            "type": [
              "string",
              "null"
            ],
            "description": "JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.",
            "example": "#/name"
          },
          "parameter": {
            "type": [
              "string",
              "null"
            ],
            "description": "Name of the offending query, path or header parameter, or of the multipart form field.",
            "example": "limit"
          },
          "code": {
            "$ref": "#/components/schemas/FieldErrorCode",
            "description": "Why the field or parameter was rejected.",
            "example": "minLength"
          }
        },
        "required": [
          "code",
          "detail",
          "parameter",
          "pointer"
        ]
      },
      "FieldErrorCode": {
        "type": "string",
        "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"
        ]
      },
      "RequiredPermission": {
        "type": "object",
        "description": "The permission the API key lacks, in the vocabulary of the API key permission settings.",
        "properties": {
          "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"
          },
          "level": {
            "$ref": "#/components/schemas/PermissionLevel",
            "description": "The access level required.",
            "example": "MANAGE"
          }
        },
        "required": [
          "level",
          "scope",
          "target"
        ]
      },
      "PermissionScope": {
        "type": "string",
        "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"
        ]
      },
      "PermissionTarget": {
        "type": "string",
        "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"
        ]
      },
      "PermissionLevel": {
        "type": "string",
        "description": "Access level of a permission: `MANAGE` includes `WRITE` and `VIEW`.",
        "enum": [
          "NO_ACCESS",
          "VIEW",
          "WRITE",
          "MANAGE"
        ]
      }
    },
    "headers": {
      "Idempotent-Replayed": {
        "description": "True when the original successful result was replayed for this key.",
        "schema": {
          "type": "boolean"
        }
      },
      "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": {
          "type": "integer",
          "format": "int32"
        }
      }
    },
    "responses": {
      "BadRequest": {
        "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"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "Unauthorized": {
        "description": "Invalid or missing API key.",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "Forbidden": {
        "description": "Insufficient permissions.",
        "headers": {
          "RateLimit": {
            "$ref": "#/components/headers/RateLimit"
          },
          "RateLimit-Policy": {
            "$ref": "#/components/headers/RateLimit-Policy"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "NotFound": {
        "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"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "ContentTooLarge": {
        "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"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "UnprocessableContent": {
        "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"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "TooManyRequests": {
        "description": "The API rate limit was exceeded. Wait for the number of seconds given in the Retry-After header, then retry.",
        "headers": {
          "Retry-After": {
            "$ref": "#/components/headers/Retry-After"
          },
          "RateLimit": {
            "$ref": "#/components/headers/RateLimit"
          },
          "RateLimit-Policy": {
            "$ref": "#/components/headers/RateLimit-Policy"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "InternalServerError": {
        "description": "An unexpected internal server error occurred.",
        "headers": {
          "RateLimit": {
            "$ref": "#/components/headers/RateLimit"
          },
          "RateLimit-Policy": {
            "$ref": "#/components/headers/RateLimit-Policy"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "ServiceUnavailable": {
        "description": "The service is temporarily unavailable. Retry after the number of seconds in the Retry-After header.",
        "headers": {
          "Retry-After": {
            "$ref": "#/components/headers/Retry-After"
          },
          "RateLimit": {
            "$ref": "#/components/headers/RateLimit"
          },
          "RateLimit-Policy": {
            "$ref": "#/components/headers/RateLimit-Policy"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "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"
      }
    }
  }
}
````
