Документация
Что такое ProxyAPI
ProxyAPI предоставляет доступ к API иностранных сервисов. В случаях, когда это возможно мы сохраняем оригинальные методы и параметры. Это делает возможным пользоваться официальной документацией и библиотеками.
Документация OpenAI API
Наши друзья из openai-docs перевели на русский язык (с помощью GPT-4) и опубликовали документацию по OpenAI API.
OpenAI-Docs - документация OpenAI API на русском языке.
Доступные провайдеры и модели
| Провайдер | Модель | Поддержка |
|---|---|---|
| OpenAI | GPT-4-Turbo (128K context) с поддержкой vision | |
| GPT-4 (8K context) | ||
| GPT-3.5 Turbo (16K context) | ||
| GPT-3.5 Turbo (4K context) | ||
| Ada v2 (embeddings) | ||
| DALL-E 2 | ||
| DALL-E 3 | ||
| Whisper преобразование аудио в текст В соответствии с Условиями использования необходимо предупреждать конечных пользователей о том, что для генерации голоса использовалась технология искусственного интеллекта. | ||
| TTS преобразование текста в аудио | ||
| Anthropic | Claude 3 Opus | |
| Claude 3 Sonnet | ||
| Claude 3 Haiku |
Доступные методы
| Провайдер | Метод | Поддержка |
|---|---|---|
| OpenAI | /v1/models | |
| /v1/chat/completions | ||
| /v1/embeddings | ||
| /v1/images/generations | ||
| /v1/images/edits | ||
| /v1/images/variations | ||
| /v1/audio/speech | ||
| /v1/audio/transcriptions | ||
| /v1/audio/translations | ||
| Anthropic | /v1/messages |
Ключ API
Для использования ProxyAPI необходимо получить ключ API. Для этого необходимо зарегистрироваться на сайте и перейти в раздел "Ключи API". Обратите внимание, что увидеть ключ целиком можно только один раз, сразу после создания.
Работа с запросами
При отправке запроса к ProxyAPI используйте наш адрес вместо адреса оригинального API, добавляя в конце индентификатор провайдера в нашей системе:
https://api.proxyapi.ru/openaihttps://api.proxyapi.ru/anthropicВ заголовке запроса укажите ключ API:
Authorization: Bearer PROXY_API_KEYКроме случаев, о которых мы будем предупреждать дополнительно в этой документации, все методы и параметры запроса остаются такими же, как и в оригинальном API.
Пример запроса к OpenAI API:
curl https://api.proxyapi.ru/openai/v1/chat/completions \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $PROXY_API_KEY" \
-d '{
"model": "gpt-4-turbo",
"messages": [{"role": "user", "content": "Say this is a test!"}]
}'Пример запроса к Anthropic API:
curl https://api.proxyapi.ru/anthropic/v1/messages \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $PROXY_API_KEY" \
-H "Anthropic-Version: 2023-06-01" \
-d '{
"model": "claude-3-opus-20240229",
"messages": [{"role": "user", "content": "Say this is a test!"}],
"max_tokens": 1024
}'Таким же образом можно пользоваться официальными библиотеками. Например OpenAI для Python (пример для версии 1.3.5, последней на момент написания):
from openai import OpenAI
client = OpenAI(
api_key="{PROXY_API_KEY}",
base_url="https://api.proxyapi.ru/openai/v1",
)
chat_completion = client.chat.completions.create(
model="gpt-3.5-turbo", messages=[{"role": "user", "content": "Hello world"}]
)
А вот пример генерации изображений с помощью DALL-E 3:
from openai import OpenAI
client = OpenAI(
api_key="{PROXY_API_KEY}",
base_url="https://api.proxyapi.ru/openai/v1",
)
response = client.images.generate(
model="dall-e-3",
prompt="A painting of a glass of water on a table.",
n=1,
size="1024x1024",
)
Замените {PROXY_API_KEY} на ваш ключ API.
Собственные методы ProxyAPI
Запрос баланса
Возвращает текущий баланс вашего аккаунта.
Доступ к этому методу по умолчанию заблокирован. Для того, чтобы открыть доступ нужно дополнительно отредактировать ключ API после его создания.
{
"balance": 123.45
}Ошибка 402 Insufficient balance to run this request.
В нашей системе предварительный расчет стоимости запроса проводится до отправки и, если не указан параметр max_tokens, берется максимальное контекстное окно для модели. Например:
{
"model": "gpt-4",
"messages": [{"role": "user", "content": "Say this is a test!"}],
}Если же указать параметр max_tokens, именно он будет использоваться для расчета и вы сможете контролировать максимальную стоимость запроса.
Доступ к последним разработкам мировых лидеров в области AI для вашего проекта или бизнеса в России. Без VPN и блокировок. Оплата в рублях.
