Документация

Что такое ProxyAPI

ProxyAPI предоставляет доступ к API иностранных сервисов. В случаях, когда это возможно мы сохраняем оригинальные методы и параметры. Это делает возможным пользоваться официальной документацией и библиотеками.

Документация OpenAI API

Наши друзья из openai-docs перевели на русский язык (с помощью GPT-4) и опубликовали документацию по OpenAI API.
OpenAI-Docs - документация OpenAI API на русском языке.

Доступные провайдеры и модели

ПровайдерМодельПоддержка
OpenAIo1
o1-mini
gpt-4o
gpt-4o-mini
gpt-4o-audio-preview
gpt-4-turbo
gpt-4
gpt-3.5-turbo
text-embedding-3-small
text-embedding-3-large
text-embedding-ada-002
dall-e-2
dall-e-3
whisper-1
В соответствии с Условиями использования необходимо предупреждать конечных пользователей о том, что для генерации голоса использовалась технология искусственного интеллекта.
tts-1
tts-1-hd
GoogleGemini 1.0 Pro
Gemini 1.5 Pro
Gemini 1.5 Flash
AnthropicClaude 3 Opus
Claude 3 Sonnet
Claude 3 Haiku
Claude 3.5 Sonnet
Claude 3.5 Haiku

Доступные методы

ПровайдерМетодПоддержка
OpenAI/v1/models
/v1/chat/completions
/v1/embeddings
/v1/filesдоступно в подписке ProxyAPI Pro
/v1/assistantsдоступно в подписке ProxyAPI Pro
/v1/threads/*доступно в подписке ProxyAPI Pro
/v1/images/*
/v1/audio/*
Google/v1/models/{model}:generateContent
/v1/models/{model}:streamGenerateContent
/v1beta/models/{model}:generateContent
/v1beta/models/{model}:streamGenerateContent
/v1/models/{model}:countTokens
/v1beta/models/{model}:countTokens
Anthropic/v1/messages

Ключ API

Для использования ProxyAPI необходимо получить ключ API. Для этого необходимо зарегистрироваться на сайте и перейти в раздел "Ключи API". Обратите внимание, что увидеть ключ целиком можно только один раз, сразу после создания.

Работа с запросами

При отправке запроса к ProxyAPI используйте наш адрес вместо адреса оригинального API, добавляя в конце идентификатор провайдера в нашей системе:

https://api.proxyapi.ru/openai
или
https://api.proxyapi.ru/google
или
https://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!"}]
    }'
Пример запроса к Google Gemini API:
curl https://api.proxyapi.ru/google/v1/models/gemini-1.5-pro:generateContent \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer $PROXY_API_KEY" \
    -d '{
      "contents": [{"role": "user","parts": [{"text": "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"}]
)

Замените {PROXY_API_KEY} на ваш ключ API.

Собственные методы ProxyAPI

Запрос баланса
GET https://api.proxyapi.ru/proxyapi/balance

Возвращает текущий баланс вашего аккаунта.

Доступ к этому методу по умолчанию заблокирован. Для того, чтобы открыть доступ нужно дополнительно отредактировать ключ 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!"}],
}
Для такого запроса предварительная стоимость будет рассчитываться исходя из контекстного окна в 8 тысяч исходящих токенов для модели gpt-4 при стоимости 17,28 ₽ за тысячу токенов, плюс стоимость входящих токенов. То есть для успешного выполнения запроса ожидается, что на балансе доступно примерно 150 ₽.

Если же указать параметр max_tokens, именно он будет использоваться для расчета и вы сможете контролировать максимальную стоимость запроса.

ProxyAPI Logo

Доступ к последним разработкам мировых лидеров в области AI для вашего проекта или бизнеса в России. Без VPN и блокировок. Оплата в рублях.

Accepted payment methods