NUDG3 Admin - Agency Premium Pools API

The Admin - Agency Premium Pools API from NUDG3 — 4 operation(s) for admin - agency premium pools.

GitHub OpenAPI

Operations 7

GET /admin/agencies/{agency_id}/premium-pools List agency premium pools #
POST /admin/agencies/{agency_id}/premium-pools Create agency pool #
GET /admin/agencies/{agency_id}/premium-pools/{product_id} Get agency pool details #
PUT /admin/agencies/{agency_id}/premium-pools/{product_id} Update agency pool #
DELETE /admin/agencies/{agency_id}/premium-pools/{product_id} Delete agency pool #
POST /admin/agencies/{agency_id}/premium-pools/bulk Bulk create agency pools #
GET /admin/agency-premium-pools List all agency premium pools #

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-agency-premium-pools-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-agency-premium-pools-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Nudg3 Admin - Agency Premium Pools 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 - Agency Premium Pools
paths:
  /admin/agencies/{agency_id}/premium-pools:
    get:
      tags:
      - Admin - Agency Premium Pools
      summary: List agency premium pools
      description: Get all premium model pools for a specific agency. Super user only.
      operationId: list_agency_pools_admin_agencies__agency_id__premium_pools_get
      security:
      - HTTPBearer: []
      parameters:
      - name: agency_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: Agency ID
          title: Agency Id
        description: Agency ID
      - name: include_expired
        in: query
        required: false
        schema:
          type: boolean
          description: Include expired pools
          default: false
          title: Include Expired
        description: Include expired pools
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AgencyPoolAdminResponse'
                title: Response List Agency Pools Admin Agencies  Agency Id  Premium Pools Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Admin - Agency Premium Pools
      summary: Create agency pool
      description: Create a premium pool for an agency. Super user only.
      operationId: create_agency_pool_admin_agencies__agency_id__premium_pools_post
      security:
      - HTTPBearer: []
      parameters:
      - name: agency_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: Agency ID
          title: Agency Id
        description: Agency ID
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/api__admin__agency_premium_pools__CreateAgencyPoolRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgencyPoolAdminResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/agencies/{agency_id}/premium-pools/{product_id}:
    get:
      tags:
      - Admin - Agency Premium Pools
      summary: Get agency pool details
      description: Get details of a specific agency pool. Super user only.
      operationId: get_agency_pool_admin_agencies__agency_id__premium_pools__product_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: agency_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: Agency ID
          title: Agency Id
        description: Agency ID
      - name: product_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: Premium model product ID
          title: Product Id
        description: Premium model product ID
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgencyPoolAdminResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    put:
      tags:
      - Admin - Agency Premium Pools
      summary: Update agency pool
      description: Update an agency premium pool. Super user only.
      operationId: update_agency_pool_admin_agencies__agency_id__premium_pools__product_id__put
      security:
      - HTTPBearer: []
      parameters:
      - name: agency_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: Agency ID
          title: Agency Id
        description: Agency ID
      - name: product_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: Premium model product ID
          title: Product Id
        description: Premium model product ID
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/api__admin__agency_premium_pools__UpdateAgencyPoolRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgencyPoolAdminResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Admin - Agency Premium Pools
      summary: Delete agency pool
      description: 'Remove an agency premium pool. Super user only. Warning: This will also remove all workspace quotas allocated from this pool.'
      operationId: delete_agency_pool_admin_agencies__agency_id__premium_pools__product_id__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: agency_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: Agency ID
          title: Agency Id
        description: Agency ID
      - name: product_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: Premium model product ID
          title: Product Id
        description: Premium model product ID
      - name: force
        in: query
        required: false
        schema:
          type: boolean
          description: Force delete even if credits are distributed
          default: false
          title: Force
        description: Force delete even if credits are distributed
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/agencies/{agency_id}/premium-pools/bulk:
    post:
      tags:
      - Admin - Agency Premium Pools
      summary: Bulk create agency pools
      description: Create multiple premium pools for an agency at once. Super user only.
      operationId: bulk_create_agency_pools_admin_agencies__agency_id__premium_pools_bulk_post
      security:
      - HTTPBearer: []
      parameters:
      - name: agency_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: Agency ID
          title: Agency Id
        description: Agency ID
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkCreateAgencyPoolsRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AgencyPoolAdminResponse'
                title: Response Bulk Create Agency Pools Admin Agencies  Agency Id  Premium Pools Bulk Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/agency-premium-pools:
    get:
      tags:
      - Admin - Agency Premium Pools
      summary: List all agency premium pools
      description: Get all agency premium model pools across all agencies. Super user only.
      operationId: list_all_agency_pools_admin_agency_premium_pools_get
      security:
      - HTTPBearer: []
      parameters:
      - name: include_expired
        in: query
        required: false
        schema:
          type: boolean
          description: Include expired pools
          default: false
          title: Include Expired
        description: Include expired pools
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AgencyPoolAdminResponse'
                title: Response List All Agency Pools Admin Agency Premium Pools Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ProductSummary:
      properties:
        id:
          type: string
          title: Id
        slug:
          type: string
          title: Slug
        display_name:
          type: string
          title: Display Name
        provider:
          type: string
          title: Provider
      type: object
      required:
      - id
      - slug
      - display_name
      - provider
      title: ProductSummary
      description: Summary of a premium product.
    api__admin__agency_premium_pools__UpdateAgencyPoolRequest:
      properties:
        total_credits:
          anyOf:
          - type: integer
            exclusiveMinimum: 0.0
          - type: 'null'
          title: Total Credits
          description: New total credits
        expires_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Expires At
          description: New expiration date (ISO format)
      type: object
      title: UpdateAgencyPoolRequest
      description: Request to update an agency pool.
    BulkCreateAgencyPoolsRequest:
      properties:
        pools:
          items:
            $ref: '#/components/schemas/BulkCreatePoolItem'
          type: array
          title: Pools
          description: List of pools to create
      type: object
      required:
      - pools
      title: BulkCreateAgencyPoolsRequest
      description: Request for bulk creating agency pools.
    AgencyPoolAdminResponse:
      properties:
        id:
          type: string
          title: Id
        agency_id:
          type: string
          title: Agency Id
        agency_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Agency Name
        product_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Product Id
        product:
          anyOf:
          - $ref: '#/components/schemas/ProductSummary'
          - type: 'null'
        total_credits:
          type: integer
          title: Total Credits
        allocated_credits:
          type: integer
          title: Allocated Credits
        available_credits:
          type: integer
          title: Available Credits
        expires_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Expires At
        is_expired:
          type: boolean
          title: Is Expired
        created_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Created At
        updated_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Updated At
      type: object
      required:
      - id
      - agency_id
      - total_credits
      - allocated_credits
      - available_credits
      - is_expired
      title: AgencyPoolAdminResponse
      description: Response schema for agency premium pool (admin view).
    BulkCreatePoolItem:
      properties:
        product_id:
          type: string
          format: uuid
          title: Product Id
          description: Premium model product ID
        total_credits:
          type: integer
          exclusiveMinimum: 0.0
          title: Total Credits
          description: Total credits for pool
        expires_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Expires At
          description: Expiration date (ISO format)
      type: object
      required:
      - product_id
      - total_credits
      title: BulkCreatePoolItem
      description: Single item in bulk create request.
    api__admin__agency_premium_pools__CreateAgencyPoolRequest:
      properties:
        product_id:
          type: string
          format: uuid
          title: Product Id
          description: Premium model product ID
        total_credits:
          type: integer
          exclusiveMinimum: 0.0
          title: Total Credits
          description: Total credits to allocate to pool
        expires_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Expires At
          description: Expiration date (ISO format, optional)
      type: object
      required:
      - product_id
      - total_credits
      title: CreateAgencyPoolRequest
      description: Request to create an agency pool.
    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