Bluejay Usage Alerts API
The Usage Alerts API from Bluejay — 2 operation(s) for usage alerts.
The Usage Alerts API from Bluejay — 2 operation(s) for usage alerts.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/bluejay:bluejay-usage-alerts-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Bluejay Usage Alerts API
description: Bluejay API
version: 0.1.0
servers:
- url: https://api.getbluejay.ai
description: Production server
security:
- apiKeyAuth: []
tags:
- name: Usage Alerts
paths:
/v1/usage-alerts:
post:
tags:
- Usage Alerts
summary: Create Usage Alert Endpoint
operationId: create_usage_alert_endpoint_v1_usage_alerts_post
security:
- HTTPBearer: []
parameters:
- name: X-Organization-Id
in: header
required: false
schema:
type: string
title: X-Organization-Id
- name: X-API-Key
in: header
required: true
schema:
type: string
description: API key required to authenticate requests.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUsageAlertRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/UsageAlertResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- Usage Alerts
summary: List Usage Alerts Endpoint
operationId: list_usage_alerts_endpoint_v1_usage_alerts_get
security:
- HTTPBearer: []
parameters:
- name: X-Organization-Id
in: header
required: false
schema:
type: string
title: X-Organization-Id
- name: X-API-Key
in: header
required: true
schema:
type: string
description: API key required to authenticate requests.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/UsageAlertResponse'
title: Response List Usage Alerts Endpoint V1 Usage Alerts Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/usage-alerts/{usage_alert_id}:
put:
tags:
- Usage Alerts
summary: Update Usage Alert Endpoint
operationId: update_usage_alert_endpoint_v1_usage_alerts__usage_alert_id__put
security:
- HTTPBearer: []
parameters:
- name: usage_alert_id
in: path
required: true
schema:
type: string
title: Usage Alert Id
- name: X-Organization-Id
in: header
required: false
schema:
type: string
title: X-Organization-Id
- name: X-API-Key
in: header
required: true
schema:
type: string
description: API key required to authenticate requests.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUsageAlertRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/UsageAlertResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- Usage Alerts
summary: Delete Usage Alert Endpoint
operationId: delete_usage_alert_endpoint_v1_usage_alerts__usage_alert_id__delete
security:
- HTTPBearer: []
parameters:
- name: usage_alert_id
in: path
required: true
schema:
type: string
title: Usage Alert Id
- name: X-Organization-Id
in: header
required: false
schema:
type: string
title: X-Organization-Id
- name: X-API-Key
in: header
required: true
schema:
type: string
description: API key required to authenticate requests.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Delete Usage Alert Endpoint V1 Usage Alerts Usage Alert Id Delete
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
NotificationChannel:
properties:
type:
$ref: '#/components/schemas/NotificationChannelType'
description: 'Channel type: email, slack or webhook'
target:
type: string
title: Target
description: Email address, Slack channel id, or https webhook URL
type: object
required:
- type
- target
title: NotificationChannel
NotificationChannelType:
type: string
enum:
- email
- slack
- webhook
title: NotificationChannelType
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
UsageAlertType:
type: string
enum:
- low_remaining_contract_credit_percentage_reached
- low_remaining_contract_credit_balance_reached
- spend_threshold_reached
title: UsageAlertType
description: 'the native Metronome alert types we expose, as-is, for usage alerts.
contracts are credits-only, so we alert on remaining balance: percentage (running-low and
exhaustion at 0%) and absolute credit balance. spend is kept for legacy/overage-depth alerts.'
UsageAlertResponse:
properties:
id:
type: string
format: uuid
title: Id
name:
type: string
title: Name
metronome_alert_id:
type: string
title: Metronome Alert Id
notification_channels:
items:
$ref: '#/components/schemas/NotificationChannel'
type: array
title: Notification Channels
is_enabled:
type: boolean
title: Is Enabled
threshold:
anyOf:
- type: number
- type: 'null'
title: Threshold
alert_type:
anyOf:
- type: string
- type: 'null'
title: Alert Type
status:
anyOf:
- type: string
- type: 'null'
title: Status
type: object
required:
- id
- name
- metronome_alert_id
- notification_channels
- is_enabled
title: UsageAlertResponse
CreateUsageAlertRequest:
properties:
name:
type: string
title: Name
description: Human-readable alert name
alert_type:
$ref: '#/components/schemas/UsageAlertType'
description: Metronome alert type, passed through as-is
threshold:
type: number
title: Threshold
description: Threshold in the type's native unit (% , $, or 0 for into-overage)
notification_channels:
items:
$ref: '#/components/schemas/NotificationChannel'
type: array
title: Notification Channels
type: object
required:
- name
- alert_type
- threshold
title: CreateUsageAlertRequest
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: X-API-Key
description: API key required to authenticate requests.
scimToken:
type: http
scheme: bearer
description: SCIM token from Settings → Security → User provisioning (SCIM). Not an API key.
x-provenance:
method: harvested
publisher: Bluejay
source: https://api.getbluejay.ai/openapi.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)