NUDG3 System API

System health and status endpoints.

GitHub OpenAPI

Operations 35

GET /system/health Health Check #
GET /system/db-health Database Health Check #
GET /system/connection-metrics Connection Metrics #
GET /system/providers Get Providers #
GET /system/premium-models Get Premium Models #
GET /system/rate-limits Get Rate Limits #
GET /system/rate-limits/{provider} Get Provider Rate Limits #
POST /system/rate-limits/refresh Refresh Rate Limit Config #
POST /system/process-end-of-period-cancellations Process End Of Period Cancellations #
POST /system/check-subscription-expirations Check Subscription Expirations #
POST /system/send-grace-period-reminders Send Grace Period Reminders #
POST /system/check-expired-grace-periods Check Expired Grace Periods #
POST /system/cancel-abandoned-checkouts Cancel Abandoned Checkouts #
POST /system/generate-weekly-reports Generate Weekly Reports Scheduler #
POST /system/check-pending-visibility-emails Check Pending Visibility Emails #
POST /system/cleanup-unclaimed-workspaces Cleanup Unclaimed Workspaces #
POST /system/send-unclaimed-workspace-reminders Send Unclaimed Workspace Reminders #
POST /system/cleanup-stale-generations Cleanup Stale Generations #
POST /system/weekly-emails/trigger Trigger Weekly Emails #
POST /system/reset-daily-quotas Reset Daily Quotas #
POST /system/reset-monthly-quotas Reset Monthly Quotas #
POST /system/reset-premium-quotas Reset Premium Quotas #
POST /system/check-collection-health Check Collection Health #
POST /system/retry-failed-collections Retry Failed Collections #
POST /system/retry-failed-extractions Retry Failed Extractions #
POST /system/verify-collection-persistence Verify Collection Persistence #
POST /system/verify-extraction-persistence Verify Extraction Persistence #
POST /system/trigger-daily-collections Trigger Daily Collections #
POST /system/detect-duplicates Detect Duplicate Collections #
GET /system/duplicate-health Get Duplicate Detection Health #
POST /system/v3-define-tasks V3 Define Tasks #
POST /system/v3-define-tasks-shadow V3 Define Tasks Shadow #
POST /system/v3-collection-recovery V3 Collection Recovery #
POST /system/slack/events Slack Events #
POST /system/slack/docs-events Slack Docs Events #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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/nudg3-ai:nudg3-ai-system-api"
All apis
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.

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. 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 Specification

nudg3-ai-system-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Nudg3 System API
  description: '# Nudg3 Brand Intelligence API


    The Nudg3 API provides programmatic access to brand visibility analytics across AI providers.


    ## Public API v1


    The Public API (`/api/v1/`) is designed for third-party integrations and provides:


    ### Analytics Endpoints (Tier 1 - Basic)

    - Brand visibility scores and trends

    - Sentiment analysis across AI responses

    - Source citation tracking

    - Prompt performance metrics

    - Google AI Overview (AIO) coverage


    ### Export Endpoints (Tier 2 - Premium)

    - Full response data exports (CSV/TSV)

    - Source citations bulk download

    - Dashboard time-series data

    - Prompt-mention pair exports


    ## Authentication


    ### API Key (Public API v1)

    ```bash

    curl -H "Authorization: Bearer nudg3_live_ak_xxx..." \

    https://api.nudg3.com/api/v1/dashboard

    ```


    ### JWT (Dashboard API)

    ```bash

    curl -H "Authorization: Bearer eyJ..." \

    https://api.nudg3.com/analytics/dashboard

    ```


    ## Rate Limits


    | Tier | Per Minute | Per Hour | Monthly Quota |

    |------|------------|----------|---------------|

    | Basic | 60 | 600 | 5,000 |

    | Premium | 300 | 3,000 | 50,000 |


    ## Response Format


    All responses follow a standard envelope:

    ```json

    {

    "success": true,

    "data": { ... },

    "message": "Success"

    }

    ```


    ## Support


    - Documentation: https://docs.nudg3.com

    - API Status: https://status.nudg3.com

    - Support: support@nudg3.com'
  version: 1.1.0
  termsOfService: https://nudg3.com/terms
  contact:
    name: Nudg3 API Support
    url: https://nudg3.com/support
    email: support@nudg3.com
  license:
    name: Proprietary
    url: https://nudg3.com/license
servers:
- url: https://api.nudg3.com
  description: Production API
- url: https://api-staging.nudg3.com
  description: Staging API (for testing)
- url: http://localhost:8000
  description: Local Development
tags:


# --- truncated at 32 KB (57 KB total) ---
# Full source: https://artifacts.apis.io/nudg3-ai/openapi/nudg3-ai-system-api-openapi.yml