NUDG3 Admin - Premium Quotas API

The Admin - Premium Quotas API from NUDG3 — 6 operation(s) for admin - premium quotas.

GitHub OpenAPI

Operations 10

GET /admin/plan-premium-quotas List all plan premium quotas #
POST /admin/plan-premium-quotas Create plan premium quota #
GET /admin/plan-premium-quotas/plan/{plan_id} Get plan premium quotas #
PUT /admin/plan-premium-quotas/{quota_id} Update plan premium quota #
DELETE /admin/plan-premium-quotas/{quota_id} Delete plan premium quota #
POST /admin/plan-premium-quotas/bulk Bulk create plan premium quotas #
GET /admin/premium-products List premium model products #
POST /admin/premium-products Create premium model product #
PUT /admin/premium-products/{product_id} Update premium model product #
DELETE /admin/premium-products/{product_id} Soft-delete premium model product #

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-admin-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-admin-premium-quotas-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Nudg3 Admin - 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: Admin - Premium Quotas
paths:
  /admin/plan-premium-quotas:
    get:
      tags:
      - Admin - Premium Quotas
      summary: List all plan premium quotas
      description: Get all premium quota configurations across all plans. Super user only.
      operationId: list_all_plan_premium_quotas_admin_plan_premium_quotas_get
      security:
      - HTTPBearer: []
      parameters:
      - name: include_inactive
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Include Inactive
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PlanPremiumQuotaResponse'
                title: Response List All Plan Premium Quotas Admin Plan Premium Quotas Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Admin - Premium Quotas
      summary: Create plan premium quota
      description: Add a premium quota configuration to a subscription plan. Super user only.
      operationId: create_plan_premium_quota_admin_plan_premium_quotas_post
      security:
      - HTTPBearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePlanPremiumQuotaRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlanPremiumQuotaResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/plan-premium-quotas/plan/{plan_id}:
    get:
      tags:
      - Admin - Premium Quotas
      summary: Get plan premium quotas
      description: Get all premium quota configurations for a specific plan. Super user only.
      operationId: get_plan_premium_quotas_admin_plan_premium_quotas_plan__plan_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: plan_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Plan Id
      - name: include_inactive
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Include Inactive
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PlanPremiumQuotaResponse'
                title: Response Get Plan Premium Quotas Admin Plan Premium Quotas Plan  Plan Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/plan-premium-quotas/{quota_id}:
    put:
      tags:
      - Admin - Premium Quotas
      summary: Update plan premium quota
      description: Update a premium quota configuration. Super user only.
      operationId: update_plan_premium_quota_admin_plan_premium_quotas__quota_id__put
      security:
      - HTTPBearer: []
      parameters:
      - name: quota_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Quota Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePlanPremiumQuotaRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlanPremiumQuotaResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Admin - Premium Quotas
      summary: Delete plan premium quota
      description: Remove a premium quota configuration from a plan. Super user only.
      operationId: delete_plan_premium_quota_admin_plan_premium_quotas__quota_id__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: quota_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Quota Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/plan-premium-quotas/bulk:
    post:
      tags:
      - Admin - Premium Quotas
      summary: Bulk create plan premium quotas
      description: Create multiple premium quota configurations for a plan at once. Super user only.
      operationId: bulk_create_plan_premium_quotas_admin_plan_premium_quotas_bulk_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkCreatePlanPremiumQuotasRequest'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/PlanPremiumQuotaResponse'
                type: array
                title: Response Bulk Create Plan Premium Quotas Admin Plan Premium Quotas Bulk Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /admin/premium-products:
    get:
      tags:
      - Admin - Premium Quotas
      summary: List premium model products
      description: Get all available premium model products for quota configuration. Super user only.
      operationId: list_premium_products_admin_premium_products_get
      security:
      - HTTPBearer: []
      parameters:
      - name: include_inactive
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Include Inactive
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  additionalProperties: true
                title: Response List Premium Products Admin Premium Products Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Admin - Premium Quotas
      summary: Create premium model product
      description: Create a new premium model product. Super user only.
      operationId: create_premium_product_admin_premium_products_post
      security:
      - HTTPBearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePremiumProductRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PremiumProductResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/premium-products/{product_id}:
    put:
      tags:
      - Admin - Premium Quotas
      summary: Update premium model product
      description: Update a premium model product. Super user only.
      operationId: update_premium_product_admin_premium_products__product_id__put
      security:
      - HTTPBearer: []
      parameters:
      - name: product_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Product Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePremiumProductRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PremiumProductResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Admin - Premium Quotas
      summary: Soft-delete premium model product
      description: Deactivate a premium model product (soft-delete). Super user only.
      operationId: delete_premium_product_admin_premium_products__product_id__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: product_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Product Id
      - name: reason
        in: query
        required: true
        schema:
          type: string
          title: Reason
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletePremiumProductResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    UpdatePremiumProductRequest:
      properties:
        display_name:
          anyOf:
          - type: string
            maxLength: 100
            minLength: 2
          - type: 'null'
          title: Display Name
          description: New display name for UI
        model_internals:
          anyOf:
          - items:
              type: string
            type: array
            minItems: 1
          - type: 'null'
          title: Model Internals
          description: Updated list of model IDs. Replaces existing list.
        cost_per_credit:
          anyOf:
          - type: number
            minimum: 0.0
          - type: string
            pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          - type: 'null'
          title: Cost Per Credit
          description: New cost per credit
        is_active:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Active
          description: Whether product is active (set False to soft-delete)
        reason:
          type: string
          maxLength: 500
          minLength: 5
          title: Reason
          description: Required reason for audit trail
      type: object
      required:
      - reason
      title: UpdatePremiumProductRequest
      description: Request schema for updating a premium model product.
      example:
        display_name: GPT-5 Pro (Updated)
        model_internals:
        - gpt-5.3-2025-04-15
        - gpt-5.4-2025-08-20
        reason: Adding new model version, removing deprecated version
    PlanPremiumQuotaResponse:
      properties:
        id:
          type: string
          title: Id
          description: Plan premium quota ID
        plan_id:
          type: string
          title: Plan Id
          description: Subscription plan ID
        plan_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Plan Name
          description: Subscription plan name
        plan_slug:
          anyOf:
          - type: string
          - type: 'null'
          title: Plan Slug
          description: Subscription plan slug
        product_id:
          type: string
          title: Product Id
          description: Premium model product ID
        product_slug:
          anyOf:
          - type: string
          - type: 'null'
          title: Product Slug
          description: Premium model product slug
        product_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Product Name
          description: Premium model product display name
        provider:
          anyOf:
          - type: string
          - type: 'null'
          title: Provider
          description: LLM provider
        credits_per_period:
          type: integer
          title: Credits Per Period
          description: Credits allocated per period
        reset_period:
          type: string
          title: Reset Period
          description: Reset period (daily, weekly, monthly, never)
        is_active:
          type: boolean
          title: Is Active
          description: Whether quota mapping is active
        created_at:
          type: string
          title: Created At
          description: Created timestamp
        updated_at:
          type: string
          title: Updated At
          description: Updated timestamp
      type: object
      required:
      - id
      - plan_id
      - product_id
      - credits_per_period
      - reset_period
      - is_active
      - created_at
      - updated_at
      title: PlanPremiumQuotaResponse
      description: Response schema for plan premium quota.
    PremiumProductResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
          description: Product ID
        slug:
          type: string
          title: Slug
          description: Unique product identifier
        display_name:
          type: string
          title: Display Name
          description: Human-readable name
        provider:
          type: string
          title: Provider
          description: LLM provider
        model_internals:
          items:
            type: string
          type: array
          title: Model Internals
          description: Model IDs covered by this product
        cost_per_credit:
          anyOf:
          - type: number
          - type: 'null'
          title: Cost Per Credit
          description: Cost per credit
        is_active:
          type: boolean
          title: Is Active
          description: Whether product is active
        created_at:
          type: string
          format: date-time
          title: Created At
          description: Creation timestamp
        updated_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Updated At
          description: Last update timestamp
      type: object
      required:
      - id
      - slug
      - display_name
      - provider
      - model_internals
      - is_active
      - created_at
      title: PremiumProductResponse
      description: Response schema for premium model product.
      example:
        cost_per_credit: 0.015
        created_at: '2025-01-15T10:30:00'
        display_name: GPT-5 Pro
        id: 550e8400-e29b-41d4-a716-446655440000
        is_active: true
        model_internals:
        - gpt-5.2-2025-12-11
        provider: openai
        slug: gpt-5-pro
        updated_at: '2025-01-16T14:45:00'
    BulkCreatePlanQuotaItem:
      properties:
        product_id:
          type: string
          format: uuid
          title: Product Id
          description: Premium model product ID
        credits_per_period:
          type: integer
          minimum: 1.0
          title: Credits Per Period
          description: Credits per period
        reset_period:
          type: string
          title: Reset Period
          description: Reset period
          default: daily
      type: object
      required:
      - product_id
      - credits_per_period
      title: BulkCreatePlanQuotaItem
      description: Single item in bulk create request.
    BulkCreatePlanPremiumQuotasRequest:
      properties:
        plan_id:
          type: string
          format: uuid
          title: Plan Id
          description: Subscription plan ID
        quotas:
          items:
            $ref: '#/components/schemas/BulkCreatePlanQuotaItem'
          type: array
          title: Quotas
          description: List of quotas to create
      type: object
      required:
      - plan_id
      - quotas
      title: BulkCreatePlanPremiumQuotasRequest
      description: Request schema for bulk creating plan premium quotas.
    CreatePlanPremiumQuotaRequest:
      properties:
        plan_id:
          type: string
          format: uuid
          title: Plan Id
          description: Subscription plan ID
        product_id:
          type: string
          format: uuid
          title: Product Id
          description: Premium model product ID
        credits_per_period:
          type: integer
          minimum: 1.0
          title: Credits Per Period
          description: Credits allocated per period
        reset_period:
          type: string
          title: Reset Period
          description: Reset period (daily, weekly, monthly, never)
          default: daily
      type: object
      required:
      - plan_id
      - product_id
      - credits_per_period
      title: CreatePlanPremiumQuotaRequest
      description: Request schema for creating a plan premium quota.
    CreatePremiumProductRequest:
      properties:
        slug:
          type: string
          maxLength: 50
          minLength: 2
          title: Slug
          description: Unique identifier (lowercase, hyphens). E.g., 'gpt-5-pro', 'claude-sonnet'
        display_name:
          type: string
          maxLength: 100
          minLength: 2
          title: Display Name
          description: Human-readable name for UI. E.g., 'GPT-5 Pro', 'Claude Sonnet'
        provider:
          type: string
          maxLength: 50
          minLength: 2
          title: Provider
          description: Provider internal name. E.g., 'openai', 'anthropic', 'google'
        model_internals:
          items:
            type: string
          type: array
          minItems: 1
          title: Model Internals
          description: List of model IDs that consume this quota. E.g., ['gpt-5.2-2025-12-11']
        cost_per_credit:
          anyOf:
          - type: number
            minimum: 0.0
          - type: string
            pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          - type: 'null'
          title: Cost Per Credit
          description: Cost per credit for billing calculations
        reason:
          type: string
          maxLength: 500
          minLength: 5
          title: Reason
          description: Required reason for audit trail. E.g., 'Adding new GPT-5 product for enterprise tier'
      type: object
      required:
      - slug
      - display_name
      - provider
      - model_internals
      - reason
      title: CreatePremiumProductRequest
      description: Request schema for creating a premium model product.
      example:
        cost_per_credit: 0.015
        display_name: GPT-5 Pro
        model_internals:
        - gpt-5.2-2025-12-11
        - gpt-5.3-2025-04-15
        provider: openai
        reason: Adding new GPT-5 product for premium tier subscribers
        slug: gpt-5-pro
    UpdatePlanPremiumQuotaRequest:
      properties:
        credits_per_period:
          anyOf:
          - type: integer
            minimum: 1.0
          - type: 'null'
          title: Credits Per Period
          description: Credits allocated per period
        reset_period:
          anyOf:
          - type: string
          - type: 'null'
          title: Reset Period
          description: Reset period
        is_active:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Active
          description: Whether quota mapping is active
      type: object
      title: UpdatePlanPremiumQuotaRequest
      description: Request schema for updating a plan premium quota.
    DeletePremiumProductResponse:
      properties:
        success:
          type: boolean
          title: Success
          description: Whether soft-delete was successful
        message:
          type: string
          title: Message
          description: Status message
        product_id:
          type: string
          format: uuid
          title: Product Id
          description: Soft-deleted product ID
        product_slug:
          type: string
          title: Product Slug
          description: Soft-deleted product slug
        affected_quotas_count:
          type: integer
          title: Affected Quotas Count
          description: Number of workspace/agency quotas that reference this product
      type: object
      required:
      - success
      - message
      - product_id
      - product_slug
      - affected_quotas_count
      title: DeletePremiumProductResponse
      description: Response schema for soft-deleting a premium model product.
      example:
        affected_quotas_count: 15
        message: Product gpt-5-pro has been deactivated
        product_id: 550e8400-e29b-41d4-a716-446655440000
        product_slug: gpt-5-pro
        success: true
    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