rendobar-com Notifications API

openapi: 3.2.0
info:
  title: Rendobar Notifications API
  version: 1.0.0
  summary: Serverless media processing API
  description: Serverless media processing API. Watermark, transcode, caption, redact, and render videos with one API call. Credit-based billing. MCP-native for AI agents.
  termsOfService: https://rendobar.com/terms/
  contact:
    name: Rendobar Support
    url: https://rendobar.com/
    email: hello@rendobar.com
  license:
    name: Proprietary
    url: https://rendobar.com/terms/
servers:
- url: https://api.rendobar.com
  description: Current environment
security:
- bearerAuth: []
- oauth2: []
tags:
- name: Notifications
  description: Messages for the organization and each member's read state
paths:
  /notifications:
    get:
      security:
      - bearerAuth:
        - orgs:read
      operationId: listNotifications
      tags:
      - Notifications
      summary: List notifications
      description: Newest 50 notifications for the organization, with the calling user's read state. `meta.unread` counts unread among those 50.
      responses:
        '200':
          description: Notifications
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        severity:
                          type: string
                          enum:
                          - info
                          - success
                          - warning
                          - error
                        title:
                          type: string
                        body:
                          type: string
                        href:
                          type:
                          - string
                          - 'null'
                          description: Dashboard path this notification links to
                        actionLabel:
                          type:
                          - string
                          - 'null'
                          description: Button text for the linked action, e.g. "Update payment"; null when there is nothing to do
                        requiresAck:
                          type: boolean
                          description: Shown once in a modal until read
                        read:
                          type: boolean
                          description: Whether the calling user has read it
                        createdAt:
                          type: number
                          description: Unix ms
                      required:
                      - id
                      - severity
                      - title
                      - body
                      - href
                      - actionLabel
                      - requiresAck
                      - read
                      - createdAt
                  meta:
                    type: object
                    properties:
                      unread:
                        type: integer
                    required:
                    - unread
                required:
                - data
                - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Machine-readable error code
                      message:
                        type: string
                        description: Human-readable error message
                      details:
                        description: More about the error when there is more to say. A refusal lists its problems here as `{ path, message, upgradeTo? }`, where `upgradeTo` names the cheapest plan that runs it (null when only an enterprise plan does).
                    required:
                    - code
                    - message
                required:
                - error
  /notifications/read:
    post:
      security:
      - bearerAuth:
        - orgs:write
      operationId: markNotificationsRead
      tags:
      - Notifications
      summary: Mark notifications read
      description: Marks the given notifications read for the calling user. Unknown or other-org ids are ignored.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  items:
                    type: string
                  minItems: 1
                  maxItems: 50
              required:
              - ids
      responses:
        '200':
          description: Number of notifications newly marked read
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      read:
                        type: integer
                    required:
                    - read
                required:
                - data
        '400':
          description: Invalid body
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Machine-readable error code
                      message:
                        type: string
                        description: Human-readable error message
                      details:
                        description: More about the error when there is more to say. A refusal lists its problems here as `{ path, message, upgradeTo? }`, where `upgradeTo` names the cheapest plan that runs it (null when only an enterprise plan does).
                    required:
                    - code
                    - message
                required:
                - error
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Machine-readable error code
                      message:
                        type: string
                        description: Human-readable error message
                      details:
                        description: More about the error when there is more to say. A refusal lists its problems here as `{ path, message, upgradeTo? }`, where `upgradeTo` names the cheapest plan that runs it (null when only an enterprise plan does).
                    required:
                    - code
                    - message
                required:
                - error
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key or OAuth access token
      description: 'Bearer authentication. Accepts an API key from https://app.rendobar.com/settings/api-keys (`Authorization: Bearer rb_xxx`) or an OAuth 2.1 access token. Both carry the same scopes and the same authority: what a caller may do is a property of the grant, not of how it authenticated.'
    oauth2:
      type: oauth2
      description: OAuth 2.1 with PKCE. Register a client at https://api.rendobar.com/oauth2/register or connect through an integration that does it for you. Scopes are granted at consent and carry the same authority as an API key holding them.
      flows:
        authorizationCode:
          authorizationUrl: https://api.rendobar.com/auth/oauth2/authorize
          tokenUrl: https://api.rendobar.com/auth/oauth2/token
          refreshUrl: https://api.rendobar.com/auth/oauth2/token
          scopes:
            jobs:read: See your jobs and their results
            jobs:write: Run and cancel jobs
            assets:read: See and download your files
            assets:write: Upload and delete files
            webhooks:read: See where your events are delivered
            webhooks:write: Manage where your events are delivered
            billing:read: See your plan, balance and usage
            billing:write: Change your plan and payment methods
            orgs:read: See your organization and its members
            orgs:write: Manage your organization and its members
            keys:read: See which API keys exist
            keys:write: Create and revoke API keys
            storage:read: See which storage connections exist
            storage:write: Connect, rotate and remove storage connections
externalDocs:
  description: Full developer documentation
  url: https://rendobar.com/docs/