NUDG3 Agency - Premium Pools API
The Agency - Premium Pools API from NUDG3 — 6 operation(s) for agency - premium pools.
The Agency - Premium Pools API from NUDG3 — 6 operation(s) for agency - premium pools.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/nudg3-ai:nudg3-ai-agency-premium-pools-api"
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.
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: 3.2.0
info:
title: Nudg3 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: Agency - Premium Pools
paths:
/agency/premium-pools:
get:
tags:
- Agency - Premium Pools
summary: List Agency Premium Pools
description: List all premium pools for the agency.
operationId: list_agency_premium_pools_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
- name: agency_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
description: Agency ID (required for super users)
title: Agency Id
description: Agency ID (required for super users)
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/schemas__api__agency__premium_pools__AgencyPoolResponse'
title: Response List Agency Premium Pools Agency Premium Pools Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/agency/premium-pools/status:
get:
tags:
- Agency - Premium Pools
summary: Get Agency Pool Status
description: Get status overview of all agency premium pools.
operationId: get_agency_pool_status_agency_premium_pools_status_get
security:
- HTTPBearer: []
parameters:
- name: agency_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
description: Agency ID (required for super users)
title: Agency Id
description: Agency ID (required for super users)
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/schemas__api__agency__premium_pools__AgencyPoolStatusResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/agency/premium-pools/{product_id}:
get:
tags:
- Agency - Premium Pools
summary: Get Pool With Allocations
description: Get a specific pool with its workspace allocations.
operationId: get_pool_with_allocations_agency_premium_pools__product_id__get
security:
- HTTPBearer: []
parameters:
- 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: agency_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
description: Agency ID (required for super users)
title: Agency Id
description: Agency ID (required for super users)
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/schemas__api__agency__premium_pools__PoolWithAllocationsResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/agency/workspaces/{workspace_id}/allocate-premium-quota:
post:
tags:
- Agency - Premium Pools
summary: Allocate Premium Quota To Workspace
description: Allocate premium quota from agency pool to a workspace.
operationId: allocate_premium_quota_to_workspace_agency_workspaces__workspace_id__allocate_premium_quota_post
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: agency_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
description: Agency ID (required for super users)
title: Agency Id
description: Agency ID (required for super users)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/schemas__api__agency__premium_pools__AllocateQuotaRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/schemas__api__agency__premium_pools__AllocateQuotaResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/agency/workspaces/{workspace_id}/premium-quota/{product_id}:
delete:
tags:
- Agency - Premium Pools
summary: Reclaim Quota From Workspace
description: Reclaim premium quota from workspace back to agency pool.
operationId: reclaim_quota_from_workspace_agency_workspaces__workspace_id__premium_quota__product_id__delete
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: 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: agency_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
description: Agency ID (required for super users)
title: Agency Id
description: Agency ID (required for super users)
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ReclaimQuotaResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/agency/premium-pools/bulk-reclaim:
post:
tags:
- Agency - Premium Pools
summary: Bulk Reclaim Quota
description: Reclaim quota from multiple workspaces in one operation.
operationId: bulk_reclaim_quota_agency_premium_pools_bulk_reclaim_post
security:
- HTTPBearer: []
parameters:
- name: agency_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
description: Agency ID (required for super users)
title: Agency Id
description: Agency ID (required for super users)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BulkReclaimRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/BulkReclaimResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
BulkReclaimRequest:
properties:
workspace_ids:
items:
type: string
format: uuid
type: array
minItems: 1
title: Workspace Ids
description: Workspace IDs to reclaim quota from
product_id:
type: string
format: uuid
title: Product Id
description: Premium model product ID
type: object
required:
- workspace_ids
- product_id
title: BulkReclaimRequest
description: Request to reclaim quota from multiple workspaces.
schemas__api__agency__premium_pools__AllocateQuotaRequest:
properties:
product_id:
type: string
format: uuid
title: Product Id
description: Premium model product ID
credits:
type: integer
exclusiveMinimum: 0.0
title: Credits
description: Number of credits to allocate
reset_period:
type: string
enum:
- daily
- weekly
- monthly
- never
title: Reset Period
description: When usage resets
default: daily
type: object
required:
- product_id
- credits
title: AllocateQuotaRequest
description: Request to allocate quota from agency pool to workspace.
example:
credits: 100
product_id: 123e4567-e89b-12d3-a456-426614174000
reset_period: daily
schemas__api__agency__premium_pools__AgencyPoolResponse:
properties:
id:
type: string
format: uuid
title: Id
agency_id:
type: string
format: uuid
title: Agency Id
product_id:
type: string
format: uuid
title: Product Id
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
format: date-time
- type: 'null'
title: Expires At
is_expired:
type: boolean
title: Is Expired
created_at:
type: string
format: date-time
title: Created At
updated_at:
type: string
format: date-time
title: Updated At
product:
anyOf:
- $ref: '#/components/schemas/ProductReference'
- type: 'null'
type: object
required:
- id
- agency_id
- product_id
- total_credits
- allocated_credits
- available_credits
- is_expired
- created_at
- updated_at
title: AgencyPoolResponse
description: Response for a single agency premium pool.
ReclaimQuotaResponse:
properties:
success:
type: boolean
title: Success
message:
type: string
title: Message
workspace_id:
type: string
format: uuid
title: Workspace Id
product_id:
type: string
format: uuid
title: Product Id
credits_reclaimed:
type: integer
title: Credits Reclaimed
pool_available_credits:
type: integer
title: Pool Available Credits
type: object
required:
- success
- message
- workspace_id
- product_id
- credits_reclaimed
- pool_available_credits
title: ReclaimQuotaResponse
description: Response after reclaiming quota from workspace.
BulkReclaimResponse:
properties:
success:
type: boolean
title: Success
total_workspaces:
type: integer
title: Total Workspaces
successful_reclaims:
type: integer
title: Successful Reclaims
failed_reclaims:
type: integer
title: Failed Reclaims
total_credits_reclaimed:
type: integer
title: Total Credits Reclaimed
pool_available_credits:
type: integer
title: Pool Available Credits
errors:
items:
additionalProperties: true
type: object
type: array
title: Errors
type: object
required:
- success
- total_workspaces
- successful_reclaims
- failed_reclaims
- total_credits_reclaimed
- pool_available_credits
title: BulkReclaimResponse
description: Response after bulk reclaim operation.
schemas__api__agency__premium_pools__PoolWithAllocationsResponse:
properties:
pool:
$ref: '#/components/schemas/schemas__api__agency__premium_pools__AgencyPoolResponse'
allocations:
items:
$ref: '#/components/schemas/WorkspaceAllocationSummary'
type: array
title: Allocations
total_workspaces_allocated:
type: integer
title: Total Workspaces Allocated
type: object
required:
- pool
- allocations
- total_workspaces_allocated
title: PoolWithAllocationsResponse
description: Response for a pool with its allocations to workspaces.
WorkspaceAllocationSummary:
properties:
workspace_id:
type: string
format: uuid
title: Workspace Id
workspace_name:
type: string
title: Workspace Name
company_id:
type: string
format: uuid
title: Company Id
company_name:
type: string
title: Company Name
allocated_credits:
type: integer
title: Allocated Credits
used_credits:
type: integer
title: Used Credits
remaining_credits:
type: integer
title: Remaining Credits
usage_percentage:
type: number
title: Usage Percentage
reset_period:
type: string
title: Reset Period
reset_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Reset At
expires_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Expires At
created_at:
type: string
format: date-time
title: Created At
type: object
required:
- workspace_id
- workspace_name
- company_id
- company_name
- allocated_credits
- used_credits
- remaining_credits
- usage_percentage
- reset_period
- created_at
title: WorkspaceAllocationSummary
description: Summary of quota allocation for a workspace.
schemas__api__agency__premium_pools__AgencyPoolStatusResponse:
properties:
agency_id:
type: string
title: Agency Id
pools:
items:
additionalProperties: true
type: object
type: array
title: Pools
total_available:
type: integer
title: Total Available
type: object
required:
- agency_id
- pools
- total_available
title: AgencyPoolStatusResponse
description: Response for agency pool status overview.
schemas__api__agency__premium_pools__AllocateQuotaResponse:
properties:
success:
type: boolean
title: Success
message:
type: string
title: Message
workspace_id:
type: string
format: uuid
title: Workspace Id
product_id:
type: string
format: uuid
title: Product Id
allocated_credits:
type: integer
title: Allocated Credits
pool_remaining_credits:
type: integer
title: Pool Remaining Credits
type: object
required:
- success
- message
- workspace_id
- product_id
- allocated_credits
- pool_remaining_credits
title: AllocateQuotaResponse
description: Response after allocating quota to workspace.
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
ProductReference:
properties:
id:
type: string
format: uuid
title: Id
slug:
type: string
title: Slug
display_name:
type: string
title: Display Name
provider:
type: string
title: Provider
is_active:
type: boolean
title: Is Active
type: object
required:
- id
- slug
- display_name
- provider
- is_active
title: ProductReference
description: Reference to a premium model product.
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