NUDG3 Agency - Quotas API
The Agency - Quotas API from NUDG3 — 5 operation(s) for agency - quotas.
The Agency - Quotas API from NUDG3 — 5 operation(s) for agency - quotas.
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-quotas-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 - 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: Agency - Quotas
paths:
/agency/quota-pools:
get:
tags:
- Agency - Quotas
summary: Get agency quota pools
description: Get all quota pools for the current user's agency.
operationId: get_agency_quota_pools_agency_quota_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/api__agency__quotas__AgencyPoolResponse'
title: Response Get Agency Quota Pools Agency Quota Pools Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/agency/quota-dashboard:
get:
tags:
- Agency - Quotas
summary: Get agency quota dashboard
description: Get overview of all quota pools and allocations for the agency.
operationId: get_agency_quota_dashboard_agency_quota_dashboard_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/AgencyQuotaDashboard'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/agency/quota-pools/{pool_id}:
get:
tags:
- Agency - Quotas
summary: Get pool with allocations
description: Get pool details with all workspace allocations.
operationId: get_pool_with_allocations_agency_quota_pools__pool_id__get
security:
- HTTPBearer: []
parameters:
- name: pool_id
in: path
required: true
schema:
type: string
format: uuid
description: Pool ID
title: Pool Id
description: Pool 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/api__agency__quotas__PoolWithAllocationsResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/agency/workspaces/{workspace_id}/allocate-quota:
post:
tags:
- Agency - Quotas
summary: Allocate quota to workspace
description: Allocate quota from agency pool to a workspace.
operationId: allocate_quota_to_workspace_agency_workspaces__workspace_id__allocate_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/api__agency__quotas__AllocateQuotaRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/api__agency__quotas__AllocateQuotaResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/agency/workspaces/{workspace_id}/quota/{quota_type}:
delete:
tags:
- Agency - Quotas
summary: Deallocate quota from workspace
description: Reclaim quota from workspace back to agency pool.
operationId: deallocate_quota_from_workspace_agency_workspaces__workspace_id__quota__quota_type__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: quota_type
in: path
required: true
schema:
type: string
description: Quota type
title: Quota Type
description: Quota type
- name: resource_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
description: Resource ID for premium_model
title: Resource Id
description: Resource ID for premium_model
- 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/DeallocateQuotaResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
patch:
tags:
- Agency - Quotas
summary: Update workspace quota allocation
description: Update the allocation amount for an existing workspace quota.
operationId: update_workspace_quota_agency_workspaces__workspace_id__quota__quota_type__patch
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
description: Quota type
title: Quota Type
description: Quota type
- 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/UpdateQuotaRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateQuotaResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
api__agency__quotas__AgencyPoolResponse:
properties:
id:
type: string
title: Id
description: Pool ID
agency_id:
type: string
title: Agency Id
description: Agency ID
quota_type:
type: string
title: Quota Type
description: Type of quota
resource_id:
anyOf:
- type: string
- type: 'null'
title: Resource Id
description: Resource ID for premium_model
resource_name:
anyOf:
- type: string
- type: 'null'
title: Resource Name
description: Resource name
total_allocation:
type: integer
title: Total Allocation
description: Total amount in pool
distributed:
type: integer
title: Distributed
description: Amount distributed to workspaces
remaining:
type: integer
title: Remaining
description: Available for distribution
expires_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Expires At
description: Expiration timestamp
granted_at:
type: string
format: date-time
title: Granted At
description: Grant timestamp
type: object
required:
- id
- agency_id
- quota_type
- total_allocation
- distributed
- remaining
- granted_at
title: AgencyPoolResponse
description: Response schema for an agency quota pool.
api__agency__quotas__AllocateQuotaResponse:
properties:
success:
type: boolean
title: Success
description: Whether allocation was successful
message:
type: string
title: Message
description: Result message
workspace_id:
type: string
title: Workspace Id
description: Workspace ID
quota_type:
type: string
title: Quota Type
description: Quota type
amount_allocated:
type: integer
title: Amount Allocated
description: Amount allocated
pool_remaining:
type: integer
title: Pool Remaining
description: Remaining in pool
type: object
required:
- success
- message
- workspace_id
- quota_type
- amount_allocated
- pool_remaining
title: AllocateQuotaResponse
description: Response for quota allocation.
api__agency__quotas__PoolWithAllocationsResponse:
properties:
pool:
$ref: '#/components/schemas/api__agency__quotas__AgencyPoolResponse'
description: Pool details
allocations:
items:
$ref: '#/components/schemas/WorkspaceQuotaSummary'
type: array
title: Allocations
total_workspaces:
type: integer
title: Total Workspaces
default: 0
type: object
required:
- pool
title: PoolWithAllocationsResponse
description: Pool details with all workspace allocations.
UpdateQuotaResponse:
properties:
success:
type: boolean
title: Success
description: Whether update was successful
message:
type: string
title: Message
description: Result message
workspace_id:
type: string
title: Workspace Id
description: Workspace ID
quota_type:
type: string
title: Quota Type
description: Quota type
previous_amount:
type: integer
title: Previous Amount
description: Previous allocation amount
new_amount:
type: integer
title: New Amount
description: New allocation amount
pool_remaining:
type: integer
title: Pool Remaining
description: Remaining in pool after update
type: object
required:
- success
- message
- workspace_id
- quota_type
- previous_amount
- new_amount
- pool_remaining
title: UpdateQuotaResponse
description: Response for quota update.
api__agency__quotas__AllocateQuotaRequest:
properties:
quota_type:
type: string
title: Quota Type
description: Type of quota to allocate
resource_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Resource Id
description: Resource ID for premium_model
amount:
type: integer
exclusiveMinimum: 0.0
title: Amount
description: Amount to allocate
type: object
required:
- quota_type
- amount
title: AllocateQuotaRequest
description: Request to allocate quota from agency pool to workspace.
DeallocateQuotaResponse:
properties:
success:
type: boolean
title: Success
description: Whether deallocation was successful
message:
type: string
title: Message
description: Result message
workspace_id:
type: string
title: Workspace Id
description: Workspace ID
quota_type:
type: string
title: Quota Type
description: Quota type
amount_returned:
type: integer
title: Amount Returned
description: Amount returned to pool
pool_remaining:
type: integer
title: Pool Remaining
description: Remaining in pool
type: object
required:
- success
- message
- workspace_id
- quota_type
- amount_returned
- pool_remaining
title: DeallocateQuotaResponse
description: Response for quota deallocation.
AgencyQuotaDashboard:
properties:
agency_id:
type: string
title: Agency Id
description: Agency ID
agency_name:
type: string
title: Agency Name
description: Agency name
pools:
items:
$ref: '#/components/schemas/api__agency__quotas__AgencyPoolResponse'
type: array
title: Pools
workspace_count:
type: integer
title: Workspace Count
default: 0
total_pool_allocated:
type: integer
title: Total Pool Allocated
default: 0
total_pool_distributed:
type: integer
title: Total Pool Distributed
default: 0
total_pool_remaining:
type: integer
title: Total Pool Remaining
default: 0
type: object
required:
- agency_id
- agency_name
title: AgencyQuotaDashboard
description: Agency-wide quota overview.
WorkspaceQuotaSummary:
properties:
workspace_id:
type: string
title: Workspace Id
description: Workspace ID
workspace_name:
type: string
title: Workspace Name
description: Workspace name
company_id:
type: string
title: Company Id
description: Company ID
company_name:
type: string
title: Company Name
description: Company name
quota_type:
type: string
title: Quota Type
description: Quota type
allocated:
type: integer
title: Allocated
description: Amount allocated
used:
type: integer
title: Used
description: Amount used
remaining:
type: integer
title: Remaining
description: Remaining amount
usage_percentage:
type: number
title: Usage Percentage
description: Usage percentage
source:
type: string
title: Source
description: Quota source
reset_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Reset At
description: Next reset
expires_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Expires At
description: Expiration
type: object
required:
- workspace_id
- workspace_name
- company_id
- company_name
- quota_type
- allocated
- used
- remaining
- usage_percentage
- source
title: WorkspaceQuotaSummary
description: Summary of quota for a single workspace.
UpdateQuotaRequest:
properties:
amount:
type: integer
exclusiveMinimum: 0.0
title: Amount
description: New allocation amount
resource_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Resource Id
description: Resource ID for premium_model
type: object
required:
- amount
title: UpdateQuotaRequest
description: Request to update workspace quota allocation amount.
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
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
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