TypeScript SDK API - Notifications
Notifications
Notifications are automatically created by the AI pipeline when a fill job changes state - for example, when it transitions from processing toready or failed. Use these REST endpoints to poll for events, display badge counters, and manage read state.
2 endpointsBearer sk_live_xxxBase: /v1/sdk/notifications
Auth
Authorization: Bearer sk_live_xxxxxxxxxxxxxxxxREST polling - not real-time
These endpoints use standard HTTP. Your application must call
list() on a schedule to check for new notifications. Real-time push delivery will be added in a future release.List notifications
Returns paginated notifications for your account. Each notification includes anevent_type, status,pipeline_id, read flag, and the original event payload. The response also includes the total unreadCount. Use this to build an in-app notification feed.
Mark as read
Marks a single notification as read by passing its numeric ID in the body. If you omit the ID, this endpoint will efficiently mark all unread notifications as read in a single operation.
Next in SDK API Reference
Was this page helpful?