Что такое API epicai
Адрес, по которому ваша программа обращается к нейросетям epicai (текстовым, картинкам, видео, музыке, озвучке и документам). Баланс общий с сайтом.
Что делает API
API (программный интерфейс) передаёт запросы к моделям из вашей программы, например из скрипта, бота или сервиса. Адрес API epicai — https://epicai.ru/v1. Текстовые модели работают по протоколу Chat Completions от OpenAI, поэтому готовые библиотеки и программы с поддержкой OpenAI работают после замены адреса и ключа (подробнее о готовых клиентах). Картинки, видео, музыка, озвучка, расшифровка речи и документы запускаются задачами (как они устроены).
Ключ API — длинная строка вида sk-epic-…, по которой epicai узнаёт, от чьего аккаунта пришёл запрос. Где его взять, описано в статье Ключ API, а первый запрос ждёт вас в быстром старте.
Какие адреса есть сейчас
| Метод и адрес | Что делает | Ключ |
|---|---|---|
GET /v1/ | Отдаёт описание сервиса и ссылки на справочник | не нужен |
GET /v1/openapi.json | Отдаёт спецификацию OpenAPI для генераторов кода и справочников | не нужен |
GET /v1/models | Список моделей всех видов с ценами и возможностями | нужен |
GET /v1/models/{id} | Одна модель из этого списка, у нетекстовых с параметрами и входными файлами | нужен |
POST /v1/chat/completions | Запрос к текстовой модели, обычный или потоковый | нужен |
POST /v1/tasks | Создать задачу на картинку, видео, музыку, озвучку, расшифровку или документ | нужен |
GET /v1/tasks | Список ваших задач | нужен |
GET /v1/tasks/{id} | Состояние и результат задачи | нужен |
POST /v1/quote | Цена задачи без запуска | нужен |
POST /v1/images/generations | Картинка в форме OpenAI | нужен |
POST /v1/audio/speech | Озвучка текста в форме OpenAI | нужен |
POST /v1/audio/transcriptions | Расшифровка речи в форме OpenAI | нужен |
GET /v1/account | Баланс и состояние ключа | нужен |
GET /v1/usage | Расход за период по дням, моделям или ключам | нужен |
Любой другой адрес отвечает ошибкой 404 not_found. Описание всех полей открыто на странице справочника для разработчиков.
Какие нейросети доступны
Текстовый чат принимает сообщения, картинки на входе, вызов функций, потоковый ответ и JSON-режим. Остальные нейросети сайта запускаются задачами. Это картинки (в том числе Midjourney), видео, музыка, озвучка, расшифровка речи и документы. Результат задачи приходит ссылками на файлы, а о готовности программу может известить вебхук.
Эмбеддингов в API нет. Инструменты чата на сайте (веб-поиск, поиск по файлам, память диалога, подключения) в API тоже не включены, поэтому такие функции вы подключаете в своей программе сами. Ограничения отдельных нейросетей описаны в статьях про картинки, видео, музыку, озвучку и документы.
Что общего с сайтом
Баланс один. Токены, которые вы покупаете на сайте, тратятся и на запросы из чата, и на запросы по ключу. Цены берутся из каталога (как их читать, объясняет статья Модели и цены в API), а ценовые акции на модель действуют и в API. Список текстовых моделей короче, чем в чате: бесплатных и служебных моделей в нём нет. Новые модели сайта появляются в списке сами.
Токены модели и токены epicai
Слово «токены» в документации API означает две разные вещи. Токены модели — куски текста, на которые модель разбивает запрос и ответ, их считают поля usage. Токены epicai лежат на балансе и пишутся как TOK, в них выражена цена. Список моделей сообщает, сколько TOK стоит миллион токенов модели, а ответ на каждый запрос показывает, сколько TOK списано. Как это складывается в итоговую сумму, разбирает статья Баланс и списание в API.
Не нашли ответ?
Посмотрите частые вопросы или напишите в поддержку.