NUDG3 Premium Quotas API

The Premium Quotas API from NUDG3 — 3 operation(s) for premium quotas.

GitHub OpenAPI

Operations 3

GET /workspace/{workspace_id}/premium-quotas Get workspace premium quota status #
GET /workspace/{workspace_id}/premium-quotas/check/{model_internal} Check if model can be used #
GET /workspace/{workspace_id}/premium-quotas/available-models Get available premium models #

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-premium-quotas-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-premium-quotas-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Nudg3 Premium Quotas 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:
- name: Premium Quotas
paths:
  /workspace/{workspace_id}/premium-quotas:
    get:
      tags:
      - Premium Quotas
      summary: Get workspace premium quota status
      description: Get the premium model quota status for the workspace.
      operationId: get_workspace_premium_quota_status_workspace__workspace_id__premium_quotas_get
      security:
      - HTTPBearer: []
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: Workspace ID
          title: Workspace Id
        description: Workspace ID
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspacePremiumQuotaStatusResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /workspace/{workspace_id}/premium-quotas/check/{model_internal}:
    get:
      tags:
      - Premium Quotas
      summary: Check if model can be used
      description: Check if a specific model can be used by this workspace.
      operationId: check_model_quota_workspace__workspace_id__premium_quotas_check__model_internal__get
      security:
      - HTTPBearer: []
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: Workspace ID
          title: Workspace Id
        description: Workspace ID
      - name: model_internal
        in: path
        required: true
        schema:
          type: string
          title: Model Internal
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelQuotaCheckResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /workspace/{workspace_id}/premium-quotas/available-models:
    get:
      tags:
      - Premium Quotas
      summary: Get available premium models
      description: Get list of all premium models the workspace can currently use.
      operationId: get_available_premium_models_workspace__workspace_id__premium_quotas_available_models_get
      security:
      - HTTPBearer: []
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: Workspace ID
          title: Workspace Id
        description: Workspace ID
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  additionalProperties: true
                title: Response Get Available Premium Models Workspace  Workspace Id  Premium Quotas Available Models Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    WorkspacePremiumQuotaStatusResponse:
      properties:
        workspace_id:
          type: string
          title: Workspace Id
          description: Workspace ID
        quotas:
          items:
            $ref: '#/components/schemas/PremiumQuotaStatusResponse'
          type: array
          title: Quotas
          description: List of premium quotas
        has_any_premium_access:
          type: boolean
          title: Has Any Premium Access
          description: Whether workspace has any usable premium access
        allowed_model_internals:
          items:
            type: string
          type: array
          title: Allowed Model Internals
          description: Model internals workspace can use
      type: object
      required:
      - workspace_id
      - quotas
      - has_any_premium_access
      - allowed_model_internals
      title: WorkspacePremiumQuotaStatusResponse
      description: Response schema for workspace premium quota status.
    PremiumQuotaStatusResponse:
      properties:
        product_id:
          type: string
          title: Product Id
          description: Premium model product ID
        product_slug:
          type: string
          title: Product Slug
          description: Premium model product slug
        product_name:
          type: string
          title: Product Name
          description: Premium model product display name
        provider:
          type: string
          title: Provider
          description: LLM provider
        model_internals:
          items:
            type: string
          type: array
          title: Model Internals
          description: Model identifiers this quota covers
        allocated_credits:
          type: integer
          title: Allocated Credits
          description: Total credits allocated per period
        used_credits:
          type: integer
          title: Used Credits
          description: Credits used in current period
        remaining_credits:
          type: integer
          title: Remaining Credits
          description: Credits remaining in current period
        reset_period:
          type: string
          title: Reset Period
          description: Reset period (daily, weekly, monthly, never)
        reset_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Reset At
          description: Next reset timestamp
        expires_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Expires At
          description: Expiration timestamp
        source:
          type: string
          title: Source
          description: Source of quota (subscription, agency, purchase, admin_grant)
        is_expired:
          type: boolean
          title: Is Expired
          description: Whether quota has expired
        usage_percentage:
          type: number
          title: Usage Percentage
          description: Percentage of quota used
      type: object
      required:
      - product_id
      - product_slug
      - product_name
      - provider
      - model_internals
      - allocated_credits
      - used_credits
      - remaining_credits
      - reset_period
      - source
      - is_expired
      - usage_percentage
      title: PremiumQuotaStatusResponse
      description: Response schema for a single premium quota.
    ModelQuotaCheckResponse:
      properties:
        model_internal:
          type: string
          title: Model Internal
          description: Model identifier checked
        is_premium:
          type: boolean
          title: Is Premium
          description: Whether this is a premium model
        can_use:
          type: boolean
          title: Can Use
          description: Whether workspace can use this model
        reason:
          anyOf:
          - type: string
          - type: 'null'
          title: Reason
          description: Reason if cannot use
        quota:
          anyOf:
          - $ref: '#/components/schemas/PremiumQuotaStatusResponse'
          - type: 'null'
          description: Quota details if premium
      type: object
      required:
      - model_internal
      - is_premium
      - can_use
      title: ModelQuotaCheckResponse
      description: Response schema for checking if a specific model can be used.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: '

        API Key authentication for Public API v1 endpoints.


        **Format:** `nudg3_live_ak_xxx...` or `nudg3_test_ak_xxx...`


        **Usage:**

        ```

        Authorization: Bearer nudg3_live_ak_your_key_here

        ```


        Or use the header:

        ```

        X-API-Key: nudg3_live_ak_your_key_here

        ```


        **Obtain API Keys:**

        Generate API keys from your Nudg3 dashboard under Settings > API Keys.


        **Tiers:**

        - **Basic:** `read:analytics` scope - Analytics endpoints only

        - **Premium:** `read:analytics` + `export:data` scopes - Analytics + Exports

        '
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: '

        JWT authentication for internal dashboard endpoints.


        Obtain tokens via `/auth/login` endpoint.

        '
externalDocs:
  description: Nudg3 API Documentation
  url: https://docs.nudg3.com/api