Документация API biglink
Интегрируйте возможности перевода biglink в ваши приложения.
Введение
API biglink позволяет автоматизировать перевод ваших проектов, управлять файлами, глоссариями и настройками программно. Он предоставляет RESTful интерфейс для бесшовной интеграции с вашими CI/CD пайплайнами или пользовательскими рабочими процессами.
Аутентификация
Для аутентификации запросов к API используйте Bearer токен с вашим API ключом в заголовке Authorization.
Пример запроса
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://app.bigl.ink/api/v1/authХраните ваш API ключ в секрете! Не передавайте его в клиентский код.
Проекты
Эндпоинты для управления вашими проектами.
Получить список проектов
Возвращает список всех ваших проектов.
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://app.bigl.ink/api/v1/projectsResponse
{
"projects": [
{
"id": "60c72b2f9e7d4b2e1c8b4567",
"name": "Technical Documentation",
"sourceLanguage": "en",
"targetLanguages": ["ru", "fr", "de"],
"isOneTimeTranslation": false,
"createdAt": "2025-05-01T10:30:00.000Z",
"updatedAt": "2025-05-01T10:30:00.000Z",
"filesCount": 3
},
{
"id": "60c72b2f9e7d4b2e1c8b4568",
"name": "Quick Translation",
"sourceLanguage": "en",
"targetLanguages": ["ru"],
"isOneTimeTranslation": true,
"createdAt": "2025-05-01T11:45:00.000Z",
"updatedAt": "2025-05-01T11:45:00.000Z",
"filesCount": 1
}
]
}Файлы
Эндпоинты для управления файлами внутри проектов.
Загрузить файл
Загружает файл в указанный проект.
curl -X POST \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "file=@/path/to/document.docx" \
https://app.bigl.ink/api/v1/projects/60c72b2f9e7d4b2e1c8b4567/filesResponse
{
"message": "Файл успешно загружен",
"file": {
"id": "71d83c3f0e8d5b3f2d9c5678",
"name": "document.docx",
"size": 10240,
"status": "uploaded",
"uploadedAt": "2025-05-03T09:15:00.000Z"
}
}Перевод
Эндпоинты для запуска и управления процессом перевода.
Перевести файл
Запускает задачу перевода для конкретного файла на указанный язык.
curl -X POST \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"targetLanguage":"ru"}' \
https://app.bigl.ink/api/v1/files/71d83c3f0e8d5b3f2d9c5678/translateГлоссарии
Управление терминологией для обеспечения единообразия перевода.
Список глоссариев
Получить список всех ваших глоссариев.
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://app.bigl.ink/api/v1/glossariesResponse
{
"glossaries": [
{
"id": "82e...",
"name": "Technical Terms",
"sourceLanguage": "en",
"targetLanguages": ["ru"],
"termsCount": 150
}
]
}Стоп-слова
Управление словами, которые следует игнорировать при извлечении.
Список стоп-слов
Получить все ваши списки стоп-слов.
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://app.bigl.ink/api/v1/stop-words-listsResponse
{
"lists": [
{
"id": "93f...",
"name": "Common Stopwords",
"language": "en",
"wordsCount": 42
}
]
}AI Модели
Список доступных AI моделей для перевода.
Список моделей
Получить список поддерживаемых AI моделей.
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://app.bigl.ink/api/v1/ai-modelsResponse
{
"models": [
{
"id": "gpt-4",
"name": "GPT-4",
"provider": "openai",
"maxChunkSize": 4000
}
]
}Шаблоны промптов
Используйте переменные для создания составных промптов.
Переменные шаблона
System Prompt
{{SOURCE_LANG}}- Исходный язык{{TARGET_LANG}}- Целевой язык
User Prompt
{{SEGMENTS}}- Сегменты для перевода (Основной контент){{FILE_HEADER}}- Заголовок/Контекст файла{{CHUNK_PROMPT}}- Промпт чанка (если есть)
Segment Format
{{ID}}- ID сегмента{{TEXT}}- Текст сегмента{{CONTEXT}}- Контекст сегмента
Пример составного промпта
You are a professional translator. Translate from {{SOURCE_LANG}} to {{TARGET_LANG}}.{{FILE_HEADER}}Translate the following segments:{{SEGMENTS}}#@{{ID}} {{CONTEXT}}{{TEXT}}Поддерживаемые языки
Список языков, поддерживаемых для перевода.
Лимиты запросов
Для обеспечения стабильности работы API действуют следующие лимиты запросов
| Эндпоинт | Лимит | Окно |
|---|---|---|
| Global | 1000 | Минута |
| Translation | 50 | Минута |
При превышении лимита API вернет ошибку 429 Too Many Requests.
SDK и библиотеки
Для упрощения интеграции вы можете использовать наши официальные SDK
Node.js SDK
Установите через npm и начните интеграцию.
Python SDK
Установите через pip и начните интеграцию.
Приложение
Справочник значений полей и перечислений.
Стратегия URL
| Value | Description |
|---|---|
| preserve | Keep URLs as is, do not modification. |
| translate | Translate the URL segments to the target language. |
| transliterate | Transliterate the URL segments (e.g. Cyrillic to Latin). |
AI Провайдер
| Value | Description |
|---|---|
| openai | OpenAI (GPT-4o, GPT-4, etc.) |
| anthropic | Anthropic (Claude 3.5 Sonnet, etc.) |
| custom | Custom provider via compatible API. |
Перевод HTML в JSON/CSV
| Value | Description |
|---|---|
| no | Нет |
| use_adapter | Использовать настройки адаптера |
| greedy | Жадный |
Настройки проекта
| Настройка | Тип | По умолчанию | Параметры конфигурации для проектов перевода. |
|---|---|---|---|
| type | enum | long-term | Определяет рабочий процесс перевода и политику хранения.
|
| status | enum | active | Текущее состояние жизненного цикла проекта.
|
| urlStrategy | enum | preserve | Как обрабатываются URL-адреса в контенте.
|
Настройки файлов
Опции и статусы для отдельных файлов.
| Настройка | Тип | По умолчанию | Параметры конфигурации для проектов перевода. |
|---|---|---|---|
| type | enum | json | Поддерживаемые форматы файлов. json, html, csv, xml, txt, xlsx, yaml, yml, properties, po, md |
| status | enum | uploaded | Текущее состояние обработки.
|
| promptStrategy | enum | combine | Область контекста для промптов ИИ.
|
Настройки ИИ Модели
Конфигурация для провайдеров ИИ.
| Настройка | Тип | По умолчанию | Параметры конфигурации для проектов перевода. |
|---|---|---|---|
| provider | enum | openai | Сервис-провайдер ИИ. openai, anthropic, google, custom |
| authType | enum | bearer | Метод авторизации для API модели.
|
| responseSpeed | enum | medium | Категория ожидаемой задержки. slow (медленно), medium (средне), fast (быстро) |
Пользователь и Аккаунт
Профиль пользователя и настройки аккаунта.
| Настройка | Тип | По умолчанию | Параметры конфигурации для проектов перевода. |
|---|---|---|---|
| role | enum | user | Уровень прав пользователя.
|
| theme | enum | auto | Тема интерфейса. light (светлая), dark (темная), auto (авто) |
| createdVia | enum | public | Как был создан аккаунт. public (самостоятельная регистрация), admin (создан вручную) |
Биллинг и Транзакции
Финансовые сущности и статусы.
| Настройка | Тип | По умолчанию | Параметры конфигурации для проектов перевода. |
|---|---|---|---|
| transactionType | enum | - | Характер финансовой записи. deposit, withdrawal, storage_fee, translation_fee, referral_payout, promo_bonus, initial_balance |
| transactionStatus | enum | pending | Состояние транзакции. pending (ожидание), completed (завершено), failed (ошибка), reverted (отменено) |
| promoCodeType | enum | discount | Категория рекламного предложения.
|
Поддержка
Тикет-система.
| Настройка | Тип | По умолчанию | Параметры конфигурации для проектов перевода. |
|---|---|---|---|
| status | enum | доставлено | Текущее состояние тикета.
|
| sender | enum | user | Автор сообщения. user (пользователь), admin (администратор) |
Ресурсы
Ресурсы перевода и шаблоны.
| Настройка | Тип | По умолчанию | Параметры конфигурации для проектов перевода. |
|---|---|---|---|
| promptTemplateType | enum | standard | Логический поток для шаблона. standard, verification, url, raw |
| promptTemplateCategory | enum | general | Организационная категория. general, literature, technical, verification, url, other |
| glossarySharing | enum | Private | Опции видимости. Private (Личный), Public (Публичный по ссылке) |
Настройки Адаптеров
CSV Адаптер
| Настройка | Тип | По умолчанию | Детальная конфигурация парсеров. |
|---|---|---|---|
| delimiter | string | , | Разделитель полей. |
| quoteChar | string | " | Символ кавычек. |
| escapeChar | string | " | Символ экранирования. |
| ignoreColumns | string[] | [] | Список колонок для пропуска. |
| translateColumns | string[] | [] | Только указанные колонки. |
| urlColumns | string[] | [] | Колонки с ссылками. |
| setColumns | string[] | false | Определить колонки вручную. |
| setDelimiters | object | false | Определить разделители вручную. |
| consistentColumns | string[] | null | true | Проверять кол-во колонок в строках. |
| translateHeaders | boolean | false | Переводить первую строку. |
| translateHtmlContent | boolean | true | Парсить HTML внутри ячеек. |
| translateJsonContent | boolean | false | Парсить JSON внутри ячеек. |
| ignoreRows | number[] | [] | Индексы строк для пропуска. |
| translateRows | number[] | [] | Только указанные строки (пусто=все). |
| urlStrategy | enum | preserve | Как обрабатывать ссылки. |