NUDG3 Workspace Quotas API

The Workspace Quotas API from NUDG3 — 4 operation(s) for workspace quotas.

GitHub OpenAPI

Operations 4

GET /workspace/{workspace_id}/quotas Get workspace quota summary #
GET /workspace/{workspace_id}/quotas/check/{quota_type} Check quota availability #
GET /workspace/{workspace_id}/quotas/agency-pool-status Get agency pool status #
GET /workspace/{workspace_id}/quotas/{quota_type} Get specific quota details #

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-workspace-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-workspace-quotas-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Nudg3 Workspace 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: Workspace Quotas
paths:
  /workspace/{workspace_id}/quotas:
    get:
      tags:
      - Workspace Quotas
      summary: Get workspace quota summary
      description: Get complete quota status for the workspace including all quota types.
      operationId: get_workspace_quota_summary_workspace__workspace_id__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/QuotaSummaryResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /workspace/{workspace_id}/quotas/check/{quota_type}:
    get:
      tags:
      - Workspace Quotas
      summary: Check quota availability
      description: Check if a specific quota type has available capacity.
      operationId: check_quota_availability_workspace__workspace_id__quotas_check__quota_type__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: quota_type
        in: path
        required: true
        schema:
          type: string
          title: Quota Type
      - name: resource_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          description: Resource ID for premium_model quotas
          title: Resource Id
        description: Resource ID for premium_model quotas
      - name: amount
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: Amount to check availability for
          default: 1
          title: Amount
        description: Amount to check availability for
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuotaCheckResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /workspace/{workspace_id}/quotas/agency-pool-status:
    get:
      tags:
      - Workspace Quotas
      summary: Get agency pool status
      description: Get agency pool quota status for workspaces with agency-managed quotas.
      operationId: get_agency_pool_status_workspace__workspace_id__quotas_agency_pool_status_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/api__workspace__quotas__AgencyPoolStatusResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /workspace/{workspace_id}/quotas/{quota_type}:
    get:
      tags:
      - Workspace Quotas
      summary: Get specific quota details
      description: Get detailed information about a specific quota type.
      operationId: get_quota_details_workspace__workspace_id__quotas__quota_type__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: quota_type
        in: path
        required: true
        schema:
          type: string
          title: Quota Type
      - name: resource_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          description: Resource ID for premium_model quotas
          title: Resource Id
        description: Resource ID for premium_model quotas
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuotaEntryResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    AgencyPoolQuotaEntry:
      properties:
        quota_type:
          type: string
          title: Quota Type
          description: Type of quota (max_prompts, base_prompts, etc.)
        allocated:
          type: integer
          title: Allocated
          description: Amount allocated to this workspace from pool
        used:
          type: integer
          title: Used
          description: Amount used by this workspace
        remaining:
          type: integer
          title: Remaining
          description: Remaining amount for this workspace
        pool_total_allocation:
          type: integer
          title: Pool Total Allocation
          description: Total pool allocation
        pool_distributed:
          type: integer
          title: Pool Distributed
          description: Total distributed from pool
        pool_total_used:
          type: integer
          title: Pool Total Used
          description: Total used across all pool workspaces
        pool_remaining:
          type: integer
          title: Pool Remaining
          description: Remaining at pool level
        usage_percentage:
          type: number
          title: Usage Percentage
          description: Workspace usage percentage
        pool_usage_percentage:
          type: number
          title: Pool Usage Percentage
          description: Pool-wide usage percentage
      type: object
      required:
      - quota_type
      - allocated
      - used
      - remaining
      - pool_total_allocation
      - pool_distributed
      - pool_total_used
      - pool_remaining
      - usage_percentage
      - pool_usage_percentage
      title: AgencyPoolQuotaEntry
      description: Individual quota entry from agency pool.
    api__workspace__quotas__AgencyPoolStatusResponse:
      properties:
        has_agency_pool:
          type: boolean
          title: Has Agency Pool
          description: Whether workspace has agency pool quota
        agency_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Agency Id
          description: Agency ID
        agency_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Agency Name
          description: Agency name
        pool_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Pool Id
          description: Pool ID
        quotas:
          items:
            $ref: '#/components/schemas/AgencyPoolQuotaEntry'
          type: array
          title: Quotas
          description: Pool quota entries
        message:
          type: string
          title: Message
          description: Status message
      type: object
      required:
      - has_agency_pool
      - message
      title: AgencyPoolStatusResponse
      description: Agency pool status for a workspace.
    QuotaEntryResponse:
      properties:
        id:
          type: string
          title: Id
          description: Quota entry ID
        quota_type:
          type: string
          title: Quota Type
          description: Type of quota (base_prompts, max_prompts, etc.)
        resource_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Resource Id
          description: Resource ID for premium_model quotas
        resource_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Resource Name
          description: Human-readable resource name
        allocated:
          type: integer
          title: Allocated
          description: Total allocated amount (-1 = unlimited)
        used:
          type: integer
          title: Used
          description: Amount used in current period
        remaining:
          type: integer
          title: Remaining
          description: Remaining amount (-1 = unlimited)
        reset_period:
          type: string
          title: Reset Period
          description: Reset period (daily, weekly, monthly, never)
        reset_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Reset At
          description: Next reset timestamp
        expires_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Expires At
          description: Expiration timestamp
        source:
          type: string
          title: Source
          description: Source of quota (subscription, trial, admin_grant, etc.)
        source_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Source Name
          description: Human-readable source name
        is_unlimited:
          type: boolean
          title: Is Unlimited
          description: Whether quota is unlimited
        usage_percentage:
          type: number
          title: Usage Percentage
          description: Percentage of quota used (0.0-100.0)
      type: object
      required:
      - id
      - quota_type
      - allocated
      - used
      - remaining
      - reset_period
      - source
      - is_unlimited
      - usage_percentage
      title: QuotaEntryResponse
      description: Single quota entry for a workspace.
    QuotaCheckResponse:
      properties:
        allowed:
          type: boolean
          title: Allowed
          description: Whether the operation is allowed
        quota_type:
          type: string
          title: Quota Type
          description: Type of quota checked
        resource_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Resource Id
          description: Resource ID if applicable
        allocated:
          type: integer
          title: Allocated
          description: Total allocated amount (-1 = unlimited)
        used:
          type: integer
          title: Used
          description: Amount used in current period
        remaining:
          type: integer
          title: Remaining
          description: Remaining amount (-1 = unlimited)
        reset_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Reset At
          description: Next reset timestamp
        expires_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Expires At
          description: Expiration timestamp
        message:
          anyOf:
          - type: string
          - type: 'null'
          title: Message
          description: User-friendly message explaining the result
      type: object
      required:
      - allowed
      - quota_type
      - allocated
      - used
      - remaining
      title: QuotaCheckResponse
      description: Result of checking if quota is available.
    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
    QuotaSummaryResponse:
      properties:
        workspace_id:
          type: string
          title: Workspace Id
          description: Workspace ID
        workspace_name:
          type: string
          title: Workspace Name
          description: Workspace name
        is_trial:
          type: boolean
          title: Is Trial
          description: Whether workspace is on trial
        trial_expires_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Trial Expires At
          description: Trial expiration timestamp
        subscription_plan:
          anyOf:
          - type: string
          - type: 'null'
          title: Subscription Plan
          description: Active subscription plan name
        base_prompts:
          anyOf:
          - $ref: '#/components/schemas/QuotaEntryResponse'
          - type: 'null'
          description: Daily base prompt quota
        max_prompts:
          anyOf:
          - $ref: '#/components/schemas/QuotaEntryResponse'
          - type: 'null'
          description: Maximum total prompts limit
        visibility_report:
          anyOf:
          - $ref: '#/components/schemas/QuotaEntryResponse'
          - type: 'null'
          description: Visibility report feature flag
        action_generation:
          anyOf:
          - $ref: '#/components/schemas/QuotaEntryResponse'
          - type: 'null'
          description: Monthly action generation quota
        chat_agent:
          anyOf:
          - $ref: '#/components/schemas/QuotaEntryResponse'
          - type: 'null'
          description: Daily chat agent quota
        premium_models:
          items:
            $ref: '#/components/schemas/QuotaEntryResponse'
          type: array
          title: Premium Models
          description: Premium model quotas
        all_quotas:
          items:
            $ref: '#/components/schemas/QuotaEntryResponse'
          type: array
          title: All Quotas
          description: All quota entries
        premium_prompt_count:
          type: integer
          title: Premium Prompt Count
          description: Active prompts with premium_providers assigned
          default: 0
        premium_prompt_limit:
          type: integer
          title: Premium Prompt Limit
          description: Total premium prompt capacity (sum of all PREMIUM_MODEL allocated)
          default: 0
        base_prompt_count:
          type: integer
          title: Base Prompt Count
          description: Active prompts collectible by base providers (scope=base or all)
          default: 0
        warnings:
          items:
            type: string
          type: array
          title: Warnings
          description: Quota warnings (e.g., 'Trial expires in 3 days')
      type: object
      required:
      - workspace_id
      - workspace_name
      - is_trial
      title: QuotaSummaryResponse
      description: Complete quota summary for a workspace.
  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