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

Обзор API

Copy page



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

Claude API — это RESTful API по адресу https://api.anthropic.com, который предоставляет программный доступ к моделям Claude и управляемым агентам 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, перечисленных в навигации. Для доступа к бета-функциям см. Beta headers.

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

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

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

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

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

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

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

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

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

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

Список клиентских 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 применяет ограничения скорости и ограничения расходов для предотвращения злоупотреблений и управления ёмкостью. Ограничения организованы в уровни использования; ваша организация автоматически помещается на уровень и может со временем перейти на более высокий уровень. Каждый уровень имеет:

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

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

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

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

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

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