{"openapi":"3.0.0","info":{"title":"Linguistic Quality Assurance (LQA) Application API","description":"API methods of this application cannot be called directly. Instead, you should trigger Crowdin's platform API endpoint, Crowdin will authorize your request and route it to this app.\n\nExample call for crowdin.com \n\n    curl --request GET \n    --url \"https://crowdin.com/api/v2/applications/lqa/api/data?report=raw&projects=479\" \n    --header \"Authorization: Bearer 70cf05deasdas78c84c73c4cf986ee0a3ee911w1dsad384e3c4asd1qdbbcf6b6db5732e\" \nExample call for Crowdin Enterprise \n\n    curl --request GET \n    --url \"https://acme.crowdin.com/api/v2/applications/lqa/api/data?report=raw&projects=479&startDate=2023-06-01T06%3A32%3A01.048Z&endDate=2023-06-23T06%3A32%3A01.048Z\" \n    --header \"Authorization: Bearer 70cf05dee35sad12rfes0a3ee911462e7b0723rfdfrg1e45bbcf6b6db5732e\" \n","version":"1.0.0","x-logo":{"url":"https://support.crowdin.com/assets/crowdin-logo.svg"}},"servers":[{"url":"{protocol}//{host}/api/v2/applications/lqa/api","variables":{"protocol":{"default":"https","enum":["https","http"],"description":"Protocol (https for production)"},"host":{"default":"crowdin.com","description":"Crowdin host (crowdin.com or {organization}.crowdin.com for Enterprise)"}}}],"paths":{"/api-projects":{"get":{"tags":["Projects"],"summary":"List projects","operationId":"projects.list","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":12345},"name":{"type":"string","example":"My Project"},"modelId":{"type":"integer","example":1},"modelName":{"type":"string","example":"TAUS Model"},"type":{"type":"string","example":"project"},"languages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"fr"},"name":{"type":"string","example":"French"},"active":{"type":"boolean","example":true}}}}}}}}}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"405":{"description":"Method Not Allowed"}}},"post":{"tags":["Projects"],"summary":"Add projects","operationId":"projects.add","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["projects"],"properties":{"projects":{"type":"array","items":{"type":"object","required":["id","modelId","type"],"properties":{"id":{"type":"integer","description":"Project ID","example":18},"modelId":{"type":"integer","description":"Model ID","example":4},"type":{"type":"string","enum":["model","star"],"example":"model"},"languages":{"type":"array","description":"Array of language IDs to be active. If not provided, all languages will be active","items":{"type":"string"},"example":["fr"]}}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"message":{"type":"string","example":"Projects added successfully"},"added":{"type":"array","items":{"type":"integer"},"example":[18]}}}}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"405":{"description":"Method Not Allowed"}}}},"/api-delete-project":{"delete":{"tags":["Projects"],"summary":"Delete project","operationId":"projects.delete","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["projectId"],"properties":{"projectId":{"type":"integer","example":12345}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Project Not Found"},"405":{"description":"Method Not Allowed"}}}},"/api-models":{"get":{"tags":["Models"],"summary":"List models","operationId":"models.list","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":4},"name":{"type":"string","example":"TAUS DQF-MQM"},"content":{"type":"object","properties":{"name":{"type":"string","example":"TAUS DQF-MQM"},"commentRequired":{"type":"boolean","example":true},"errorTolerance":{"type":"string","example":"1"},"penalties":{"type":"boolean","example":true},"translatorOpinion":{"type":"boolean","example":false},"secondReviewerOpinion":{"type":"boolean","example":true},"useAi":{"type":"boolean","example":false},"promptId":{"type":"string","example":null},"severity":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1},"sortOrder":{"type":"integer","example":1},"name":{"type":"string","example":"Critical"},"penalty":{"type":"integer","example":20}}}},"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Accuracy"},"entries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":11},"name":{"type":"string","example":"Addition"},"penalty":{"type":"integer","example":1}}}}}}}}}}}}}}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"405":{"description":"Method Not Allowed"}}},"post":{"tags":["Models"],"summary":"Add model","operationId":"models.add","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","content"],"properties":{"name":{"type":"string","example":"TAUS Model"},"content":{"type":"object","properties":{"commentRequired":{"type":"boolean","example":true},"penalties":{"type":"boolean","example":true},"severity":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Critical"},"penalty":{"type":"integer","example":30}}}},"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"Accuracy"},"entries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":11},"name":{"type":"string","example":"Addition"},"penalty":{"type":"integer","example":1}}}}}}}}}}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"message":{"type":"string","example":"Model added successfully"}}}}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"405":{"description":"Method Not Allowed"}}},"delete":{"tags":["Models"],"summary":"Delete model","operationId":"models.delete","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","example":1}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Model Not Found"},"405":{"description":"Method Not Allowed"}}}},"/api-templates":{"get":{"tags":["Templates"],"summary":"List templates","operationId":"templates.list","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string","example":"version-1.xlsx"}}}}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"405":{"description":"Method Not Allowed"}}},"delete":{"tags":["Templates"],"summary":"Delete template","operationId":"templates.delete","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["templateName"],"properties":{"templateName":{"type":"string","example":"template.xlsx"}}}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Template Not Found"},"405":{"description":"Method Not Allowed"}}}},"/api-reports":{"post":{"tags":["Reports"],"summary":"Generate report","operationId":"reports.generate","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["projectId","parameters"],"properties":{"projectId":{"type":"integer","description":"ID of the project to generate report for","example":12345},"templateName":{"type":"string","description":"Name of the template to use for the report","example":"template.xlsx"},"parameters":{"type":"object","required":["dateStart","dateEnd"],"properties":{"languages":{"type":"array","description":"Array of language IDs to include in the report. If not provided, all languages will be included","items":{"type":"string"},"example":["de","it"]},"translator":{"type":"array","description":"Array of translator IDs to include in the report. If not provided, all translators will be included","items":{"type":"string"},"example":["2","56"]},"files":{"type":"array","description":"Array of file IDs to include in the report","items":{"type":"string"},"example":["62537","63271"]},"labels":{"type":"array","description":"Array of label IDs to include in the report","items":{"type":"string"},"example":["2","4","8"]},"dateStart":{"type":"string","format":"date-time","description":"Start date for the report data","example":"2020-09-08 00:00:01"},"dateEnd":{"type":"string","format":"date-time","description":"End date for the report data","example":"2024-12-09 23:59:59"}}}}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"reportId":{"type":"string","example":"50fb3506-4127-4ba8-8296-f97dc7e3e0c3"}}}}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Project or Template Not Found"},"405":{"description":"Method Not Allowed"}}}},"/api-reports-status":{"get":{"tags":["Reports"],"summary":"Check report status","operationId":"reports.status","parameters":[{"name":"reportId","in":"query","required":true,"schema":{"type":"string","example":"50fb3506-4127-4ba8-8296-f97dc7e3e0c3"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"status":{"type":"string","enum":["inProgress","completed","failed"],"example":"completed"}}}}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Report Not Found"},"405":{"description":"Method Not Allowed"}}}},"/api-reports-download":{"get":{"tags":["Reports"],"summary":"Download report","operationId":"reports.download","parameters":[{"name":"reportId","in":"query","required":true,"schema":{"type":"string","example":"50fb3506-4127-4ba8-8296-f97dc7e3e0c3"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"downloadUrl":{"type":"string","example":"/api/reports/download-file/50fb3506-4127-4ba8-8296-f97dc7e3e0c3"}}}}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Report Not Found"},"405":{"description":"Method Not Allowed"}}}}},"components":{},"tags":[]}