{"openapi":"3.0.3","info":{"title":"1Ci CAT Public API","version":"1.0.0","description":"Публичный REST API для работы с проектами перевода, файлами и задачами перевода в 1Ci CAT.\n"},"servers":[{"url":"https://api.example.com/api/v1","description":"Production"}],"security":[{"bearerAuth":[]}],"tags":[{"name":"Projects"},{"name":"Files"},{"name":"TranslationJobs"},{"name":"Downloads"},{"name":"Glossaries"},{"name":"TranslationMemories"},{"name":"Reports"}],"paths":{"/projects":{"get":{"tags":["Projects"],"summary":"Получить список проектов","operationId":"listProjects","responses":{"200":{"description":"Список проектов","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectListResponse"}}}}}},"post":{"tags":["Projects"],"summary":"Создать проект","operationId":"createProject","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectCreateRequest"}}}},"responses":{"201":{"description":"Проект создан","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectResponse"}}}}}}},"/projects/{projectId}":{"get":{"tags":["Projects"],"summary":"Получить проект","operationId":"getProject","parameters":[{"$ref":"#/components/parameters/ProjectId"}],"responses":{"200":{"description":"Данные проекта","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectResponse"}}}}}},"patch":{"tags":["Projects"],"summary":"Обновить проект","operationId":"updateProject","parameters":[{"$ref":"#/components/parameters/ProjectId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectUpdateRequest"}}}},"responses":{"200":{"description":"Проект обновлен","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectResponse"}}}}}},"delete":{"tags":["Projects"],"summary":"Удалить проект","operationId":"deleteProject","parameters":[{"$ref":"#/components/parameters/ProjectId"}],"responses":{"204":{"description":"Проект удален"}}}},"/projects/{projectId}/files":{"get":{"tags":["Files"],"summary":"Получить список файлов проекта","operationId":"listProjectFiles","parameters":[{"$ref":"#/components/parameters/ProjectId"}],"responses":{"200":{"description":"Список файлов","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileListResponse"}}}}}},"post":{"tags":["Files"],"summary":"Загрузить файл в проект","operationId":"uploadProjectFile","parameters":[{"$ref":"#/components/parameters/ProjectId"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}}},"responses":{"202":{"description":"Файл принят в обработку","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobResponse"}}}}}}},"/projects/{projectId}/files/{fileId}":{"get":{"tags":["Files"],"summary":"Получить информацию о файле","operationId":"getProjectFile","parameters":[{"$ref":"#/components/parameters/ProjectId"},{"$ref":"#/components/parameters/FileId"}],"responses":{"200":{"description":"Данные файла","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileResponse"}}}}}},"delete":{"tags":["Files"],"summary":"Удалить файл из проекта","operationId":"deleteProjectFile","parameters":[{"$ref":"#/components/parameters/ProjectId"},{"$ref":"#/components/parameters/FileId"}],"responses":{"204":{"description":"Файл удален"}}}},"/projects/{projectId}/translation-jobs/llm":{"post":{"tags":["TranslationJobs"],"summary":"Запустить LLM-перевод","operationId":"startLlmTranslationJob","parameters":[{"$ref":"#/components/parameters/ProjectId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LlmTranslationJobCreateRequest"}}}},"responses":{"202":{"description":"Задача перевода создана","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobResponse"}}}}}}},"/projects/{projectId}/translation-jobs/pretranslate":{"post":{"tags":["TranslationJobs"],"summary":"Запустить pretranslate","operationId":"startPretranslateJob","parameters":[{"$ref":"#/components/parameters/ProjectId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PretranslateJobCreateRequest"}}}},"responses":{"202":{"description":"Задача pretranslate создана","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobResponse"}}}}}}},"/translation-jobs/{jobId}":{"get":{"tags":["TranslationJobs"],"summary":"Получить статус задачи","operationId":"getTranslationJob","parameters":[{"$ref":"#/components/parameters/JobId"}],"responses":{"200":{"description":"Статус задачи","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobResponse"}}}}}}},"/projects/{projectId}/downloads/translations":{"post":{"tags":["Downloads"],"summary":"Запустить выгрузку перевода","operationId":"exportProjectTranslations","parameters":[{"$ref":"#/components/parameters/ProjectId"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranslationExportRequest"}}}},"responses":{"202":{"description":"Задача выгрузки создана","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobResponse"}}}}}}},"/projects/{projectId}/glossaries":{"get":{"tags":["Glossaries"],"summary":"Получить глоссарии проекта","operationId":"listProjectGlossaries","parameters":[{"$ref":"#/components/parameters/ProjectId"}],"responses":{"200":{"description":"Список глоссариев","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlossaryListResponse"}}}}}},"post":{"tags":["Glossaries"],"summary":"Привязать глоссарий к проекту","operationId":"attachProjectGlossary","parameters":[{"$ref":"#/components/parameters/ProjectId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectGlossaryAttachRequest"}}}},"responses":{"204":{"description":"Глоссарий привязан"}}}},"/projects/{projectId}/translation-memories":{"get":{"tags":["TranslationMemories"],"summary":"Получить ТМ проекта","operationId":"listProjectTms","parameters":[{"$ref":"#/components/parameters/ProjectId"}],"responses":{"200":{"description":"Список ТМ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TmListResponse"}}}}}},"post":{"tags":["TranslationMemories"],"summary":"Привязать ТМ к проекту","operationId":"attachProjectTm","parameters":[{"$ref":"#/components/parameters/ProjectId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectTmAttachRequest"}}}},"responses":{"204":{"description":"ТМ привязана"}}}},"/projects/{projectId}/reports":{"get":{"tags":["Reports"],"summary":"Получить список отчетов проекта","operationId":"listProjectReports","parameters":[{"$ref":"#/components/parameters/ProjectId"}],"responses":{"200":{"description":"Список отчетов","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportListResponse"}}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"APIKey"}},"parameters":{"ProjectId":{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},"FileId":{"name":"fileId","in":"path","required":true,"schema":{"type":"string"}},"JobId":{"name":"jobId","in":"path","required":true,"schema":{"type":"string"}}},"schemas":{"ErrorObject":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"integer"}}},"Project":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"sourceLanguage":{"type":"string"},"targetLanguages":{"type":"array","items":{"type":"string"}},"status":{"type":"string"}}},"ProjectResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Project"}}},"ProjectListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Project"}}}},"ProjectCreateRequest":{"type":"object","required":["name","sourceLanguage","targetLanguages"],"properties":{"name":{"type":"string"},"sourceLanguage":{"type":"string"},"targetLanguages":{"type":"array","items":{"type":"string"}},"workflow":{"type":"array","items":{"type":"string"}}}},"ProjectUpdateRequest":{"type":"object","properties":{"name":{"type":"string"}}},"File":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"status":{"type":"string"}}},"FileResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/File"}}},"FileListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/File"}}}},"FileUploadRequest":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}},"Job":{"type":"object","properties":{"jobId":{"type":"string"},"status":{"type":"string"},"progress":{"type":"integer","example":0}}},"JobResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Job"}}},"LlmTranslationJobCreateRequest":{"type":"object","required":["providerId","modelId"],"properties":{"providerId":{"type":"string"},"modelId":{"type":"string"},"promptId":{"type":"string"},"targetLanguage":{"type":"string"},"fileIds":{"type":"array","items":{"type":"string"}}}},"PretranslateJobCreateRequest":{"type":"object","properties":{"translationMemoryId":{"type":"string"},"targetLanguage":{"type":"string"},"fileIds":{"type":"array","items":{"type":"string"}},"workflowStep":{"type":"string"}}},"TranslationExportRequest":{"type":"object","properties":{"targetLanguage":{"type":"string"},"fileIds":{"type":"array","items":{"type":"string"}},"format":{"type":"string","example":"original"}}},"Glossary":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"GlossaryListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Glossary"}}}},"ProjectGlossaryAttachRequest":{"type":"object","required":["glossaryId"],"properties":{"glossaryId":{"type":"string"}}},"TranslationMemory":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"TmListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TranslationMemory"}}}},"ProjectTmAttachRequest":{"type":"object","required":["translationMemoryId"],"properties":{"translationMemoryId":{"type":"string"}}},"Report":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"status":{"type":"string"}}},"ReportListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Report"}}}}}}}