API использования и стоимости
Программно получайте доступ к данным об использовании API и стоимости вашей организации с помощью Admin API для использования и стоимости.
The Admin API is unavailable for individual accounts. To collaborate with teammates and add members, set up your organization in Console → Settings → Organization.
Admin API для использования и стоимости предоставляет программный и детализированный доступ к историческим данным об использовании API и стоимости для вашей организации. Эти данные аналогичны информации, доступной на страницах Использование и Стоимость в консоли Anthropic.
Этот API позволяет вам лучше отслеживать, анализировать и оптимизировать ваши реализации Claude:
- Точное отслеживание использования: Получайте точные подсчеты токенов и паттерны использования вместо того, чтобы полагаться исключительно на подсчет токенов ответа
- Сверка стоимости: Сопоставляйте внутренние записи с выставлением счетов Anthropic для финансовых и бухгалтерских команд
- Производительность и улучшение продукта: Отслеживайте производительность продукта, измеряя, улучшили ли изменения в системе его работу, или настройте оповещения
- Оптимизация ограничений скорости и приоритетного уровня: Оптимизируйте функции, такие как кэширование промптов или конкретные промпты, чтобы максимально использовать выделенную мощность, или приобретите выделенную мощность.
- Расширенный анализ: Выполняйте более глубокий анализ данных, чем доступно в консоли
Требуется ключ Admin API
Этот API является частью Admin API. Эти конечные точки требуют ключ Admin API (начинающийся с sk-ant-admin...
), который отличается от стандартных ключей API. Только члены организации с ролью администратора могут предоставлять ключи Admin API через консоль Anthropic.
Партнерские решения
Ведущие платформы наблюдаемости предлагают готовые к использованию интеграции для мониторинга использования и стоимости вашего Claude API без написания пользовательского кода. Эти интеграции предоставляют панели мониторинга, оповещения и аналитику, чтобы помочь вам эффективно управлять использованием API.
Datadog
Наблюдаемость LLM с автоматическим трассированием и мониторингом
Grafana Cloud
Интеграция без агентов для простой наблюдаемости LLM с готовыми панелями мониторинга и оповещениями
Honeycomb
Расширенные запросы и визуализация через OpenTelemetry
Быстрый старт
Получите ежедневное использование вашей организации за последние 7 дней:
Установите заголовок User-Agent для интеграций
Если вы создаете интеграцию, установите заголовок User-Agent, чтобы помочь нам понять паттерны использования:
API использования
Отслеживайте потребление токенов в вашей организации с подробными разбивками по модели, рабочему пространству и уровню обслуживания с помощью конечной точки /v1/organizations/usage_report/messages
.
Ключевые концепции
- Временные корзины: Агрегируйте данные об использовании в фиксированных интервалах (
1m
,1h
или1d
) - Отслеживание токенов: Измеряйте некэшированные входные, кэшированные входные, создание кэша и выходные токены
- Фильтрация и группировка: Фильтруйте по ключу API, рабочему пространству, модели, уровню обслуживания или контекстному окну, и группируйте результаты по этим измерениям
- Использование серверных инструментов: Отслеживайте использование серверных инструментов, таких как веб-поиск
Для полных деталей параметров и схем ответов см. справочник API использования.
Базовые примеры
Ежедневное использование по модели
Почасовое использование с фильтрацией
Ограничения временной детализации
Детализация | Лимит по умолчанию | Максимальный лимит | Случай использования |
---|---|---|---|
1m | 60 корзин | 1440 корзин | Мониторинг в реальном времени |
1h | 24 корзины | 168 корзин | Ежедневные паттерны |
1d | 7 корзин | 31 корзина | Еженедельные/месячные отчеты |
API стоимости
Получайте разбивки стоимости на уровне сервиса в долларах США с помощью конечной точки /v1/organizations/cost_report
.
Ключевые концепции
- Валюта: Все стоимости в долларах США, сообщаются как десятичные строки в наименьших единицах (центы)
- Типы стоимости: Отслеживайте стоимость использования токенов, веб-поиска и выполнения кода
- Группировка: Группируйте стоимости по рабочему пространству или описанию для подробных разбивок
- Временные корзины: Только ежедневная детализация (
1d
)
Для полных деталей параметров и схем ответов см. справочник API стоимости.
Стоимости приоритетного уровня используют другую модель выставления счетов и не включены в конечную точку стоимости. Отслеживайте использование приоритетного уровня через конечную точку использования вместо этого.
Базовый пример
Пагинация
Обе конечные точки поддерживают пагинацию для больших наборов данных:
- Сделайте ваш первоначальный запрос
- Если
has_more
равноtrue
, используйте значениеnext_page
в вашем следующем запросе - Продолжайте, пока
has_more
не станетfalse
Общие случаи использования
Изучите подробные реализации в anthropic-cookbook:
- Ежедневные отчеты об использовании: Отслеживайте тенденции потребления токенов
- Распределение стоимости: Распределяйте расходы по рабочим пространствам для возвратных платежей
- Эффективность кэша: Измеряйте и оптимизируйте кэширование промптов
- Мониторинг бюджета: Настройте оповещения для пороговых значений расходов
- Экспорт CSV: Генерируйте отчеты для финансовых команд
Часто задаваемые вопросы
Насколько свежие данные?
Данные об использовании и стоимости обычно появляются в течение 5 минут после завершения запроса API, хотя задержки могут иногда быть дольше.
Какая рекомендуемая частота опроса?
API поддерживает опрос один раз в минуту для постоянного использования. Для коротких всплесков (например, загрузка данных с пагинацией) более частый опрос приемлем. Кэшируйте результаты для панелей мониторинга, которые нуждаются в частых обновлениях.
Как отслеживать использование выполнения кода?
Стоимости выполнения кода появляются в конечной точке стоимости, сгруппированные под Code Execution Usage
в поле описания. Выполнение кода не включено в конечную точку использования.
Как отслеживать использование приоритетного уровня?
Фильтруйте или группируйте по service_tier
в конечной точке использования и ищите значение priority
. Стоимости приоритетного уровня недоступны в конечной точке стоимости.
Что происходит с использованием Workbench?
Использование API из Workbench не связано с ключом API, поэтому api_key_id
будет null
, даже при группировке по этому измерению.
Как представлено рабочее пространство по умолчанию?
Использование и стоимости, отнесенные к рабочему пространству по умолчанию, имеют значение null
для workspace_id
.
См. также
API использования и стоимости могут использоваться, чтобы помочь вам обеспечить лучший опыт для ваших пользователей, помочь вам управлять стоимостями и сохранить ваш лимит скорости. Узнайте больше о некоторых из этих других функций:
- Обзор Admin API
- Справочник Admin API
- Ценообразование
- Кэширование промптов - Оптимизируйте стоимости с помощью кэширования
- Пакетная обработка - 50% скидка на пакетные запросы
- Ограничения скорости - Понимание уровней использования