Документация API Orkas
Подключите чат, поиск, речь, изображения и видео Orkas к своим инструментам. Начните с раздела «Чат»: там указаны базовый URL, API-ключ и названия моделей, используемые большинством ИИ-приложений.
Чат
Используйте совместимый с OpenAI формат Chat Completions в ИИ-приложениях, инструментах командной строки или собственном сервисе.
Настройки подключения
Если приложение запрашивает базовый URL, API-ключ и модель, введите следующие значения.
| Настройка | Значение | Описание |
|---|---|---|
Base URL | https://orkas.ai/v1 | Используйте этот адрес для совместимого с OpenAI сервиса. |
API Key | Создать ключ в разделе «Аккаунт» | Вставьте ключ в поле API-ключа приложения. |
model | orkas-llm-1.5Рекомендуется | Лучше всего подходит для повседневных вопросов и ответов, написания текстов и офисной работы. Включает DeepSeek V4.1 Flash · GPT-6 Luna · Claude-Sonnet-5 · Gemini-3.8 Flash. |
orkas-llm-1.5-pro | Лучше всего подходит для исследований, видео, R&D и других сложных задач. Включает GPT-6 Sol · Claude Opus 5.5 · Kimi K3. |
Создать ответ в чате
Эндпоинт
https://orkas.ai/v1/chat/completionsАутентификация
Authorization: Bearer $ORKAS_API_KEYПараметры тела запроса
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
model | string | Да | orkas-llm-1.5 или orkas-llm-1.5-pro. |
messages | array | Да | Сообщения беседы. Каждый элемент содержит role и content. |
stream | boolean | Нет | Возвращать потоковый ответ при true. По умолчанию: false. |
Пример запроса
curl https://orkas.ai/v1/chat/completions \
-H "Authorization: Bearer $ORKAS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "orkas-llm-1.5",
"messages": [{"role": "user", "content": "Hello"}]
}'Расход кредитов
| Тарифицируемая операция | Списание кредитов | Единица тарификации |
|---|---|---|
orkas-llm-1.5 | Ввод 20–280; чтение кэша 2–28; создание кэша 25–350; вывод 120–1260 | За 1M токенов; точный тариф зависит от запроса. |
orkas-llm-1.5-pro | Ввод 140–1000; чтение кэша 14–100; создание кэша 175–1250; вывод 840–4500 | За 1M токенов; точный тариф зависит от запроса. |
Поиск
Искать в интернете и возвращать краткий список релевантных результатов для вашего приложения.
Поиск в интернете
Эндпоинт
https://orkas.ai/v1/searchАутентификация
Authorization: Bearer $ORKAS_API_KEYПараметры тела запроса
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
query | string | Да | Текст поискового запроса, до 2000 символов. |
max_results | integer | Нет | Количество результатов: 1–20. По умолчанию: 8. |
Пример запроса
curl https://orkas.ai/v1/search \
-H "Authorization: Bearer $ORKAS_API_KEY" \
-H "Content-Type: application/json" \
-d '{"query":"latest battery research","max_results":8}'Расход кредитов
| Тарифицируемая операция | Списание кредитов | Единица тарификации |
|---|---|---|
| Поиск в интернете | 5.6 | За запрос, до 20 результатов. |
Речь
Превратите текст в аудиофайл. Выберите ID голоса из списка ниже и нужный аудиоформат.
Список голосов
Эндпоинт
https://orkas.ai/v1/audio/voicesАутентификация
Authorization: Bearer $ORKAS_API_KEYПараметры запроса
У этого эндпоинта нет параметров запроса.
Пример запроса
curl https://orkas.ai/v1/audio/voices \
-H "Authorization: Bearer $ORKAS_API_KEY"Доступные ID голосов
| ID голоса | Название | Язык |
|---|---|---|
zh_female_vv_uranus_bigtts | vivi 2.0 | Китайский / английский |
saturn_zh_female_cancan_tob | 知性灿灿 | Китайский |
saturn_zh_female_keainvsheng_tob | 可爱女生 | Китайский |
saturn_zh_female_tiaopigongzhu_tob | 调皮公主 | Китайский |
saturn_zh_male_shuanglangshaonian_tob | 爽朗少年 | Китайский |
saturn_zh_male_tiancaitongzhuo_tob | 天才同桌 | Китайский |
zh_female_xiaohe_uranus_bigtts | 小何 | Китайский |
zh_male_m191_uranus_bigtts | 云舟 | Китайский |
zh_male_taocheng_uranus_bigtts | 小天 | Китайский |
en_male_tim_uranus_bigtts | Tim | Английский |
en_female_dacey_uranus_bigtts | Dacey | Английский |
en_female_stokie_uranus_bigtts | Stokie | Английский |
Синтезировать речь
Эндпоинт
https://orkas.ai/v1/audio/speechАутентификация
Authorization: Bearer $ORKAS_API_KEYПараметры тела запроса
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
model | string | Да | Используйте orkas-tts-1. |
input | string | Да | Текст для синтеза, до 16384 байт UTF-8. |
voice | string | Да | ID голоса из списка выше. |
language | string | Нет | Язык озвучки, например zh-CN или en. Выбранный голос должен его поддерживать; иначе используется язык голоса по умолчанию. |
response_format | string | Нет | mp3, wav, opus или ogg. По умолчанию: mp3. |
speed | number | Нет | Скорость речи от 0.5 до 2.0. По умолчанию: 1.0. |
Пример запроса
curl https://orkas.ai/v1/audio/speech \
-H "Authorization: Bearer $ORKAS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model":"orkas-tts-1",
"input":"你好,欢迎使用 Orkas。",
"voice":"zh_female_vv_uranus_bigtts",
"language":"zh-CN",
"response_format":"mp3",
"speed":1.0
}' --output speech.mp3Расход кредитов
| Тарифицируемая операция | Списание кредитов | Единица тарификации |
|---|---|---|
| Список голосов | 0 | За запрос |
| Синтезировать речь | 0.125 | За расчётную секунду результата, с округлением вверх минимум до одной секунды. |
Изображения
Создайте изображение по описанию или предоставьте исходные изображения для редактирования. На каждый запрос возвращается одно изображение.
Создать изображение
Эндпоинт
https://orkas.ai/v1/images/generationsАутентификация
Authorization: Bearer $ORKAS_API_KEYПараметры тела запроса
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
prompt | string | Да | Описание изображения, до 20000 символов. |
size | string | Нет | 2k, 3k, 4k или поддерживаемое значение ширина×высота. По умолчанию: 2k. |
response_format | string | Нет | url или b64_json. По умолчанию: b64_json. |
reference_images | array | Нет | До четырёх HTTPS URL или поддерживаемых data URL изображений для редактирования. |
async | boolean | Нет | Возвращать ID задачи при true. Рекомендуется, чтобы избежать тайм-аутов запросов. По умолчанию: false. |
Пример запроса
curl https://orkas.ai/v1/images/generations \
-H "Authorization: Bearer $ORKAS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"prompt":"A product photo on a clean studio background",
"size":"2k",
"response_format":"url",
"async":true
}'"async": true. API возвращает id задачи; обращайтесь к URL статуса, пока результат не будет готов.Проверить статус генерации
Эндпоинт
https://orkas.ai/v1/images/generations/{id}Аутентификация
Authorization: Bearer $ORKAS_API_KEYПараметры пути
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
id | string | Да | ID задачи, возвращённый запросом на создание. |
Пример запроса
curl https://orkas.ai/v1/images/generations/$TASK_ID \
-H "Authorization: Bearer $ORKAS_API_KEY"Расход кредитов
| Тарифицируемая операция | Списание кредитов | Единица тарификации |
|---|---|---|
| Создать изображение | 22 | За созданное изображение |
| Проверить статус генерации | 0 | За запрос |
Видео
Создайте видео по тексту или исходным медиа. Видеозапросы выполняются асинхронно, поэтому для проверки хода выполнения используйте возвращённый ID задачи.
Создать видео
Эндпоинт
https://orkas.ai/v1/videosАутентификация
Authorization: Bearer $ORKAS_API_KEYПараметры тела запроса
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
prompt | string | Да | Описание видео для создания или редактирования. |
duration | integer | Нет | 4–15 секунд. По умолчанию: 5. |
resolution | string | Нет | 480p, 720p или 1080p. По умолчанию: 720p. |
quality | string | Нет | balanced обеспечивает баланс скорости и расхода кредитов; quality отдаёт приоритет качеству и стабильности генерации. По умолчанию: balanced. Orkas по-прежнему автоматически выбирает совместимую видеомодель. |
ratio | string | Нет | 16:9, 9:16, 1:1, 4:3, 3:4 или 21:9. По умолчанию: 16:9. |
generate_audio | boolean | Нет | Создавать звук для видео. По умолчанию: true. |
reference_image_urls | array | Нет | До девяти общедоступных HTTPS URL изображений. |
reference_video_urls | array | Нет | До трёх общедоступных HTTPS URL видео. |
operation | string | Нет | generate или edit. Для редактирования требуется хотя бы одно исходное видео. По умолчанию: generate. |
seed | integer | Нет | Необязательное начальное значение для воспроизводимой генерации. |
Пример запроса
curl https://orkas.ai/v1/videos \
-H "Authorization: Bearer $ORKAS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"prompt":"Camera circles a ceramic lamp in a dark studio",
"duration":5,
"resolution":"720p",
"quality":"balanced",
"ratio":"16:9",
"generate_audio":true
}'Проверить статус видео
Эндпоинт
https://orkas.ai/v1/videos/{id}Аутентификация
Authorization: Bearer $ORKAS_API_KEYПараметры пути
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
id | string | Да | ID задачи, возвращённый запросом на создание. |
Пример запроса
curl https://orkas.ai/v1/videos/$TASK_ID \
-H "Authorization: Bearer $ORKAS_API_KEY"Расход кредитов
| Тарифицируемая операция | Списание кредитов | Единица тарификации |
|---|---|---|
balanced · Видео из текста или изображения · 480p | 37 | За секунду результата |
balanced · Видео из текста или изображения · 720p | 80 | За секунду результата |
balanced · Видео из текста или изображения · 1080p | 248 | За секунду результата |
quality · Видео из текста или изображения · 480p | 46 | За секунду результата |
quality · Видео из текста или изображения · 720p | 100 | За секунду результата |
quality · Видео из текста или изображения · 1080p | 248 | За секунду результата |
balanced / quality · Редактирование видео или генерация по исходному видео · 480p | 51 | За секунду результата |
balanced / quality · Редактирование видео или генерация по исходному видео · 720p | 109 | За секунду результата |
balanced / quality · Редактирование видео или генерация по исходному видео · 1080p | 271 | За секунду результата |
| Проверить статус видео | 0 | За запрос |
Безопасность и ограничения
Храните API-ключи в тайне, используйте отдельные ключи для разных приложений и немедленно удаляйте ключ при подозрении на утечку.
- Передавайте ключ в заголовке запроса
Authorization: Bearer sk-orkas-…. - Чтобы сгруппировать расход кредитов одной беседы, передавайте один и тот же непрозрачный ID в
X-Orkas-Conversation-Idеё запросов. Используйте только буквы, цифры,-или_(до 64 символов); не передавайте заголовок или содержимое сообщений. - Не размещайте ключ в коде браузерного или мобильного приложения, URL, журналах или системе контроля версий.
- Создавайте отдельный ключ для каждого приложения, чтобы его можно было заменить, не затрагивая другие сервисы.
- Лимиты на один ключ: 120 запросов/мин для чата и поиска, 60 для речи, 30 запросов изображений и 10 видеозапросов. Для проверки статуса разрешено 120 запросов/мин.
- При слишком частых запросах API возвращает HTTP 429. Немного подождите перед повторной попыткой.
История кредитов
Использование API отмечается отдельно в истории кредитов Orkas Web, чтобы его можно было отличить от использования в Orkas.