# Create a backup restore

`POST https://api.lingohub.com/v2/branches/{branchId}/backup-restores`

LingoHub API V2 (Beta) · [Backup Restores](https://developers.lingohub.com/reference/v2/operations/tags/backup-restores.md) · operation `createBackupRestore`

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.

## Parameters

| Parameter | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| `branchId` | path | yes | string |  |
| `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/backup-restores \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "backup_id": "bkp_0197c8f2-5a6b-7cde-8f12-3456789abcde",
  "language_codes": [
    "en",
    "de"
  ]
}'
```

## Responses

- `202`: Restore queued.
- `400`: 
- `401`: 
- `403`: 
- `404`: 
- `409`: `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 befo…
- `413`: 
- `422`: 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…
- `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": "Backup Restores",
      "description": "Restore languages of a backup into a branch in the background, and follow the restore."
    }
  ],
  "paths": {
    "/v2/branches/{branchId}/backup-restores": {
      "post": {
        "tags": [
          "Backup Restores"
        ],
        "summary": "Create a backup restore",
        "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": [
          {
            "name": "branchId",
            "in": "path",
            "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/CreateBackupRestore"
              }
            }
          },
          "required": true
        },
        "responses": {
          "202": {
            "description": "Restore queued.",
            "headers": {
              "RateLimit": {
                "$ref": "#/components/headers/RateLimit"
              },
              "Idempotent-Replayed": {
                "$ref": "#/components/headers/Idempotent-Replayed"
              },
              "RateLimit-Policy": {
                "$ref": "#/components/headers/RateLimit-Policy"
              },
              "Location": {
                "description": "URL of the restore, to poll it until it has finished.",
                "style": "simple",
                "schema": {
                  "type": "string",
                  "format": "uri-reference",
                  "example": "/v2/backup-restores/bkr_0197c8f2-5a6b-7cde-8f12-3456789abcde"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BackupRestoreJob"
                },
                "examples": {
                  "queued": {
                    "description": "queued",
                    "value": {
                      "object_type": "JOB",
                      "job_type": "BACKUP_RESTORE",
                      "data": {
                        "object_type": "BACKUP_RESTORE",
                        "id": "bkr_0197c8f2-5a6b-7cde-8f12-3456789abcde",
                        "project_id": "pr_0197c8f2-5a6b-7cde-8f12-3456789abcde",
                        "branch_id": "prb_0197c8f2-5a6b-7cde-8f12-3456789abcde",
                        "backup_id": "bkp_0197c8f2-5a6b-7cde-8f12-3456789abcde",
                        "status": "QUEUED",
                        "status_details": null,
                        "language_codes": [
                          "en",
                          "de"
                        ],
                        "created_at": "2026-01-15T10:30:00.123Z",
                        "updated_at": "2026-01-15T10:30:00.123Z"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "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": {
              "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": {
            "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"
              }
            },
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "CreateBackupRestore": {
        "type": "object",
        "additionalProperties": false,
        "description": "Request body to restore languages of a succeeded backup into a branch of the same project.",
        "properties": {
          "backup_id": {
            "type": "string",
            "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}$"
          },
          "language_codes": {
            "type": "array",
            "description": "The languages to restore, each one the backup has; each language once.",
            "example": [
              "en",
              "de"
            ],
            "items": {
              "type": "string",
              "example": "en"
            },
            "maxItems": 1000,
            "minItems": 1,
            "uniqueItems": true
          }
        },
        "required": [
          "backup_id",
          "language_codes"
        ]
      },
      "BackupRestoreJob": {
        "type": "object",
        "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": {
            "type": "string",
            "description": "Always `BACKUP_RESTORE`.",
            "enum": [
              "BACKUP_RESTORE"
            ],
            "example": "BACKUP_RESTORE"
          },
          "object_type": {
            "type": "string",
            "description": "Always `JOB`.",
            "enum": [
              "JOB"
            ],
            "example": "JOB"
          }
        },
        "required": [
          "data",
          "job_type",
          "object_type"
        ]
      },
      "BackupRestore": {
        "type": "object",
        "description": "A restore of languages of a backup into a branch.",
        "properties": {
          "object_type": {
            "type": "string",
            "description": "Always `BACKUP_RESTORE`.",
            "enum": [
              "BACKUP_RESTORE"
            ],
            "example": "BACKUP_RESTORE"
          },
          "id": {
            "type": "string",
            "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}$"
          },
          "project_id": {
            "type": "string",
            "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}$"
          },
          "branch_id": {
            "type": "string",
            "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}$"
          },
          "backup_id": {
            "type": "string",
            "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}$"
          },
          "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.",
            "oneOf": [
              {
                "$ref": "#/components/schemas/SyncStatusDetails"
              },
              {
                "type": "null"
              }
            ],
            "example": null
          },
          "language_codes": {
            "type": "array",
            "description": "The languages restored from the backup.",
            "example": [
              "en",
              "de"
            ],
            "items": {
              "type": "string",
              "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)."
            }
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "When the restore was requested.",
            "example": "2026-01-01T10:00:00.123Z"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "When the restore was last changed, including its status.",
            "example": "2026-01-01T10:01:00.123Z"
          }
        },
        "required": [
          "backup_id",
          "branch_id",
          "created_at",
          "id",
          "language_codes",
          "object_type",
          "project_id",
          "status",
          "status_details",
          "updated_at"
        ]
      },
      "BackupRestoreStatus": {
        "type": "string",
        "description": "Status of a restore. `QUEUED` and `PROCESSING` are pending; `SUCCEEDED` and `FAILED` are final.",
        "enum": [
          "QUEUED",
          "PROCESSING",
          "SUCCEEDED",
          "FAILED"
        ]
      },
      "SyncStatusDetails": {
        "type": "object",
        "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": {
            "type": "string",
            "description": "English explanation of the outcome.",
            "example": "There are no files to export."
          }
        },
        "required": [
          "code",
          "detail"
        ]
      },
      "SyncStatusCode": {
        "type": "string",
        "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"
        ]
      },
      "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": {
      "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"
        }
      },
      "Idempotent-Replayed": {
        "description": "True when the original successful result was replayed for this key.",
        "schema": {
          "type": "boolean"
        }
      },
      "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"
            }
          }
        }
      },
      "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"
      }
    }
  }
}
````
