# Create an integration authentication

`POST https://api.lingohub.com/v2/integration-authentications`

LingoHub API V2 (Beta) · [Integration Authentications](https://developers.lingohub.com/reference/v2/operations/tags/integration-authentications.md) · operation `createIntegrationAuthentication`

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.

## Parameters

| Parameter | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| `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/integration-authentications \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "provider": "AZURE",
  "name": "Company Azure DevOps",
  "access_token": "provider-token"
}'
```

## Responses

- `201`: Authentication stored.
- `400`: 
- `401`: 
- `403`: 
- `409`: 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 (`id…
- `413`: 
- `422`: 
- `429`: 
- `500`: 
- `502`: The content platform could not check the credentials (`upstream_error`). Nothing is stored; retry later.
- `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": "Integration Authentications",
      "description": "Manage the stored credentials LingoHub uses to connect to Git providers and content platforms."
    }
  ],
  "paths": {
    "/v2/integration-authentications": {
      "post": {
        "tags": [
          "Integration Authentications"
        ],
        "summary": "Create an integration authentication",
        "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": [
          {
            "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/CreateIntegrationAuthentication"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Authentication stored.",
            "headers": {
              "Idempotent-Replayed": {
                "$ref": "#/components/headers/Idempotent-Replayed"
              },
              "ETag": {
                "$ref": "#/components/headers/ETag"
              },
              "RateLimit": {
                "$ref": "#/components/headers/RateLimit"
              },
              "RateLimit-Policy": {
                "$ref": "#/components/headers/RateLimit-Policy"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IntegrationAuthentication"
                },
                "example": {
                  "object_type": "INTEGRATION_AUTHENTICATION",
                  "id": "iau_0197c8f2-5a6b-7cde-8f12-3456789abcde",
                  "name": "Company GitLab",
                  "provider": "GITLAB",
                  "type": "MANUAL",
                  "status": "ACTIVE",
                  "is_self_hosted": false,
                  "provider_origin": "https://gitlab.com",
                  "provider_region": null,
                  "created_at": "2025-01-15T10:30:00.123Z",
                  "updated_at": "2025-01-15T10:30:00.123Z"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "409": {
            "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": {
              "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"
          },
          "502": {
            "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"
              }
            },
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "CreateIntegrationAuthentication": {
        "type": "object",
        "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": {
          "propertyName": "provider",
          "mapping": {
            "AZURE": "#/components/schemas/CreateTokenAuthentication",
            "BITBUCKET": "#/components/schemas/CreateTokenAuthentication",
            "CONTENTFUL": "#/components/schemas/CreateTokenAuthentication",
            "HUBSPOT": "#/components/schemas/CreateTokenAuthentication",
            "STRIPO": "#/components/schemas/CreateTokenAuthentication",
            "GITLAB": "#/components/schemas/CreateGitLabAuthentication",
            "AWS_CODE_COMMIT": "#/components/schemas/CreateCodeCommitAuthentication",
            "STORYBLOK": "#/components/schemas/CreateStoryblokAuthentication",
            "ZENDESK": "#/components/schemas/CreateZendeskAuthentication",
            "CRISP_HELPDESK": "#/components/schemas/CreateCrispHelpdeskAuthentication"
          }
        },
        "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"
          }
        ]
      },
      "CreateTokenAuthentication": {
        "type": "object",
        "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": {
          "provider": {
            "type": "string",
            "description": "Selects this shape of the body.",
            "enum": [
              "AZURE",
              "BITBUCKET",
              "CONTENTFUL",
              "HUBSPOT",
              "STRIPO"
            ],
            "example": "AZURE"
          },
          "name": {
            "type": "string",
            "description": "Display name for the stored authentication.",
            "example": "Company Azure DevOps",
            "maxLength": 255,
            "minLength": 1
          },
          "access_token": {
            "type": "string",
            "description": "Write-only provider access token; never returned.",
            "example": "provider-token",
            "maxLength": 8192,
            "minLength": 1
          }
        },
        "required": [
          "access_token",
          "name",
          "provider"
        ]
      },
      "CreateGitLabAuthentication": {
        "type": "object",
        "additionalProperties": false,
        "description": "Request body to create a GitLab authentication. The token is stored without a remote check.",
        "properties": {
          "provider": {
            "type": "string",
            "description": "Selects this shape of the body.",
            "enum": [
              "GITLAB"
            ],
            "example": "GITLAB"
          },
          "name": {
            "type": "string",
            "description": "Display name for the stored authentication.",
            "example": "Internal Git setup",
            "maxLength": 255,
            "minLength": 1
          },
          "access_token": {
            "type": "string",
            "description": "Write-only provider credential. Saved without a remote validity check.",
            "example": "provider-credential",
            "maxLength": 8192,
            "minLength": 1
          },
          "is_self_hosted": {
            "type": "boolean",
            "description": "Whether to use the existing self-hosted GitLab configuration.",
            "example": false
          },
          "provider_url": {
            "type": [
              "string",
              "null"
            ],
            "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
          }
        },
        "required": [
          "access_token",
          "is_self_hosted",
          "name",
          "provider"
        ]
      },
      "CreateCodeCommitAuthentication": {
        "type": "object",
        "additionalProperties": false,
        "description": "Request body to create an AWS CodeCommit authentication. The credential is stored without a remote check.",
        "properties": {
          "provider": {
            "type": "string",
            "description": "Selects this shape of the body.",
            "enum": [
              "AWS_CODE_COMMIT"
            ],
            "example": "AWS_CODE_COMMIT"
          },
          "name": {
            "type": "string",
            "description": "Display name for the stored authentication.",
            "example": "Internal Git setup",
            "maxLength": 255,
            "minLength": 1
          },
          "access_token": {
            "type": "string",
            "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
          },
          "region": {
            "type": "string",
            "description": "Existing CodeCommit region setting.",
            "example": "us-east-1",
            "maxLength": 255,
            "minLength": 1
          }
        },
        "required": [
          "access_token",
          "name",
          "provider",
          "region"
        ]
      },
      "CreateStoryblokAuthentication": {
        "type": "object",
        "additionalProperties": false,
        "description": "Request body to create a Storyblok authentication. The token is validated with Storyblok first.",
        "properties": {
          "provider": {
            "type": "string",
            "description": "Selects this shape of the body.",
            "enum": [
              "STORYBLOK"
            ],
            "example": "STORYBLOK"
          },
          "name": {
            "type": "string",
            "description": "Authentication display name.",
            "example": "Internal content test",
            "maxLength": 255,
            "minLength": 1
          },
          "region": {
            "$ref": "#/components/schemas/StoryblokRegion",
            "description": "Existing Storyblok hosting region.",
            "example": "EUROPE"
          },
          "access_token": {
            "type": "string",
            "description": "Provider access token. Validated and stored through the existing encrypted credential path; never returned.",
            "example": "provider-token",
            "maxLength": 8192,
            "minLength": 1
          }
        },
        "required": [
          "access_token",
          "name",
          "provider",
          "region"
        ]
      },
      "StoryblokRegion": {
        "type": "string",
        "description": "Existing Storyblok hosting regions.",
        "enum": [
          "EUROPE",
          "UNITED_STATES",
          "CANADA",
          "AUSTRALIA",
          "CHINA"
        ]
      },
      "CreateZendeskAuthentication": {
        "type": "object",
        "additionalProperties": false,
        "description": "Request body to create a Zendesk authentication. The credentials are validated with Zendesk first.",
        "properties": {
          "provider": {
            "type": "string",
            "description": "Selects this shape of the body.",
            "enum": [
              "ZENDESK"
            ],
            "example": "ZENDESK"
          },
          "name": {
            "type": "string",
            "description": "Authentication display name.",
            "example": "Internal content test",
            "maxLength": 255,
            "minLength": 1
          },
          "provider_url": {
            "type": "string",
            "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/?$"
          },
          "username": {
            "type": "string",
            "description": "Existing Zendesk API username; use the same value as the integration setup.",
            "example": "agent@example.com",
            "maxLength": 255,
            "minLength": 1
          },
          "access_token": {
            "type": "string",
            "description": "Provider access token. Validated and stored through the existing encrypted credential path; never returned.",
            "example": "provider-token",
            "maxLength": 8192,
            "minLength": 1
          }
        },
        "required": [
          "access_token",
          "name",
          "provider",
          "provider_url",
          "username"
        ]
      },
      "CreateCrispHelpdeskAuthentication": {
        "type": "object",
        "additionalProperties": false,
        "description": "Request body to create a Crisp Helpdesk authentication. The credentials are validated with Crisp first.",
        "properties": {
          "provider": {
            "type": "string",
            "description": "Selects this shape of the body.",
            "enum": [
              "CRISP_HELPDESK"
            ],
            "example": "CRISP_HELPDESK"
          },
          "name": {
            "type": "string",
            "description": "Authentication display name.",
            "example": "Internal content test",
            "maxLength": 255,
            "minLength": 1
          },
          "identifier": {
            "type": "string",
            "description": "Crisp plugin identifier.",
            "example": "plugin-identifier",
            "maxLength": 255,
            "minLength": 1
          },
          "key": {
            "type": "string",
            "description": "Crisp plugin key. Never returned.",
            "example": "provider-key",
            "maxLength": 8192,
            "minLength": 1
          },
          "website_key": {
            "type": "string",
            "description": "External Crisp website key, not a LingoHub identity.",
            "example": "website-key",
            "maxLength": 255,
            "minLength": 1
          }
        },
        "required": [
          "identifier",
          "key",
          "name",
          "provider",
          "website_key"
        ]
      },
      "IntegrationAuthentication": {
        "type": "object",
        "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": {
          "object_type": "INTEGRATION_AUTHENTICATION",
          "id": "iau_0197c8f2-5a6b-7cde-8f12-3456789abcde",
          "name": "Company GitHub installation",
          "provider": "GITHUB",
          "type": "INSTALLATION",
          "status": "ACTIVE",
          "is_self_hosted": false,
          "provider_origin": "https://github.com",
          "provider_region": null,
          "created_at": "2025-01-15T10:30:00.123Z",
          "updated_at": "2025-06-20T14:45:00.123Z"
        },
        "properties": {
          "object_type": {
            "type": "string",
            "description": "Always `INTEGRATION_AUTHENTICATION`.",
            "enum": [
              "INTEGRATION_AUTHENTICATION"
            ],
            "example": "INTEGRATION_AUTHENTICATION"
          },
          "id": {
            "type": "string",
            "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}$"
          },
          "name": {
            "type": "string",
            "description": "Stored display name.",
            "example": "Company GitHub installation"
          },
          "provider": {
            "$ref": "#/components/schemas/IntegrationProvider",
            "description": "Provider.",
            "example": "GITHUB"
          },
          "type": {
            "$ref": "#/components/schemas/IntegrationAuthenticationType",
            "description": "How this authentication was provisioned.",
            "example": "INSTALLATION"
          },
          "status": {
            "$ref": "#/components/schemas/IntegrationAuthenticationStatus",
            "description": "Stored lifecycle, not live connectivity.",
            "example": "ACTIVE"
          },
          "is_self_hosted": {
            "type": "boolean",
            "description": "Whether the authentication uses a self-hosted provider.",
            "example": false
          },
          "provider_origin": {
            "type": [
              "string",
              "null"
            ],
            "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"
          },
          "provider_region": {
            "type": [
              "string",
              "null"
            ],
            "description": "Stored CodeCommit region; null for other providers or invalid regions.",
            "example": "us-east-1"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "Creation time of the stored authentication.",
            "example": "2025-01-15T10:30:00.123Z"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Metadata update time of the stored authentication.",
            "example": "2025-06-20T14:45:00.123Z"
          }
        },
        "required": [
          "created_at",
          "id",
          "is_self_hosted",
          "name",
          "object_type",
          "provider",
          "provider_origin",
          "provider_region",
          "status",
          "type",
          "updated_at"
        ]
      },
      "IntegrationProvider": {
        "type": "string",
        "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"
        ]
      },
      "IntegrationAuthenticationType": {
        "type": "string",
        "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"
        ]
      },
      "IntegrationAuthenticationStatus": {
        "type": "string",
        "description": "`SUSPENDED` or `REVOKED` when the GitHub App was suspended or uninstalled on GitHub; other connections are always `ACTIVE`.",
        "enum": [
          "ACTIVE",
          "SUSPENDED",
          "REVOKED"
        ]
      },
      "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"
        }
      },
      "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"
        }
      },
      "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"
            }
          }
        }
      },
      "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"
      }
    }
  }
}
````
