Lium Notifications API
The Notifications API from Lium — 8 operation(s) for notifications.
The Notifications API from Lium — 8 operation(s) for notifications.
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/lium-io:lium-io-notifications-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. 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: Lium Io Notifications API
version: '1.0'
description: 'Operations tagged Notifications across 2 of this provider''s published API definitions: lium-io-openapi.json, provider-api-lium-io-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /api
description: Production API
tags:
- name: Notifications
paths:
/notifications/catalog:
get:
tags:
- Notifications
summary: Get Notification Catalog
operationId: get_notification_catalog_notifications_catalog_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationCatalogResponse'
servers:
- url: /api
description: Production API
/notifications:
get:
tags:
- Notifications
summary: List Notifications
operationId: list_notifications_notifications_get
security:
- JwtAccessBearer: []
parameters:
- name: cursor
in: query
required: false
schema:
anyOf:
- type: string
maxLength: 512
- type: 'null'
title: Cursor
- name: limit
in: query
required: false
schema:
type: integer
maximum: 100
minimum: 1
default: 20
title: Limit
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DetailResponse_NotificationPage_'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
servers:
- url: /api
/notifications/mark-read:
post:
tags:
- Notifications
summary: Mark Notifications Read
operationId: mark_notifications_read_notifications_mark_read_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MarkNotificationsReadRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse_dict_'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- JwtAccessBearer: []
servers:
- url: /api
/notifications/settings:
get:
tags:
- Notifications
summary: Get Notification Settings
operationId: get_notification_settings_notifications_settings_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DetailResponse_NotificationSettingsResponse_'
security:
- JwtAccessBearer: []
servers:
- url: /api
/notifications/settings/preferences:
patch:
tags:
- Notifications
summary: Update Notification Preferences
operationId: update_notification_preferences_notifications_settings_preferences_patch
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationPreferencesRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DetailResponse_NotificationSettingsResponse_'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- JwtAccessBearer: []
servers:
- url: /api
/notifications/settings/webhook:
put:
tags:
- Notifications
summary: Update Webhook Settings
operationId: update_webhook_settings_notifications_settings_webhook_put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookSettingsRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DetailResponse_WebhookSettingsResponse_'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- JwtAccessBearer: []
servers:
- url: /api
/notifications/settings/webhook/test:
post:
tags:
- Notifications
summary: Test Webhook
operationId: test_webhook_notifications_settings_webhook_test_post
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse_dict_'
security:
- JwtAccessBearer: []
servers:
- url: /api
/notifications/settings/discord/test:
post:
tags:
- Notifications
summary: Test Discord
operationId: test_discord_notifications_settings_discord_test_post
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse_dict_'
security:
- JwtAccessBearer: []
servers:
- url: /api
components:
schemas:
NotificationSeverity:
type: string
enum:
- info
- warning
- critical
title: NotificationSeverity
NotificationType:
type: string
enum:
- node.offline
- node.validation_failed
- node.gpu_reset_needed
- node.zero_incentive
- node.inactive
- node.unverified
- node.listed
- rental.started
- pod.ssh_unresponsive
- rental.interrupted
- rental.ended
- penalty.applied
- payout.sent
title: NotificationType
NotificationCatalogResponse:
properties:
events:
items:
$ref: '#/components/schemas/NotificationCatalogEvent'
type: array
title: Events
type: object
required:
- events
title: NotificationCatalogResponse
NotificationChannel:
type: string
enum:
- discord
- webhook
- email
title: NotificationChannel
NotificationCatalogEvent:
properties:
event:
$ref: '#/components/schemas/NotificationType'
category:
type: string
title: Category
severity:
$ref: '#/components/schemas/NotificationSeverity'
label:
type: string
title: Label
description:
type: string
title: Description
channels:
items:
$ref: '#/components/schemas/NotificationChannel'
type: array
title: Channels
type: object
required:
- event
- category
- severity
- label
- description
- channels
title: NotificationCatalogEvent
JsonValue: {}
NotificationItem:
properties:
id:
type: string
format: uuid
title: Id
event_type:
type: string
title: Event Type
severity:
type: string
title: Severity
title:
type: string
title: Title
body:
type: string
title: Body
payload:
additionalProperties:
$ref: '#/components/schemas/JsonValue'
type: object
title: Payload
resource_type:
anyOf:
- type: string
- type: 'null'
title: Resource Type
resource_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Resource Id
created_at:
type: string
format: date-time
title: Created At
read_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Read At
type: object
required:
- id
- event_type
- severity
- title
- body
- payload
- resource_type
- resource_id
- created_at
- read_at
title: NotificationItem
NotificationPage:
properties:
items:
items:
$ref: '#/components/schemas/NotificationItem'
type: array
title: Items
unread_count:
type: integer
title: Unread Count
next_cursor:
anyOf:
- type: string
- type: 'null'
title: Next Cursor
type: object
required:
- items
- unread_count
- next_cursor
title: NotificationPage
NotificationPreferencesRequest:
properties:
events:
anyOf:
- $ref: '#/components/schemas/EventPreferences'
- type: 'null'
channels:
anyOf:
- $ref: '#/components/schemas/ChannelPreferences'
- type: 'null'
additionalProperties: false
type: object
title: NotificationPreferencesRequest
NotificationPreferences:
properties:
events:
$ref: '#/components/schemas/EventPreferences'
channels:
$ref: '#/components/schemas/ChannelPreferences'
additionalProperties: false
type: object
title: NotificationPreferences
WebhookSettingsResponse:
properties:
url:
anyOf:
- type: string
- type: 'null'
title: Url
has_secret:
type: boolean
title: Has Secret
secret:
anyOf:
- type: string
- type: 'null'
title: Secret
consecutive_failures:
type: integer
title: Consecutive Failures
last_failure_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Last Failure At
last_failure_reason:
anyOf:
- type: string
- type: 'null'
title: Last Failure Reason
disabled_after_failures:
type: boolean
title: Disabled After Failures
type: object
required:
- url
- has_secret
- consecutive_failures
- last_failure_at
- last_failure_reason
- disabled_after_failures
title: WebhookSettingsResponse
NotificationCatalog:
properties:
events:
items:
$ref: '#/components/schemas/NotificationCatalogEvent_2'
type: array
title: Events
type: object
required:
- events
title: NotificationCatalog
DetailResponse_NotificationSettingsResponse_:
properties:
success:
type: boolean
title: Success
description: Whether the request was successful
default: true
data:
$ref: '#/components/schemas/NotificationSettingsResponse'
description: Single item data
timestamp:
type: string
format: date-time
title: Timestamp
description: Response timestamp
type: object
required:
- data
title: DetailResponse[NotificationSettingsResponse]
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
NotificationCatalogEvent_2:
properties:
event:
type: string
title: Event
category:
type: string
title: Category
severity:
type: string
enum:
- info
- warning
- critical
title: Severity
label:
type: string
title: Label
description:
type: string
title: Description
channels:
items:
type: string
enum:
- discord
- webhook
- email
type: array
title: Channels
type: object
required:
- event
- category
- severity
- label
- description
- channels
title: NotificationCatalogEvent
EventPreferences:
properties:
node.offline:
anyOf:
- type: boolean
- type: 'null'
title: Node.Offline
node.validation_failed:
anyOf:
- type: boolean
- type: 'null'
title: Node.Validation Failed
node.gpu_reset_needed:
anyOf:
- type: boolean
- type: 'null'
title: Node.Gpu Reset Needed
node.zero_incentive:
anyOf:
- type: boolean
- type: 'null'
title: Node.Zero Incentive
node.inactive:
anyOf:
- type: boolean
- type: 'null'
title: Node.Inactive
node.unverified:
anyOf:
- type: boolean
- type: 'null'
title: Node.Unverified
node.listed:
anyOf:
- type: boolean
- type: 'null'
title: Node.Listed
rental.started:
anyOf:
- type: boolean
- type: 'null'
title: Rental.Started
pod.ssh_unresponsive:
anyOf:
- type: boolean
- type: 'null'
title: Pod.Ssh Unresponsive
rental.interrupted:
anyOf:
- type: boolean
- type: 'null'
title: Rental.Interrupted
rental.ended:
anyOf:
- type: boolean
- type: 'null'
title: Rental.Ended
penalty.applied:
anyOf:
- type: boolean
- type: 'null'
title: Penalty.Applied
payout.sent:
anyOf:
- type: boolean
- type: 'null'
title: Payout.Sent
additionalProperties: false
type: object
title: EventPreferences
DetailResponse_WebhookSettingsResponse_:
properties:
success:
type: boolean
title: Success
description: Whether the request was successful
default: true
data:
$ref: '#/components/schemas/WebhookSettingsResponse'
description: Single item data
timestamp:
type: string
format: date-time
title: Timestamp
description: Response timestamp
type: object
required:
- data
title: DetailResponse[WebhookSettingsResponse]
ErrorDetail:
properties:
code:
type: string
title: Code
description: Error code identifier
message:
type: string
title: Message
description: Human readable error message
details:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Details
description: Additional error details
type: object
required:
- code
- message
title: ErrorDetail
description: Standard error detail structure
MarkNotificationsReadRequest:
properties:
ids:
anyOf:
- items:
type: string
format: uuid
type: array
maxItems: 100
- type: 'null'
title: Ids
before:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Before
additionalProperties: false
type: object
title: MarkNotificationsReadRequest
DetailResponse_NotificationPage_:
properties:
success:
type: boolean
title: Success
description: Whether the request was successful
default: true
data:
$ref: '#/components/schemas/NotificationPage'
description: Single item data
timestamp:
type: string
format: date-time
title: Timestamp
description: Response timestamp
type: object
required:
- data
title: DetailResponse[NotificationPage]
NotificationSettingsResponse:
properties:
preferences:
$ref: '#/components/schemas/NotificationPreferences'
webhook:
$ref: '#/components/schemas/WebhookSettingsResponse'
discord_dm_blocked:
type: boolean
title: Discord Dm Blocked
email:
$ref: '#/components/schemas/EmailChannelStatus'
type: object
required:
- preferences
- webhook
- discord_dm_blocked
- email
title: NotificationSettingsResponse
DetailResponse_NotificationCatalog_:
properties:
success:
type: boolean
title: Success
description: Whether the request was successful
default: true
data:
$ref: '#/components/schemas/NotificationCatalog'
description: Single item data
timestamp:
type: string
format: date-time
title: Timestamp
description: Response timestamp
type: object
required:
- data
title: DetailResponse[NotificationCatalog]
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
WebhookSettingsRequest:
properties:
url:
anyOf:
- type: string
maxLength: 2048
- type: 'null'
title: Url
rotate_secret:
type: boolean
title: Rotate Secret
default: false
additionalProperties: false
type: object
title: WebhookSettingsRequest
ApiResponse_dict_:
properties:
success:
type: boolean
title: Success
description: Whether the request was successful
data:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Data
description: Response data
error:
anyOf:
- $ref: '#/components/schemas/ErrorDetail'
- type: 'null'
description: Error details if unsuccessful
timestamp:
type: string
format: date-time
title: Timestamp
description: Response timestamp
type: object
required:
- success
title: ApiResponse[dict]
ChannelPreferences:
properties:
discord:
anyOf:
- type: boolean
- type: 'null'
title: Discord
webhook:
anyOf:
- type: boolean
- type: 'null'
title: Webhook
email:
anyOf:
- type: boolean
- type: 'null'
title: Email
additionalProperties: false
type: object
title: ChannelPreferences
EmailChannelStatus:
properties:
address:
anyOf:
- type: string
- type: 'null'
title: Address
verified:
type: boolean
title: Verified
type: object
required:
- address
- verified
title: EmailChannelStatus
description: 'What the e-mail switch needs: the account''s address and whether it is the confirmed one.'
securitySchemes:
JwtAccessBearer:
type: http
scheme: bearer
APIKeyHeader:
type: apiKey
in: header
name: X-API-Key
HTTPBearer:
type: http
scheme: bearer
x-refined-from:
- lium-io-openapi.json
- provider-api-lium-io-openapi.json