{"openapi":"3.1.0","info":{"title":"LingoHub API V1","description":"The LingoHub API V1 is the API for projects, resource files, exports and repository pushes. It is stable and remains supported. New integrations should use API V2 (Beta).\n\n## Authentication\n\nAll requests require an API key as a Bearer token in the `Authorization` header. Create keys in the LingoHub workspace settings; new keys use the `lh-api_` prefix.\n\n## Identifiers\n\nWorkspaces and projects are addressed by URL slugs (`workspaceUrl`, `projectUrl`). `GET /v1/projects` returns them.\n\n## Errors\n\nErrors use standard HTTP status codes with a JSON body. Most list the rejected input in `validationErrors`, each with a machine-readable `code`.\n\n## Rate limiting\n\nRequests are rate limited per workspace. Exceeding the limit returns `429` with a `Retry-After` header. `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-RefillRate` report the current budget.","termsOfService":"https://lingohub.com/terms","contact":{"name":"lingohub GmbH","url":"https://lingohub.com","email":"info@lingohub.com"},"version":"1"},"servers":[{"url":"https://api.lingohub.com","description":"Generated server url"}],"tags":[{"name":"Projects","description":"Endpoints for the operations that can be performed on projects of a workspace"},{"name":"Repository","description":"Endpoint to push resource files to a repository"},{"name":"Resources","description":"Endpoints for the operations that can be performed on the resource files"},{"name":"Context Images","description":"Endpoints for the operations that can be performed on the context images"},{"name":"Exports","description":"Endpoints for requesting a resource export and checking their statuses"}],"paths":{"/v1/{workspaceUrl}/projects":{"post":{"tags":["Projects"],"summary":"Create a project","description":"Creates a new localization project within the specified workspace. Requires the project title, resource type (file format), source language, and optionally target languages and a description.","operationId":"v1ProjectCreateProject","parameters":[{"name":"workspaceUrl","in":"path","description":"<Glossary>workspaceUrl</Glossary>","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProjectRequest"}}},"required":true},"responses":{"200":{"description":"Successfully created the project. Returns the detailed project information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDetails"},"examples":{"createdProject":{"summary":"Newly created JSON project","description":"createdProject","value":{"title":"My Mobile App","description":"Localization project for our mobile application","links":[{"rel":"self","href":"https://api.lingohub.com/v1/my-workspace/projects/my-mobile-app"},{"rel":"resources","href":"https://api.lingohub.com/v1/my-workspace/projects/my-mobile-app/resources"}],"owner_email":"user@example.com","project_locales":["en","de","fr"],"created_at":"2025-01-15T10:30:00+0000","updated_at":"2025-01-15T10:30:00+0000"}}}}}},"401":{"description":"Unauthorized: Authentication credentials are missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"403":{"description":"Forbidden: The authenticated user does not have settings management permission on this workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"404":{"description":"Not Found: The specified workspace does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"422":{"description":"Unprocessable Entity: Validation failed for the request body (e.g. missing title, invalid resource type, or invalid language code).","content":{"application/json":{}}}},"security":[{"bearerAuth":[]}]}},"/v1/{workspaceUrl}/projects/{projectUrl}/resources/zip":{"post":{"tags":["Resources"],"summary":"Upload a resource file ZIP archive","description":"Uploads a ZIP archive containing multiple resource files to the specified project. The archive is extracted and all visible files within it are imported. Language detection is performed automatically based on file names and paths. Import behavior for source and target languages can be controlled through optional parameters.","operationId":"v1ResourceUploadResourceFileZip","parameters":[{"name":"workspaceUrl","in":"path","description":"<Glossary>workspaceUrl</Glossary>","required":true,"schema":{"type":"string"}},{"name":"projectUrl","in":"path","description":"<Glossary>projectUrl</Glossary>","required":true,"schema":{"type":"string"}},{"name":"source:createNew","in":"query","description":"If this file belongs to the source language: If new segments should be created","required":false,"schema":{"type":"boolean"}},{"name":"source:updateExisting","in":"query","description":"If this file belongs to the source language: If changed segments should be updated","required":false,"schema":{"type":"boolean"}},{"name":"source:deactivateMissing","in":"query","description":"If this file belongs to the source language: If removed segments should be deactivated","required":false,"schema":{"type":"boolean"}},{"name":"target:createNew","in":"query","description":"If this file belongs to the target language: If new segments should be created","required":false,"schema":{"type":"boolean"}},{"name":"target:updateExisting","in":"query","description":"If this file belongs to the target language: If changed segments should be updated","required":false,"schema":{"type":"boolean"}},{"name":"target:deactivateMissing","in":"query","description":"If this file belongs to the target language: If removed segments should be deactivated","required":false,"schema":{"type":"boolean"}},{"name":"branch","in":"query","description":"Name of the project branch to import into. If omitted, the project's default branch is used. Returns 422 if the branch name does not exist in the project.","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"The zip file that will be uploaded"}},"required":["file"]}}}},"responses":{"201":{"description":"Successfully uploaded and extracted the ZIP archive. All contained resource files have been scheduled for import.","content":{"application/json":{"examples":{"zipUploadSuccess":{"summary":"Successful ZIP upload","description":"zipUploadSuccess","value":{"status":"Success"}}}}}},"400":{"description":"Bad Request: The ZIP archive is empty or contains no visible files.","content":{"application/json":{}}},"401":{"description":"Unauthorized: Authentication credentials are missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"403":{"description":"Forbidden: The authenticated user does not have resource management permission on this project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"404":{"description":"Not Found: The specified workspace or project does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"422":{"description":"Unprocessable Entity: The specified branch name does not exist in the project, or an archive entry has an extension the project type cannot import (one files.invalid_extension error per entry, naming it).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorResponse"},"examples":{"unsupportedFile":{"summary":"Unsupported file extension","description":"unsupportedFile","value":{"validationErrors":[{"field":"files","errors":[{"code":"files.invalid_extension","description":"File 'Resources.en.txt' has an unsupported extension; this project imports: resx, resw.","parameters":{"file":"Resources.en.txt"}}]}]}}}}}},"500":{"description":"Internal Server Error: An unexpected error occurred during the import process.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/{workspaceUrl}/projects/{projectUrl}/resources":{"get":{"tags":["Resources"],"summary":"List resource files","description":"Returns the list of resource files belonging to the specified project. Each entry includes the file name, its associated locale, and a HATEOAS link for downloading the resource file. Use the localeInFileName parameter to control whether locale information is rendered in file names.","operationId":"v1ResourceGetResourceInfoList","parameters":[{"name":"workspaceUrl","in":"path","description":"<Glossary>workspaceUrl</Glossary>","required":true,"schema":{"type":"string"}},{"name":"projectUrl","in":"path","description":"<Glossary>projectUrl</Glossary>","required":true,"schema":{"type":"string"}},{"name":"localeInFileName","in":"query","description":"determines if the locale info should be rendered in the file name: ALL(default), TARGETS, NONE","required":false,"schema":{"$ref":"#/components/schemas/LocaleInFileName"}},{"name":"addIso2Slug","in":"query","description":"if true the iso2_slug parameter will be always added to the rendered resource file URLs","required":false,"schema":{"type":"boolean"}},{"name":"branch","in":"query","description":"Name of the project branch. If omitted, the project's default branch is used. Returns 422 if the branch name does not exist in the project.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully returns the list of the project's resource files.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceInfoList"},"examples":{"resourceFileList":{"summary":"Project with English and French JSON files","description":"resourceFileList","value":{"members":[{"name":"src/app/translations/lang/en.json","links":[{"rel":"self","href":"https://api.lingohub.com/v1/lingohub/projects/lh-frontend/resources/en.json?path=src%2Fapp%2Ftranslations%2Flang","type":"text/json"}],"project_locale":"en"},{"name":"src/app/translations/lang/fr.json","links":[{"rel":"self","href":"https://api.lingohub.com/v1/lingohub/projects/lh-frontend/resources/fr.json?path=src%2Fapp%2Ftranslations%2Flang","type":"text/json"}],"project_locale":"fr"}],"links":[{"rel":"self","href":"https://api.lingohub.com/v1/lingohub/projects/lh-frontend/resources?localeInFileName=ALL"}]}}}}}},"401":{"description":"Unauthorized: Authentication credentials are missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"403":{"description":"Forbidden: The authenticated user does not have resource view permission on this project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"404":{"description":"Not Found: The specified workspace or project does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"422":{"description":"Unprocessable Entity: The specified branch name does not exist in the project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Resources"],"summary":"Upload a resource file","description":"Uploads a single resource file to the specified project. The file's language is detected automatically from the file name, or can be explicitly set via the iso2_slug/iso2_code parameter. Import behavior for source and target languages (create new segments, update existing, deactivate missing) can be controlled through optional parameters. If the upload might cause a file name collision, set force=true to proceed.","operationId":"v1ResourceUploadResourceFile","parameters":[{"name":"workspaceUrl","in":"path","description":"<Glossary>workspaceUrl</Glossary>","required":true,"schema":{"type":"string"}},{"name":"projectUrl","in":"path","description":"<Glossary>projectUrl</Glossary>","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","description":"Path the resource container (file) will be uploaded to","required":false,"schema":{"type":"string"}},{"name":"iso2_slug","in":"query","description":"The iso code of the resource file locale. Overrides the language information that might be given in the path. Alias of 'iso2_code'.","required":false,"schema":{"type":"string"}},{"name":"iso2_code","in":"query","description":"The iso code of the resource file locale. Overrides the language information that might be given in the path. Alias of 'iso2_slug'.","required":false,"schema":{"type":"string"}},{"name":"source:createNew","in":"query","description":"If this file belongs to the source language: If new segments should be created","required":false,"schema":{"type":"boolean"}},{"name":"source:updateExisting","in":"query","description":"If this file belongs to the source language: If changed segments should be updated","required":false,"schema":{"type":"boolean"}},{"name":"source:deactivateMissing","in":"query","description":"If this file belongs to the source language: If removed segments should be deactivated","required":false,"schema":{"type":"boolean"}},{"name":"target:createNew","in":"query","description":"If this file belongs to the target language: If new segments should be created","required":false,"schema":{"type":"boolean"}},{"name":"target:updateExisting","in":"query","description":"If this file belongs to the target language: If changed segments should be updated","required":false,"schema":{"type":"boolean"}},{"name":"target:deactivateMissing","in":"query","description":"If this file belongs to the target language: If removed segments should be deactivated","required":false,"schema":{"type":"boolean"}},{"name":"force","in":"query","description":"Force the upload. Override potential security measures, eg. a collision between file names","required":false,"schema":{"type":"boolean","default":false}},{"name":"branch","in":"query","description":"Name of the project branch to import into. If omitted, the project's default branch is used. Returns 422 if the branch name does not exist in the project.","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"File that will be uploaded"}},"required":["file"]}}}},"responses":{"201":{"description":"Successfully uploaded the resource file.","content":{"application/json":{"examples":{"uploadSuccess":{"summary":"Successful upload","description":"uploadSuccess","value":{"status":"Success"}}}}}},"401":{"description":"Unauthorized: Authentication credentials are missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"403":{"description":"Forbidden: The authenticated user does not have resource management permission on this project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"404":{"description":"Not Found: The specified workspace or project does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"406":{"description":"Not Acceptable: A file name collision was detected and force=true was not set. Specify a path or use force=true to override.","content":{"application/json":{"examples":{"collisionDetected":{"summary":"Path collision detected","description":"collisionDetected","value":{"status":"Not acceptable","message":"A situation has been detected that might lead to an unwanted upload action..."}}}}}},"422":{"description":"Unprocessable Entity: The specified branch name does not exist in the project, or the file has an extension the project type cannot import (error code files.invalid_extension, naming the file).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorResponse"},"examples":{"unsupportedFile":{"summary":"Unsupported file extension","description":"unsupportedFile","value":{"validationErrors":[{"field":"files","errors":[{"code":"files.invalid_extension","description":"File 'Resources.en.txt' has an unsupported extension; this project imports: resx, resw.","parameters":{"file":"Resources.en.txt"}}]}]}}}}}},"500":{"description":"Internal Server Error: An unexpected error occurred during the import process.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/{workspaceUrl}/projects/{projectUrl}/push":{"post":{"tags":["Repository"],"summary":"Push resource files to a repository","description":"Triggers pushing the project's resource files to the linked repository. A repository connection (e.g. GitHub, GitLab, Bitbucket, or Azure DevOps) must have been configured for the project beforehand. The push can be performed either as a direct commit or as a pull/merge request depending on the configuration or the explicit pushType parameter.","operationId":"v1RepositoryPushFiles","parameters":[{"name":"workspaceUrl","in":"path","description":"<Glossary>workspaceUrl</Glossary>","required":true,"schema":{"type":"string"}},{"name":"projectUrl","in":"path","description":"<Glossary>projectUrl</Glossary>","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushFilesRequest"}}},"required":true},"responses":{"200":{"description":"Successfully triggered the push operation. Returns an empty body."},"401":{"description":"Unauthorized: Authentication credentials are missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"403":{"description":"Forbidden: The authenticated user does not have resource management permission on this project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"404":{"description":"Not Found: The specified workspace or project does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"400":{"description":"Bad Request: The project has no linked repository or the push parameters are invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"422":{"description":"Unprocessable Entity: The branch does not exist in the repository, or the project has no language with the given languageCode.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/{workspaceUrl}/projects/{projectUrl}/exports":{"post":{"tags":["Exports"],"summary":"Request a resource export","description":"Initiates the creation of a resource export that is assembled asynchronously in the background. Once completed, the export produces a downloadable ZIP file containing the project's resource files. The optional request body allows filtering by specific file paths, language codes, and overriding the export format. Use the GET endpoint with the returned export ID to poll for completion status and retrieve the download URL.","operationId":"v1ResourceExportsRequestExport","parameters":[{"name":"workspaceUrl","in":"path","description":"<Glossary>workspaceUrl</Glossary>","required":true,"schema":{"type":"string"}},{"name":"projectUrl","in":"path","description":"<Glossary>projectUrl</Glossary>","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceExportRequest"}}}},"responses":{"200":{"description":"Successfully created the resource export request. The export is being assembled in the background.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceExportResponse"},"examples":{"exportCreated":{"summary":"Newly created export (processing)","description":"exportCreated","value":{"id":"reg_3163-0556-1428-5087674","status":"PROCESSING","resourceExports":[],"errorDetails":null,"filePath":null,"downloadUrl":null,"triggerType":"API_V1","createdAt":"2025-01-15T10:30:00.000+00:00"}}}}}},"401":{"description":"Unauthorized: Authentication credentials are missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"403":{"description":"Forbidden: The authenticated user does not have resource view permission on this project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"404":{"description":"Not Found: The specified workspace, project, or a filtered resource file path does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"422":{"description":"Unprocessable Entity: The specified branch name does not exist in the project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/{workspaceUrl}/projects/{projectUrl}/contextImages":{"get":{"tags":["Context Images"],"summary":"List context images","description":"Retrieves a list of the context images.\nThis is a paginated endpoint; see the `page` and `size` query parameters to control pagination.","operationId":"v1ContextImagesGetContextImages","parameters":[{"name":"workspaceUrl","in":"path","description":"<Glossary>workspaceUrl</Glossary>","required":true,"schema":{"type":"string"}},{"name":"projectUrl","in":"path","description":"<Glossary>projectUrl</Glossary>","required":true,"schema":{"type":"string"}},{"name":"urlFilter","in":"query","description":"a filter based on UrlFilter","required":false,"schema":{"type":"string"},"example":"to fetch context images not bound to any segments: urlFilter={\"where\":{\"_and\":[{\"contextImage[segments]\":{\"_npresent\":true}}]}}"},{"name":"page","in":"query","description":"Zero-based page index (0..N)","required":false,"schema":{"type":"integer"}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","required":false,"schema":{"type":"string"}},{"name":"size","in":"query","description":"The size of the page to be returned","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK: Returns a paginated list of the context images for the specified project.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PageResponseV1ContextImageResponse"}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Context Images"],"summary":"Create context image","description":"Creates and optionally connects context images to text segments.","operationId":"v1ContextImagesCreateContextImage","parameters":[{"name":"workspaceUrl","in":"path","description":"<Glossary>workspaceUrl</Glossary>","required":true,"schema":{"type":"string"}},{"name":"projectUrl","in":"path","description":"<Glossary>projectUrl</Glossary>","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"request":{"$ref":"#/components/schemas/V1CreateContextImageRequest"},"file":{"type":"string","format":"binary"}},"required":["file","request"]},"encoding":{"request":{"contentType":"application/json"}}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/V1ContextImageResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/{workspaceUrl}/projects/{projectUrl}":{"get":{"tags":["Projects"],"summary":"Get project details","description":"Retrieves detailed information for a specific project, including its title, description, configured locales, owner, and HATEOAS links to related resources such as the project's resource files.","operationId":"v1ProjectGetProjectDetails","parameters":[{"name":"workspaceUrl","in":"path","description":"<Glossary>workspaceUrl</Glossary>","required":true,"schema":{"type":"string"}},{"name":"projectUrl","in":"path","description":"<Glossary>projectUrl</Glossary>","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully returns the project details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDetails"},"examples":{"projectDetails":{"summary":"A project with three locales","description":"projectDetails","value":{"title":"Frontend","description":null,"links":[{"rel":"self","href":"https://api.lingohub.com/v1/lingohub-demo/projects/gl-ios"},{"rel":"resources","href":"https://api.lingohub.com/v1/lingohub-demo/projects/gl-ios/resources"}],"owner_email":"demo@lingohub.com","project_locales":["en","de","zh-Hant"],"created_at":"2024-05-13T13:49:38.000+00:00","updated_at":"2024-07-01T13:25:21.000+00:00"}}}}}},"401":{"description":"Unauthorized: Authentication credentials are missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to view this project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"404":{"description":"Not Found: The specified workspace or project does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/{workspaceUrl}/projects/{projectUrl}/status":{"get":{"tags":["Projects"],"summary":"Get project resource file status","description":"    Retrieves a comprehensive status overview for the specified project, including:\n\n     * The resource containers (files) of the project with per-locale segment status counts\n     * The supported export formats for those resource containers\n     * The status of repository connections (GitHub, Bitbucket, Azure, GitLab) and whether pushing is possible\n\n    This endpoint is particularly useful for understanding the translation completeness of each resource file     and for determining whether repository integrations are properly configured.\n","operationId":"v1ProjectGetProjectStatus","parameters":[{"name":"workspaceUrl","in":"path","description":"<Glossary>workspaceUrl</Glossary>","required":true,"schema":{"type":"string"}},{"name":"projectUrl","in":"path","description":"<Glossary>projectUrl</Glossary>","required":true,"schema":{"type":"string"}},{"name":"branch","in":"query","description":"Name of the project branch. If omitted, the project's default branch is used. Returns 422 if the branch name does not exist in the project.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully returns the project's resource files with their translation statuses, supported export formats, and repository connection details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectResourceFiles"},"examples":{"projectResourceStatus":{"summary":"iOS project with GitLab connected","description":"projectResourceStatus","value":{"resourceFiles":[{"uuid":"rc_18VdrZH7J24I-194872","basename":"Payment.strings","filePathWithLocalePlaceholder":"ios/%{locale}.lproj/Payment.strings","files":[{"name":"ios/en.lproj/Payment.strings","languageCode":"en","mimeType":"text/plain","statuses":{"NOT_TRANSLATED":0,"APPROVED":12,"TRANSLATED":0,"DRAFT":0},"failingLingochecksCount":0}]}],"supportedExportFormats":[{"id":"strings.ios","name":"iOS Strings"},{"id":"xml.android.resources","name":"Android String Resources"}],"repositoryConnections":[{"provider":"github","connected":false},{"provider":"bitbucket","connected":false},{"provider":"azure","connected":false},{"provider":"gitlab","connected":true}],"repositoryConnected":true,"pushToRepositoryPossible":true,"pushType":"PULL_REQUEST","oneFileForAllLocales":false}}}}}},"401":{"description":"Unauthorized: Authentication credentials are missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to view resources of this project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"404":{"description":"Not Found: The specified workspace or project does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"422":{"description":"Unprocessable Entity: The specified branch name does not exist in the project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/{workspaceUrl}/projects/{projectUrl}/resources/{fileName}":{"get":{"tags":["Resources"],"summary":"Download a resource file","description":"Downloads the specified resource file from the project. Supports extensive export customization through query parameters including blank content handling, status filtering, character encoding, HTML encoding, and format conversion (e.g. export an iOS .strings file as Android XML). The response body contains the raw file content with appropriate content type headers. The response carries a weak ETag; send it back as If-None-Match to receive 304 Not Modified without a body while nothing in the project changed (If-Modified-Since alone is not evaluated: HTTP dates cannot tell two changes within one second apart). Send Accept-Encoding: gzip to receive the file compressed.","operationId":"v1ResourceDownloadResourceFile","parameters":[{"name":"workspaceUrl","in":"path","description":"<Glossary>workspaceUrl</Glossary>","required":true,"schema":{"type":"string"}},{"name":"projectUrl","in":"path","description":"<Glossary>projectUrl</Glossary>","required":true,"schema":{"type":"string"}},{"name":"fileName","in":"path","description":"Name of the resource file to download","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","description":"Path of the resource file to download. if the fileName won't be unique.","required":false,"schema":{"type":"string"}},{"name":"iso2_slug","in":"query","description":"The iso code of the resource file locale. Overrides the language information that might be given in the path. Alias of 'iso2_code'.","required":false,"schema":{"type":"string"}},{"name":"iso2_code","in":"query","description":"The iso code of the resource file locale. Overrides the language information that might be given in the path. Alias of 'iso2_slug'.","required":false,"schema":{"type":"string"}},{"name":"source:blankContentHandling","in":"query","required":false,"schema":{"type":"string","description":"Should the segment be exported if source content is blank.","enum":["fallback","use_source","master_locale","keep","blank","skip"]}},{"name":"target:blankContentHandling","in":"query","required":false,"schema":{"type":"string","description":"Should the segment be exported if target content is blank.","enum":["fallback","use_source","master_locale","keep","blank","skip"]}},{"name":"source:filterByStatus","in":"query","required":false,"schema":{"type":"string","description":"Filter for source segments based on status.","enum":["ALL","TRANSLATED_AND_APPROVED","TRANSLATED_AND_REVIEWED","APPROVED","REVIEWED"]}},{"name":"target:filterByStatus","in":"query","required":false,"schema":{"type":"string","description":"Filter for target segments based on status.","enum":["ALL","TRANSLATED_AND_APPROVED","TRANSLATED_AND_REVIEWED","APPROVED","REVIEWED"]}},{"name":"htmlEncoding","in":"query","required":false,"schema":{"type":"string","description":"If the segment content holds HTML. How should it be escaped","enum":["RAW","ESCAPE","CDATA"]}},{"name":"encoding","in":"query","description":"The character set encoding the file should have.","required":false,"schema":{"type":"string"}},{"name":"escapeMode","in":"query","description":"Alias of 'htmlEncoding'","required":false,"schema":{"$ref":"#/components/schemas/HtmlEncoding"}},{"name":"addLocaleInformationToFilename","in":"query","required":false,"schema":{"type":"string","description":"If the language information should be added to the filename.","enum":["ALL","TARGETS","NONE"]}},{"name":"escapeCharacters","in":"query","description":"If special characters should be escaped. Different behavior according to resource type.","required":false,"schema":{"type":"boolean"}},{"name":"exportTargetComments","in":"query","description":"Should comments be exported to files of the target language","required":false,"schema":{"type":"boolean"}},{"name":"exportSourceLocale","in":"query","description":"If a resource file holds multiple languages, this indicates if the source language should be included in this export.","required":false,"schema":{"type":"boolean"}},{"name":"exportHeader","in":"query","description":"If the file header (if applicable) should be exported.","required":false,"schema":{"type":"boolean"}},{"name":"exportTitle","in":"query","description":"if the title of a segment (if applicable) should be exported.","required":false,"schema":{"type":"boolean"}},{"name":"exportDescription","in":"query","description":"If a resource file holds multiple languages, this indicates if the description of the segments should be exported at all.","required":false,"schema":{"type":"boolean"}},{"name":"projectType","in":"query","description":"Overrides the project type of the project for this export. Enables to eg. download an iOS file as Android XML or vice versa.","required":false,"schema":{"type":"string","enum":["ios.strings","ios.stringsdict","android.string.resources","properties","standard_json"]}},{"name":"branch","in":"query","description":"Name of the project branch. If omitted, the project's default branch is used. Returns 422 if the branch name does not exist in the project.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully returns the content of the specified resource file as a byte stream.","content":{"*/*":{"schema":{"type":"string","format":"byte"}}}},"304":{"description":"Not Modified: the If-None-Match validator still matches, the file the client holds is current."},"401":{"description":"Unauthorized: Authentication credentials are missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"403":{"description":"Forbidden: The authenticated user does not have resource view permission on this project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"404":{"description":"Not Found: The specified workspace, project, or resource file does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"422":{"description":"Unprocessable Entity: The specified branch name does not exist in the project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"500":{"description":"Internal Server Error: An unexpected error occurred during resource file export.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Resources"],"summary":"Delete a resource container","description":"Deletes the specified resource container (file) and all its associated locale files. The fileName and optional path parameters must identify the source language file of the resource container. If the specified file does not belong to the source language, the request will be rejected with a 400 error.\n","operationId":"v1ResourceDeleteResourceContainer","parameters":[{"name":"workspaceUrl","in":"path","description":"<Glossary>workspaceUrl</Glossary>","required":true,"schema":{"type":"string"}},{"name":"projectUrl","in":"path","description":"<Glossary>projectUrl</Glossary>","required":true,"schema":{"type":"string"}},{"name":"fileName","in":"path","description":"File name of the resource file to be deleted. Has to address the source language file.","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","description":"File Path of the resource file to deleted. Has to address the source language file.","required":false,"schema":{"type":"string"}},{"name":"branch","in":"query","description":"Name of the project branch. If omitted, the project's default branch is used. Returns 422 if the branch name does not exist in the project.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully deleted the resource container and all its associated locale files."},"400":{"description":"Bad Request: The specified file name/path does not belong to the source language of the project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"401":{"description":"Unauthorized: Authentication credentials are missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"403":{"description":"Forbidden: The authenticated user does not have resource management permission on this project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"404":{"description":"Not Found: The specified workspace, project, or resource container does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"422":{"description":"Unprocessable Entity: The specified branch name does not exist in the project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/{workspaceUrl}/projects/{projectUrl}/exports/{id}":{"get":{"tags":["Exports"],"summary":"Get resource export status","description":"Retrieves the current status and details of a previously requested resource export. Poll this endpoint to check whether an asynchronous export has completed. Once the status is SUCCESS, the downloadUrl field contains a pre-signed S3 URL for downloading the export. Individual file entries and their statuses are also included.","operationId":"v1ResourceExportsGetResourceExport","parameters":[{"name":"workspaceUrl","in":"path","description":"<Glossary>workspaceUrl</Glossary>","required":true,"schema":{"type":"string"}},{"name":"projectUrl","in":"path","description":"<Glossary>projectUrl</Glossary>","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"the id of an existing resource export","required":true,"schema":{"type":"string","description":"Specific Id that is created from the id and the 'type' of the corresponding resource. When used in requests, its value is the prefix of the FriendlyIdType followed by the encrypted id of the resource. I.e : For resource_exports, a valid request param value would be : reg_18USq6822XIv-19847171"},"example":"reg_3163-0556-1428-5087674"}],"responses":{"200":{"description":"Successfully returns the resource export with its current status and download information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceExportResponse"},"examples":{"exportSuccess":{"summary":"Completed export with download URL","description":"exportSuccess","value":{"id":"reg_3163-0556-1428-5087674","status":"SUCCESS","resourceExports":[{"filePath":"config/locales/en/messages.yml","iso2Slug":"en","status":"SUCCESS","downloadUrl":"https://lingohub-...s3.amazonaws.com/..."},{"filePath":"config/locales/de/messages.yml","iso2Slug":"de","status":"SUCCESS","downloadUrl":"https://lingohub-...s3.amazonaws.com/..."}],"errorDetails":null,"filePath":"files.zip","downloadUrl":"https://lingohub-...s3.amazonaws.com/...","triggerType":"API_V1","createdAt":"2025-01-15T10:30:00.000+00:00"}},"exportProcessing":{"summary":"Export still in progress","description":"exportProcessing","value":{"id":"reg_3163-0556-1428-5087674","status":"PROCESSING","resourceExports":[],"errorDetails":null,"filePath":null,"downloadUrl":null,"triggerType":"API_V1","createdAt":"2025-01-15T10:30:00.000+00:00"}}}}}},"401":{"description":"Unauthorized: Authentication credentials are missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"403":{"description":"Forbidden: The authenticated user does not have resource view permission on this project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"404":{"description":"Not Found: The specified export ID, workspace, or project does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/{workspaceUrl}/projects/status":{"get":{"tags":["Projects"],"summary":"Get translation status of all accessible workspace projects","description":"    Retrieves a list of the projects within the specified workspace the caller is allowed to view, each including:\n\n     * Standard attributes (title, URL)\n     * Translation status counts per locale, broken down by segment status (NOT_TRANSLATED, DRAFT, TRANSLATED, PREFILLED, APPROVED)\n\n    This endpoint is useful for building dashboards or monitoring overall translation progress across projects.\n","operationId":"v1ProjectGetProjectStatusInfos","parameters":[{"name":"workspaceUrl","in":"path","description":"<Glossary>workspaceUrl</Glossary>","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully returns a list of projects with their per-locale translation status breakdown.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProjectStatus"}},"examples":{"projectStatuses":{"summary":"Project with translation statuses per locale","description":"projectStatuses","value":[{"title":"lh-frontend","url":"https://app.lingohub.com/project/pr_11HeYxUdI1lp-228/branches/prb_18vCn8SsCceB-17798","totalCount":5202,"status":{"fr":{"PREFILLED":5087,"DRAFT":27,"TRANSLATED":0,"NOT_TRANSLATED":88,"APPROVED":0},"en":{"PREFILLED":0,"DRAFT":164,"TRANSLATED":0,"NOT_TRANSLATED":0,"APPROVED":5038}}}]}}}}},"401":{"description":"Unauthorized: Authentication credentials are missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to view this workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}},"404":{"description":"Not Found: The specified workspace does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/projects":{"get":{"tags":["Projects"],"summary":"List all projects","description":"Retrieves a list of all projects accessible by the authenticated user. This includes projects the user owns as well as projects they collaborate on across all workspaces.","operationId":"v1ProjectGetListOfProjects","responses":{"200":{"description":"Successfully returns the list of projects the authenticated user has access to.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectList"},"examples":{"projectList":{"summary":"Two projects in a workspace","description":"projectList","value":{"members":[{"title":" Feature Demo","links":[{"rel":"self","href":"https://api.lingohub.com/v1/lingohub-demo/projects/feature-demo"}]},{"title":"Storyblok Demo","links":[{"rel":"self","href":"https://api.lingohub.com/v1/lingohub-demo/projects/storyblok-demo"}]}],"links":[{"rel":"self","href":"https://api.lingohub.com/v1/projects"}]}}}}}},"401":{"description":"Unauthorized: Authentication credentials are missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ErrorInfo"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/{workspaceUrl}/projects/{projectUrl}/contextImages/{id}":{"delete":{"tags":["Context Images"],"summary":"Delete context image","description":"Delete the specified context image","operationId":"v1ContextImagesDeleteContextImages","parameters":[{"name":"workspaceUrl","in":"path","description":"<Glossary>workspaceUrl</Glossary>","required":true,"schema":{"type":"string"}},{"name":"projectUrl","in":"path","description":"<Glossary>projectUrl</Glossary>","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","description":"Specific Id that is created from the id and the 'type' of the corresponding resource. When used in requests, its value is the prefix of the FriendlyIdType followed by the encrypted id of the resource. I.e : For context_images, a valid request param value would be : ci_18USq6822XIv-19847171"}}],"responses":{"200":{"description":"OK: Delete the context image corresponding to the specified id"}},"security":[{"bearerAuth":[]}]}}},"components":{"schemas":{"HttpStatus":{"allOf":[{"$ref":"#/components/schemas/HttpStatusCode"}]},"HttpStatusCode":{"type":"object","properties":{"error":{"type":"boolean"},"is4xxClientError":{"type":"boolean"},"is5xxServerError":{"type":"boolean"},"is1xxInformational":{"type":"boolean"},"is2xxSuccessful":{"type":"boolean"},"is3xxRedirection":{"type":"boolean"}}},"CreateProjectRequest":{"type":"object","description":"Request body for creating a new localization project.","properties":{"title":{"type":"string","description":"The title of the project.","example":"My Mobile App","maxLength":999,"minLength":0},"description":{"type":"string","description":"Optional project description.","example":"Localization project for the mobile application","maxLength":512,"minLength":0},"resourceType":{"type":"string","description":"The resource file type for the project. Determines the file format used for import/export.","enum":["arb","properties","windows_resx","gettext_po","markdown","chrome_i18n","properties","qt_linguist_ts","txt","standard_ini","android_xml","ios_strings","twine_txt","rails_yaml","php_define","symfony2_yaml","json_go_i18n","angular_translate_json","react_intl_json","i18next_json","standard_json","csv","xliff","html"],"example":"json.standard","minLength":1},"sourceLanguageCode":{"type":"string","description":"The source (base) language code of the project. This is the language from which translations are made.","example":"en"},"targetLanguageCodes":{"type":"array","description":"The list of target language codes to translate into.","example":["de","fr","es"],"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)."}}},"required":["resourceType","sourceLanguageCode","title"]},"Link":{"type":"object","properties":{"href":{"type":"string"},"hreflang":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"deprecation":{"type":"string"},"profile":{"type":"string"},"name":{"type":"string"},"templated":{"type":"boolean"}}},"ProjectDetails":{"type":"object","description":"Detailed information about a localization project including its locales, owner, and HATEOAS links.","properties":{"title":{"type":"string","description":"The title of the project.","example":"My Mobile App"},"owner_email":{"type":"string","description":"Email address of the project's owner.","example":"owner@example.com"},"description":{"type":"string","description":"Project description.","example":"Localization project for the mobile application"},"project_locales":{"type":"array","description":"The list of locale codes configured for the project.","example":["en","de","fr-CA"],"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":"Timestamp when the project was created.","example":"2025-01-15T10:30:00"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the project was last updated.","example":"2025-02-20T14:45:00"},"links":{"type":"array","description":"HATEOAS links for navigating to related resources (e.g. project resources, status).","items":{"$ref":"#/components/schemas/Link"}}}},"V1ErrorInfo":{"type":"object","properties":{"url":{"type":"string"},"message":{"type":"string"},"text":{"type":"string"}}},"V1ErrorDetails":{"type":"object","properties":{"code":{"type":"string"},"description":{"type":"string"},"status":{"$ref":"#/components/schemas/HttpStatus"}}},"V1ErrorResponse":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/V1ErrorDetails"},"validationErrors":{"type":"array","items":{"$ref":"#/components/schemas/V1ValidationError"}}}},"V1FieldValidationError":{"type":"object","properties":{"code":{"type":"string"},"description":{"type":"string"},"parameters":{"type":"object","additionalProperties":{}}}},"V1ValidationError":{"type":"object","properties":{"field":{"type":"string"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/V1FieldValidationError"}}}},"PushFilesRequest":{"type":"object","description":"The information needed to perform the push operation","properties":{"branch":{"type":"string","description":"Name of the branch to push to. If left empty, the default branch configured in the repository connection will be used.","example":"main"},"pushType":{"$ref":"#/components/schemas/PushType","description":"The type of push to perform: PUSH for a direct commit, or PULL_REQUEST for creating a pull/merge request. If left empty, the project's default push type will be used.","enum":["PUSH","PULL_REQUEST"]},"commitMessage":{"type":"string","description":"The commit message for the push. If left empty, a default commit message will be generated.","example":"Update translations for release 2.3.0"},"commitDescription":{"type":"string","description":"An optional extended commit description providing additional context for the push.","example":"Includes updated French and German translations"},"path":{"type":"string","description":"Restrict the push to resource files under this path. If not set, all resource files of the project will be pushed.","example":"/src/config/locales"},"languageCode":{"type":"string","description":"Restrict the push to resource files of this locale. Specified as an ISO 639-1 code (e.g. 'en', 'de-AT') and matched against the project's languages ignoring case, so 'de-at' selects 'de-AT'. A code the project has no language for is rejected.","example":"en"},"pullRequestBranch":{"type":"string","description":"Name of the branch to create for the pull/merge request. Only applicable when pushType is PULL_REQUEST.","example":"lingohub/update-translations"},"pullRequestTitle":{"type":"string","description":"The title of the pull/merge request. Only applicable when pushType is PULL_REQUEST.","example":"Update translations"},"pullRequestDescription":{"type":"string","description":"The description body of the pull/merge request. Only applicable when pushType is PULL_REQUEST.","example":"This PR updates the translation files exported from LingoHub."}}},"PushType":{"type":"string","enum":["PUSH","PULL_REQUEST"]},"ErrorDetails":{"type":"object","properties":{"code":{"type":"string"},"description":{"type":"string"},"status":{"$ref":"#/components/schemas/HttpStatus"}}},"ErrorResponse":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/ErrorDetails"},"validationErrors":{"type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}}},"FieldValidationError":{"type":"object","properties":{"code":{"type":"string"},"description":{"type":"string"},"parameters":{"type":"object","additionalProperties":{}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/FieldValidationError"}}}},"ResourceExportRequest":{"type":"object","description":"optional request body that acts as filter and may specify the export format","properties":{"filePaths":{"type":"array","description":"An additional filter for requesting the export of particular files. If not given, all files of the project will be exported. File paths (including locale placeholder if applicable) as seen in Resources view.","example":["config/locales/%{locale}/messages.yml"],"items":{"type":"string"},"uniqueItems":true},"iso2Slugs":{"type":"array","description":"An additional filter for requesting the export of particular languages. If not given, all files of all languages of the project will be exported. ISO-639-1 codes of project languages.","example":["en","de","fr"],"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)."},"uniqueItems":true},"exportFormat":{"type":"string","description":"Several project types allow to download files in a different format than as defined by the project type. This setting overrides the export format. If not given, the type of the project will be used.","enum":["strings.ios","xml.android.resources","properties","standard_json"],"example":"standard_json"},"branch":{"type":"string","description":"Name of the project branch to export from. If omitted, the project's default branch is used. Returns 422 if the branch name does not exist in the project.","example":"main"}}},"ResourceExportEntryResponse":{"type":"object","description":"Status and download information for a single file within a resource export.","properties":{"filePath":{"type":"string","description":"The file path of the exported entry, including locale placeholder if applicable.","example":"config/locales/en/messages.yml"},"iso2Slug":{"type":"string","description":"The ISO-639-1 language code for this entry.","example":"de-AT"},"status":{"$ref":"#/components/schemas/ResourceExportParamStatus","description":"The processing status of this individual export entry."},"downloadUrl":{"type":"string","description":"The S3 download URL for this individual file. Null while processing or if an error occurred.","example":"https://lingohub-exports.s3.amazonaws.com/exports/abc123/messages_de-AT.yml"}}},"ResourceExportParamStatus":{"type":"string","enum":["NEW","SCHEDULED","PROCESSING","SUCCESS","SKIPPED","ERROR"]},"ResourceExportResponse":{"type":"object","description":"Response containing the status and details of a resource export, including individual file entries and download URLs.","properties":{"id":{"type":"string","description":"The unique identifier for this resource export.","example":"reg_abc123def456"},"status":{"$ref":"#/components/schemas/ResourceExportParamStatus","description":"The compound status of this resource export. Reflects the overall progress across all entries."},"resourceExports":{"type":"array","description":"The list of individual resource export entries (one per file/locale combination).","items":{"$ref":"#/components/schemas/ResourceExportEntryResponse"}},"errorDetails":{"type":"string","description":"Detailed information about the error that occurred, if the export failed. Null on success."},"filePath":{"type":"string","description":"The name of the ZIP file that is or will be generated for this export.","example":"frontend-app.zip"},"downloadUrl":{"type":"string","description":"The S3 download URL for the exported ZIP. Null while the export is in progress or if an error occurred.","example":"https://lingohub-exports.s3.amazonaws.com/exports/abc123/frontend-app.zip"},"triggerType":{"$ref":"#/components/schemas/TriggerType","description":"The trigger that caused this resource export (e.g. manual, webhook)."},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the resource export was created.","example":"2025-02-20T14:45:00.000+00:00"}},"required":["id","resourceExports","status"]},"TriggerType":{"type":"string","enum":["DOWNLOAD_SINGLE","DOWNLOAD_MULTIPLE","REPOSITORY_PUSH_MULTIPLE","REPOSITORY_PUSH","DISTRIBUTION_RELEASE","PACKAGES","BACKUPS","ZENDESK_SELECTED","ZENDESK_ALL","ZENDESK_PUSH","API_V1","API_V2","SINGLE_FILE_API_V1","SEGMENT_CONTAINER","XLIFF","STORYBLOK_PUSH","CONTENTFUL_PUSH","CSV","HUBSPOT_PUSH","STRIPO_PUSH","CRISP_HELPDESK_PUSH"]},"V1ConnectSegment":{"type":"object","description":"Represents a single text segment connection to a context image with its location on the image","properties":{"filePathAndKey":{"description":"The file path and key identifying the source text segment.\nRequired for KEY_BASED connections.\nFor TEXT_BASED connections, use the 'text' field instead.","oneOf":[{"$ref":"#/components/schemas/V1FilePathAndKey"},{"type":"null"}]},"text":{"type":["string","null"],"description":"The actual text content of the segment to match.\nUsed for TEXT_BASED connections or as a reference for KEY_BASED connections.\nThis text helps translators understand the context of the segment.","example":"Hello, welcome to our application!"},"highlightBox":{"description":"The rectangular region on the image that highlights where the text appears.\nUsed to visually indicate which part of the image the text relates to.\nCoordinates are in pixels, with (0,0) being the top-left corner of the image.","oneOf":[{"$ref":"#/components/schemas/V1HighlightBoxTransfer"},{"type":"null"}]}},"required":["filePathAndKey","highlightBox","text"]},"V1ConnectType":{"type":"string","description":"Enumeration of connection types for linking context images to text segments","enum":["KEY_BASED","TEXT_BASED","IMAGE_BASED"]},"V1CreateContextImageRequest":{"type":"object","description":"Defines how to create and connect the context image","properties":{"connectType":{"$ref":"#/components/schemas/V1ConnectType","description":"Determines how the context image will be connected to text segments:\n- **KEY_BASED**: Explicitly connect to segments identified by their file path and key\n- **TEXT_BASED**: Connect to segments by matching the exact text content\n- **IMAGE_BASED**: Use OCR text detection to automatically find and connect matching text on the image"},"description":{"type":["string","null"],"description":"Optional description providing context about what the image shows","example":"Screenshot of the settings page showing the language dropdown"},"languageCode":{"type":"string","description":"The ISO 639-1 language code (with optional regional variant) of the text segments this image relates to","example":"de"},"autoConnectSuggestions":{"type":"boolean","description":"When true, automatically accepts and connects OCR-detected text suggestions.\nOnly applicable when connectType is IMAGE_BASED.\nWhen false, suggestions are created but require manual review."},"segments":{"type":["array","null"],"description":"List of text segments to connect with their corresponding highlight box positions on the image.\nRequired with at least one entry for KEY_BASED and TEXT_BASED connection types.\nCan be omitted or null for IMAGE_BASED when auto-connecting via OCR.","items":{"$ref":"#/components/schemas/V1ConnectSegment"}}},"required":["autoConnectSuggestions","connectType","description","languageCode","segments"]},"V1FilePathAndKey":{"type":"object","description":"Identifies a text segment by its source file location and unique key","properties":{"filePath":{"type":"string","description":"The relative file path from the project root to the resource file containing the text.\nExample: 'res/values/strings.xml' or 'i18n/en.json'","example":"resources/translations.json","minLength":1},"key":{"type":"string","description":"The unique key identifier for the text within the resource file","example":"home.welcome_message","minLength":1}},"required":["filePath","key"]},"V1HighlightBoxTransfer":{"type":"object","description":"Defines a rectangular highlight box on the context image.\nUsed to visually indicate where specific text appears on the image.\nAll coordinates are in pixels relative to the top-left corner (0,0) of the image.","properties":{"left":{"type":"number","description":"The horizontal pixel coordinate of the left edge of the highlight box","example":150},"top":{"type":"number","description":"The vertical pixel coordinate of the top edge of the highlight box","example":200},"width":{"type":"number","description":"The width in pixels of the highlight box","example":120},"height":{"type":"number","description":"The height in pixels of the highlight box","example":40}},"required":["height","left","top","width"]},"ContextSource":{"type":"string","enum":["WEB","API","FIGMA","SDK"]},"TextDetectionStatus":{"type":"string","enum":["SCHEDULED","PROCESSING","DONE","ERROR"]},"UploadStatus":{"type":"string","enum":["PROCESSING","DONE","ERROR"]},"V1ContextImageResponse":{"type":"object","description":"Response object containing details of a context image including its connection status and metadata","properties":{"id":{"type":"string","description":"The unique identifier of the context image in the format 'ci_<encrypted_id>'","example":"ci_18USq6822XIv-19847171"},"name":{"type":"string","description":"The original filename of the uploaded context image"},"description":{"type":["string","null"],"description":"Optional user-provided description of the context image","example":"Screenshot of the main dashboard showing the navigation menu"},"imageUrl":{"type":"string","description":"The full URL to view the context image via Cloudflare Images CDN"},"projectTitle":{"type":"string","description":"The title of the project this context image belongs to"},"languageCode":{"type":"string","description":"The ISO 639-1 language code (with optional regional variant) this context image is associated with","example":"en"},"connectedSegmentLanguagesCount":{"type":"integer","format":"int64","description":"The count of text segments that are definitively connected to this context image"},"segmentLanguagesSuggestionsCount":{"type":"integer","format":"int64","description":"The count of text segment connection suggestions pending review"},"source":{"$ref":"#/components/schemas/ContextSource","description":"The source channel through which the context image was uploaded"},"uploadStatus":{"$ref":"#/components/schemas/UploadStatus","description":"The current upload processing status of the image"},"textDetectionStatus":{"$ref":"#/components/schemas/TextDetectionStatus","description":"The current status of the OCR text detection process"},"createdAt":{"type":"string","format":"date-time","description":"The timestamp when the context image was originally uploaded"},"updatedAt":{"type":"string","format":"date-time","description":"The timestamp when the context image was last updated"}},"required":["connectedSegmentLanguagesCount","createdAt","description","id","imageUrl","languageCode","name","projectTitle","segmentLanguagesSuggestionsCount","source","textDetectionStatus","updatedAt","uploadStatus"]},"ProjectResourceFiles":{"type":"object","description":"Complete resource file overview for a project, including file entries, export formats, repository connection status, and project type metadata.","properties":{"resourceFiles":{"type":"array","description":"The list of resource file containers in the project, each containing locale-specific files.","items":{"$ref":"#/components/schemas/V1ResourceFileEntry"}},"supportedExportFormats":{"type":"array","description":"The list of export formats supported by this project's resource type.","items":{"$ref":"#/components/schemas/V1ExportFormat"}},"repositoryConnections":{"type":"array","description":"The list of repository providers (e.g. GitHub, GitLab, Bitbucket) and their connection status for this project.","items":{"$ref":"#/components/schemas/RepositoryConnectionStatus"}},"repositoryConnected":{"type":"boolean","description":"Whether the project is currently connected to a source code repository."},"pushToRepositoryPossible":{"type":"boolean","description":"Whether it is possible to push translations to the connected repository."},"pushType":{"$ref":"#/components/schemas/PushType","description":"The type of push operation available (e.g. direct push or pull request). Null if the project is not connected to a repository."},"oneFileForAllLocales":{"type":"boolean","description":"Whether the project uses a single resource file for all locales (e.g. a single JSON file with all languages)."},"segmentsUpdatedAt":{"type":"string","format":"date-time","description":"Timestamp of the last segment content update. Useful for detecting whether translations have changed since a given point in time.","example":"2025-02-20T14:45:00"},"availableLocales":{"type":"array","description":"The list of locale codes available in the project.","example":["en","de","fr"],"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)."}}}},"RepositoryConnectionStatus":{"type":"object","description":"Defines a repository connection to a repository provider","properties":{"provider":{"type":"string","description":"A repository provider name like 'github'"},"connected":{"type":"boolean","description":"true if connected to this provider"}}},"ResourceFileLocaleEntry":{"type":"object","description":"A resource container per language entry having additional status information","properties":{"name":{"type":"string"},"languageCode":{"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)."},"mimeType":{"type":"string"},"statuses":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"segmentsUpdatedAt":{"type":"string","format":"date-time"},"failingLingochecksCount":{"type":"integer","format":"int32"}}},"V1ExportFormat":{"type":"object","description":"Names a possible export format. eg. 'properties.java', 'yaml.rails'","properties":{"id":{"type":"string","description":"eg. 'properties.java'"},"name":{"type":"string","description":"eg. 'Java Properties'"}}},"V1ResourceFileEntry":{"type":"object","description":"A resource container representing a logical group of locale-specific files sharing the same base name and path pattern.","properties":{"uuid":{"type":"string","description":"The unique identifier of the resource container.","example":"rc_1234567890abcdef"},"basename":{"type":"string","description":"The basename of the resource file (without language suffix and extension).","example":"messages"},"filePathWithLocalePlaceholder":{"type":"string","description":"The unique file path pattern for this container, with a locale placeholder.","example":"config/locales/%{locale}/messages.yml"},"files":{"type":"array","description":"The list of locale-specific files belonging to this resource container, including per-file translation status.","items":{"$ref":"#/components/schemas/ResourceFileLocaleEntry"}}}},"HtmlEncoding":{"type":"string","enum":["RAW","ESCAPE","CDATA"]},"LocaleInFileName":{"type":"string","enum":["ALL","TARGETS","NONE"]},"ResourceInfo":{"type":"object","description":"Information about a single resource file within a project, including its locale and HATEOAS links.","properties":{"name":{"type":"string","description":"The name of the resource file including its extension.","example":"messages_en.properties"},"links":{"type":"array","description":"HATEOAS links for the resource (e.g. self, download).","items":{"$ref":"#/components/schemas/Link"}},"project_locale":{"type":"string","description":"The locale (language code) of the resource file.","example":"en"}}},"ResourceInfoList":{"type":"object","description":"A list of resource files belonging to a project, with HATEOAS navigation links.","properties":{"members":{"type":"array","description":"The list of resource files in the project.","items":{"$ref":"#/components/schemas/ResourceInfo"}},"links":{"type":"array","description":"HATEOAS links for navigating the resource list (e.g. self).","items":{"$ref":"#/components/schemas/Link"}}}},"PageResponseV1ContextImageResponse":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/V1ContextImageResponse"}},"contentSize":{"type":"integer","format":"int32"},"empty":{"type":"boolean"},"first":{"type":"boolean"},"last":{"type":"boolean"},"next":{"type":"boolean"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalPages":{"type":["integer","null"],"format":"int32"},"totalElements":{"type":["integer","null"],"format":"int64"}},"required":["content","contentSize","empty","first","last","next","pageNumber","pageSize","totalElements","totalPages"]},"ProjectStatus":{"type":"object","description":"Translation status overview for a project, including per-locale segment counts by status.","properties":{"title":{"type":"string","description":"The title of the project.","example":"My Mobile App"},"url":{"type":"string","description":"The URL-friendly slug of the project.","example":"my-mobile-app"},"totalCount":{"type":"integer","format":"int32","description":"The total number of translatable text segments in the project.","example":1250},"status":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"description":"The translation status breakdown per locale. Each locale maps segment statuses (e.g. TRANSLATED, UNTRANSLATED, UNVERIFIED) to their respective counts."}}},"ProjectList":{"type":"object","description":"A paginated list of projects within a workspace, with HATEOAS navigation links.","properties":{"members":{"type":"array","description":"The list of projects in the workspace.","items":{"$ref":"#/components/schemas/ProjectListItem"}},"links":{"type":"array","description":"HATEOAS links for navigating the project list (e.g. self, next, prev).","items":{"$ref":"#/components/schemas/Link"}}}},"ProjectListItem":{"type":"object","description":"Summary information for a single project in a list response.","properties":{"title":{"type":"string","description":"The title of the project.","example":"My Mobile App"},"links":{"type":"array","description":"HATEOAS links for the project (e.g. self link to project details).","items":{"$ref":"#/components/schemas/Link"}}}}},"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"}}}}