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.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/aimrank-io:aimrank-io-notifications-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API 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. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: AimRank Notifications API
  description: Ranking-as-a-Service API — Turn binary comparisons into calibrated rankings with Glicko-2, Bradley-Terry, TrueSkill, and cross-domain transfer learning. Includes webhooks, API keys, RLHF exports, and embeddable widgets.
  version: 4.12.0
tags:
- name: Notifications
paths:
  /api/v1/notifications:
    get:
      tags:
      - Notifications
      summary: List Notifications
      description: List notifications for the current user.
      operationId: list_notifications_api_v1_notifications_get
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          default: 1
          title: Page
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          default: 20
          title: Page Size
      - name: unread_only
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Unread Only
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/notifications/{notification_id}/read:
    patch:
      tags:
      - Notifications
      summary: Mark As Read
      description: Mark a notification as read.
      operationId: mark_as_read_api_v1_notifications__notification_id__read_patch
      parameters:
      - name: notification_id
        in: path
        required: true
        schema:
          type: string
          title: Notification Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/notifications/read-all:
    patch:
      tags:
      - Notifications
      summary: Mark All Read
      description: Mark all notifications as read.
      operationId: mark_all_read_api_v1_notifications_read_all_patch
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/v1/notifications/unsubscribe:
    get:
      tags:
      - Notifications
      summary: Unsubscribe From Emails
      description: 'One-click opt-out of activity emails.


        Deliberately unauthenticated: an unsubscribe link is followed from an email

        client with no session, and forcing a login to stop receiving mail is both

        hostile and, for marketing-adjacent mail in the EU, not defensible. The

        token is an HMAC over the user id, so the link is unguessable and can do

        nothing except turn this one flag off.


        Idempotent, and returns the same page whether or not the user exists, so it

        cannot be used to test which addresses have accounts.'
      operationId: unsubscribe_from_emails_api_v1_notifications_unsubscribe_get
      parameters:
      - name: u
        in: query
        required: true
        schema:
          type: string
          description: User id from the emailed link
          title: U
        description: User id from the emailed link
      - name: t
        in: query
        required: true
        schema:
          type: string
          description: HMAC token from the emailed link
          title: T
        description: HMAC token from the emailed link
      responses:
        '200':
          description: Successful Response
          content:
            text/html:
              schema:
                type: string
        '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
    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
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key