Claude API — это RESTful API по адресу https://api.anthropic.com, который предоставляет программный доступ к моделям Claude и Claude Managed Agents.
Для использования Claude API вам потребуется:
Пошаговые инструкции по настройке см. в разделе Начало работы.
Claude API включает следующие API:
POST /v1/messages)POST /v1/messages/batches)POST /v1/messages/count_tokens)GET /v1/models)POST /v1/files, GET /v1/files)POST /v1/skills, GET /v1/skills)Следующие API находятся в бета-версии:
POST /v1/agents, GET /v1/agents)POST /v1/sessions, GET /v1/sessions/{id}/events/stream)POST /v1/environments, GET /v1/environments)Полный справочник API со всеми конечными точками, параметрами и схемами ответов доступен на страницах справочника API, перечисленных в навигации. Для доступа к бета-функциям см. Бета-заголовки.
Подробные сведения об обоих методах аутентификации и о том, когда использовать каждый из них, см. в разделе Аутентификация. Все запросы к Claude API должны включать следующие заголовки:
| Заголовок | Значение | Обязателен |
|---|---|---|
x-api-key | Ваш ключ API из Console | Один из x-api-key или Authorization |
Authorization | Bearer <token>, где <token> — краткосрочный токен доступа, полученный через POST /v1/oauth/token с помощью Workload Identity Federation | Один из x-api-key или Authorization |
anthropic-version | Версия API (например, 2023-06-01) | Да |
content-type | application/json | Да |
Если вы используете клиентские SDK, SDK отправит эти заголовки автоматически. Подробнее о версионировании API см. в разделе Версии API.
При доступе к Claude через облачную платформу аутентификация интегрирована с системой IAM облачного провайдера. Поддерживаемые типы учётных данных, обязательные заголовки и варианты аутентификации см. в документации конкретной платформы.
API доступен через веб-интерфейс Console. Вы можете использовать Playground, чтобы опробовать API в браузере, а затем сгенерировать ключи API в настройках учётной записи. Срок действия каждого ключа вы выбираете при его создании. Используйте рабочие пространства, чтобы сегментировать ключи API и контролировать расходы по сценариям использования.
Anthropic предоставляет официальные SDK, которые упрощают интеграцию с API, беря на себя аутентификацию, форматирование запросов, обработку ошибок и многое другое.
Преимущества:
x-api-key, anthropic-version, content-type)Список клиентских SDK см. в разделе Клиентские SDK.
Claude доступен через прямой Claude API и через облачные платформы. Выбирайте исходя из вашей инфраструктуры, доступности функций, требований к соответствию нормативам и предпочтений по ценообразованию.
Доступ к Claude через AWS, Google Cloud или Microsoft Azure:
| Платформа | Провайдер | Документация |
|---|---|---|
| Agent Platform | Google Cloud | Claude в Google Cloud |
| Amazon Bedrock | AWS | Claude в Amazon Bedrock |
| Claude Platform on AWS | AWS (управляется Anthropic) | Claude Platform on AWS |
| Microsoft Foundry | Microsoft Azure (управляется Anthropic) | Claude в Microsoft Foundry |
| Конечная точка | Максимальный размер запроса |
|---|---|
| Messages, Token Counting | 32 МБ |
| Message Batches API | 256 МБ |
| Files API | 500 МБ |
| Sessions, Agents, Environments | 32 МБ |
При превышении этих ограничений вы получите ошибку 413 request_too_large.
Claude API включает в свои ответы следующие заголовки:
| Заголовок | Описание |
|---|---|
request-id | Глобально уникальный идентификатор запроса, например req_018EeWyXxfu5pfWkrYcMdjWG. Указывайте его при обращении в поддержку по поводу конкретного запроса. См. Идентификатор запроса. |
anthropic-organization-id | Идентификатор организации, которой принадлежит ключ API или токен доступа, использованный в запросе. |
anthropic-workspace-id | Идентификатор с префиксом wrkspc_ рабочего пространства, в которое разрешился ключ API или токен доступа, например wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ, в том числе когда это рабочее пространство по умолчанию (Default Workspace) вашей организации. Отсутствует, если учётные данные не разрешаются в рабочее пространство (например, в запросах Admin API) или запрос завершается ошибкой до завершения аутентификации. См. Определение рабочего пространства, стоящего за ответом API. |
Заголовки ограничения скорости см. в разделе Заголовки ответа на странице «Ограничения скорости». Примеры чтения заголовка ответа по имени в каждом SDK см. в разделе Определение рабочего пространства, стоящего за ответом API.
Конечные точки списков возвращают результаты постранично. Большинство новых конечных точек списков используют схему курсоров page и next_page, описанную в этом разделе. Некоторые используют другую схему; см. примечание в конце этого раздела. Используйте параметр запроса limit для управления размером страницы и параметр запроса page для получения соседней страницы. Каждый ответ включает массив data, а также поля курсоров для навигации между страницами.
| Имя | Расположение | Описание |
|---|---|---|
limit | Параметр запроса | Максимальное количество элементов, возвращаемых на одной странице. |
page | Параметр запроса | Непрозрачный курсор из предыдущего ответа. Передайте сюда значение next_page или prev_page, чтобы получить соседнюю страницу. |
order | Параметр запроса | Направление сортировки результатов (asc или desc) для конечных точек списков, поддерживающих сортировку. Курсор page действителен только с тем значением order, с которым он был создан. |
next_page | Поле ответа | Курсор следующей страницы или null, если результатов больше нет. |
prev_page | Поле ответа | Курсор предыдущей страницы для конечных точек, поддерживающих обратную пагинацию (в настоящее время GET /v1/sessions), или null, если вы находитесь на первой странице. Другие конечные точки списков не включают это поле. |
Чтобы вернуться на страницу назад, передайте 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» (ограничения скорости) и лимиты расходов для предотвращения злоупотреблений и управления мощностями. Ограничения организованы по уровням использования; ваша организация автоматически помещается на определённый уровень и со временем может перейти на более высокий. Каждый уровень имеет:
Вы можете просмотреть свои ограничения скорости на странице Ограничения скорости, а лимиты расходов — на странице Биллинг в Console. Для повышения ограничений скорости или ежемесячного лимита расходов используйте Request rate limit increase на странице ограничений скорости.
Подробную информацию об ограничениях, уровнях и алгоритме «token bucket» (корзина токенов), используемом для ограничения скорости, см. в разделе Ограничения скорости.
Claude API доступен во многих странах и регионах по всему миру. Проверьте страницу поддерживаемых регионов, чтобы убедиться в доступности в вашем местоположении.
Полная спецификация API для прямого взаимодействия с моделями
Конечные точки Agents, Sessions и Environments
Python, TypeScript, C#, Go, Java, PHP и Ruby
Уровни использования, запрос повышенных лимитов и алгоритм корзины токенов
Was this page helpful?