Справочник APIИспользование API

Обзор API

Copy page



Узнайте о доступных конечных точках Claude API, заголовках аутентификации, клиентских SDK, пагинации, ограничениях скорости и вариантах доступа через облачные платформы.

Claude API — это RESTful API по адресу https://api.anthropic.com, который предоставляет программный доступ к моделям Claude и Claude Managed Agents.

Предварительные требования

Чтобы использовать Claude API, вам потребуется:

• Учётная запись Claude Console
• Ключ API или настроенное правило Workload Identity Federation

Пошаговые инструкции по настройке см. в разделе Начало работы.

Доступные API

Claude API включает следующие API:

• Messages API: отправка сообщений Claude для диалогового взаимодействия (POST /v1/messages)
• Message Batches API: асинхронная обработка больших объёмов запросов Messages со снижением стоимости на 50% (POST /v1/messages/batches)
• Token Counting API: подсчёт токенов в сообщении перед отправкой для управления затратами и ограничениями скорости (POST /v1/messages/count_tokens)
• Models API: получение списка доступных моделей Claude и сведений о них (GET /v1/models)
• Files API: загрузка файлов и управление ими для использования в нескольких вызовах API (POST /v1/files, GET /v1/files)
• Skills API: создание пользовательских навыков агентов и управление ими (POST /v1/skills, GET /v1/skills)

Следующие API находятся в бета-версии:

• Agents API: определение переиспользуемых версионируемых конфигураций агентов для Claude Managed Agents (POST /v1/agents, GET /v1/agents)
• Sessions API: запуск сессий агентов с сохранением состояния в управляемых облачных песочницах (POST /v1/sessions, GET /v1/sessions/{id}/events/stream)
• Environments API: настройка шаблонов песочниц для сессий агентов (POST /v1/environments, GET /v1/environments)

Полный справочник API со всеми конечными точками, параметрами и схемами ответов доступен на страницах справочника API, перечисленных в навигации. Для доступа к бета-функциям см. Бета-заголовки.

Аутентификация

Подробные сведения о каждом методе аутентификации и о том, когда его использовать, см. в разделе Аутентификация. Запросы к Claude API включают следующие заголовки:

Если вы используете клиентские SDK, SDK автоматически отправляет заголовки аутентификации, версии и content-type; заголовок anthropic-workspace-id вы передаёте самостоятельно, когда он требуется для вашего ключа. Подробнее о версионировании API см. в разделе Версии API.

При доступе к Claude через облачную платформу аутентификация интегрирована с системой IAM облачного провайдера. Поддерживаемые типы учётных данных, обязательные заголовки и варианты аутентификации см. в документации конкретной платформы.

Получение ключей API

API доступен через веб-интерфейс Console. Вы можете использовать playground, чтобы опробовать API в браузере, а затем сгенерировать ключи API в настройках учётной записи (см. Получите ваш ключ API Claude). При создании каждого ключа вы выбираете его тип (см. Типы ключей) и срок действия. Используйте рабочие пространства, чтобы разделять среды и контролировать расходы по сценариям использования.

Клиентские SDK

Anthropic предоставляет официальные SDK, которые упрощают интеграцию с API, беря на себя аутентификацию, форматирование запросов, обработку ошибок и многое другое.

Преимущества:

• Автоматическое управление заголовками (аутентификация, anthropic-version, content-type)
• Типобезопасная обработка запросов и ответов
• Встроенная логика повторных попыток и обработка ошибок
• Поддержка «streaming» (потоковой передачи)
• Тайм-ауты запросов и управление соединениями

Список клиентских SDK см. в разделе Клиентские SDK.

Claude API и облачные платформы

Claude доступен через прямой Claude API и через облачные платформы. Выбирайте исходя из вашей инфраструктуры, доступности функций, требований к соответствию нормативам и ценовых предпочтений.

Claude API

• Прямой доступ к новейшим моделям и функциям
• Биллинг и поддержка от Anthropic
• Лучше всего подходит для: новых интеграций, полного доступа к функциям, прямых отношений с Anthropic

API облачных платформ

Доступ к Claude через AWS, Google Cloud или Microsoft Azure:

• Интеграция с биллингом и IAM облачного провайдера
• Доступность функций зависит от платформы: к платформам, управляемым Anthropic, относятся Claude Platform on AWS и Microsoft Foundry; к платформам, управляемым партнёрами, относятся Amazon Bedrock и Google Cloud. Сведения о доступности функций и сроках см. на странице каждой платформы.
• Лучше всего подходит для: существующих облачных обязательств, специфических требований к соответствию нормативам, консолидированного облачного биллинга

Формат запросов и ответов

Ограничения размера запроса

При превышении этих ограничений вы получите ошибку 413 request_too_large.

Заголовки ответа

Claude API включает в свои ответы следующие заголовки:

Заголовки ограничения скорости см. в разделе Заголовки ответа на странице «Ограничения скорости». Примеры чтения заголовка ответа по имени в каждом SDK см. в разделе Определение рабочего пространства, стоящего за ответом API.

Пагинация

Конечные точки списков возвращают результаты постранично. Большинство новых конечных точек списков используют схему курсоров page и next_page, описанную в этом разделе. Некоторые используют другую схему; см. примечание в конце этого раздела. Используйте параметр запроса limit для управления размером страницы и параметр запроса page для получения соседней страницы. Каждый ответ включает массив data, а также поля курсоров для навигации между страницами.

Чтобы вернуться на страницу назад, передайте prev_page в качестве параметра page. prev_page равен null, когда вы находитесь на первой странице. Не все конечные точки списков поддерживают prev_page. Только GET /v1/sessions возвращает prev_page; в конечных точках списков, не поддерживающих обратную пагинацию, это поле отсутствует в ответе, а не равно null. Пошаговый пример запроса см. в разделе Получение списка сессий.

Каждый SDK предоставляет итератор с автоматической пагинацией, который следует по next_page за вас. В Python и TypeScript вы получаете его, напрямую итерируя результат списка. Остальные SDK предоставляют итератор через отдельный метод. Автоматическая пагинация в SDK работает только вперёд; чтобы вернуться на страницу назад, прочитайте prev_page из ответа и самостоятельно передайте его обратно в качестве параметра page. Подробности для конкретных языков см. в разделе клиентские SDK.

Ограничения скорости и доступность

Ограничения скорости

API применяет «rate limits» (ограничения скорости) и лимиты расходов для предотвращения злоупотреблений и управления мощностями. Ограничения организованы по уровням использования; ваша организация автоматически помещается на определённый уровень и со временем может перейти на более высокий. Каждый уровень имеет:

• Лимиты расходов: максимальная ежемесячная стоимость использования API
• Ограничения скорости: максимальное количество запросов в минуту (RPM) и токенов в минуту (TPM)

Вы можете просмотреть свои ограничения скорости на странице Ограничения скорости, а лимиты расходов — на странице Биллинг в Console. Для получения более высоких ограничений скорости или более высокого ежемесячного лимита расходов используйте Request rate limit increase на странице ограничений скорости.

Подробную информацию об ограничениях, уровнях и алгоритме token bucket, используемом для ограничения скорости, см. в разделе Ограничения скорости.

Доступность

Claude API доступен во многих странах и регионах по всему миру. Проверьте страницу поддерживаемых регионов, чтобы убедиться в доступности в вашем местоположении.

Следующие шаги