NUDG3 Agency - API Keys API
The Agency - API Keys API from NUDG3 — 3 operation(s) for agency - api keys.
The Agency - API Keys API from NUDG3 — 3 operation(s) for agency - api keys.
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-api-keys-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 - API Keys 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 - API Keys
paths:
/agency/api-keys:
post:
tags:
- Agency - API Keys
summary: Create agency API key
description: Create an agency-scoped API key. Returns the full key once, only here.
operationId: create_agency_api_key_agency_api_keys_post
security:
- HTTPBearer: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AgencyAPIKeyCreate'
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AgencyAPIKeyCreateResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- Agency - API Keys
summary: List agency API keys
description: Paginated list of agency keys for the caller's agency.
operationId: list_agency_api_keys_agency_api_keys_get
security:
- HTTPBearer: []
parameters:
- name: environment
in: query
required: false
schema:
anyOf:
- type: string
pattern: ^(live|test)$
- type: 'null'
title: Environment
- name: include_revoked
in: query
required: false
schema:
type: boolean
default: false
title: Include Revoked
- name: page
in: query
required: false
schema:
type: integer
minimum: 1
default: 1
title: Page
- name: per_page
in: query
required: false
schema:
type: integer
maximum: 100
minimum: 1
default: 50
title: Per Page
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AgencyAPIKeyList'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/agency/api-keys/{api_key_id}:
get:
tags:
- Agency - API Keys
summary: Get agency API key
description: Fetch a single agency key by id, scoped to the caller's agency.
operationId: get_agency_api_key_agency_api_keys__api_key_id__get
security:
- HTTPBearer: []
parameters:
- name: api_key_id
in: path
required: true
schema:
type: string
format: uuid
title: Api Key Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AgencyAPIKeyResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/agency/api-keys/{api_key_id}/revoke:
post:
tags:
- Agency - API Keys
summary: Revoke agency API key
description: 'Revoke an agency-scoped API key. Idempotent only on already-revoked
keys (returns 422 rather than re-revoking, to surface accidental reruns).'
operationId: revoke_agency_api_key_agency_api_keys__api_key_id__revoke_post
security:
- HTTPBearer: []
parameters:
- name: api_key_id
in: path
required: true
schema:
type: string
format: uuid
title: Api Key Id
requestBody:
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/APIKeyRevoke'
- type: 'null'
title: Request
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AgencyAPIKeyResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
APIKeyRevoke:
properties:
reason:
type: string
maxLength: 500
minLength: 1
title: Reason
description: Reason for revocation (for audit trail)
default: Revoked by user
type: object
title: APIKeyRevoke
description: Request schema for revoking an API key.
example:
reason: Key compromised, generating new key
AgencyAPIKeyResponse:
properties:
id:
type: string
format: uuid
title: Id
name:
type: string
title: Name
key_prefix:
type: string
title: Key Prefix
scopes:
items:
type: string
type: array
title: Scopes
environment:
type: string
title: Environment
agency_id:
type: string
format: uuid
title: Agency Id
description: Agency this key authorizes against
scope_level:
type: string
title: Scope Level
description: Always 'agency' for this response
rate_limit_tier:
type: string
title: Rate Limit Tier
rate_limit_per_minute:
type: integer
title: Rate Limit Per Minute
rate_limit_per_hour:
type: integer
title: Rate Limit Per Hour
monthly_quota:
anyOf:
- type: integer
- type: 'null'
title: Monthly Quota
is_active:
type: boolean
title: Is Active
expires_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Expires At
last_used_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Last Used At
last_used_ip:
anyOf:
- type: string
- type: 'null'
title: Last Used Ip
total_requests:
type: integer
title: Total Requests
total_errors:
type: integer
title: Total Errors
created_at:
type: string
format: date-time
title: Created At
updated_at:
type: string
format: date-time
title: Updated At
revoked_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Revoked At
revoked_reason:
anyOf:
- type: string
- type: 'null'
title: Revoked Reason
type: object
required:
- id
- name
- key_prefix
- scopes
- environment
- agency_id
- scope_level
- rate_limit_tier
- rate_limit_per_minute
- rate_limit_per_hour
- is_active
- expires_at
- last_used_at
- last_used_ip
- total_requests
- total_errors
- created_at
- updated_at
- revoked_at
- revoked_reason
title: AgencyAPIKeyResponse
description: Agency-scoped API key details (no secret).
AgencyAPIKeyList:
properties:
items:
items:
$ref: '#/components/schemas/AgencyAPIKeyResponse'
type: array
title: Items
total:
type: integer
title: Total
page:
type: integer
title: Page
per_page:
type: integer
title: Per Page
type: object
required:
- items
- total
- page
- per_page
title: AgencyAPIKeyList
description: Paginated list of agency keys.
AgencyAPIKeyCreateResponse:
properties:
api_key:
type: string
title: Api Key
description: Full key — store securely, shown only once.
key_details:
$ref: '#/components/schemas/AgencyAPIKeyResponse'
warning:
type: string
title: Warning
default: Save this key securely - it will not be shown again!
type: object
required:
- api_key
- key_details
title: AgencyAPIKeyCreateResponse
description: Returned once at creation. The raw key cannot be recovered later.
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
AgencyAPIKeyCreate:
properties:
name:
type: string
maxLength: 100
minLength: 1
title: Name
environment:
type: string
pattern: ^(live|test)$
title: Environment
default: live
expires_in_days:
anyOf:
- type: integer
maximum: 365.0
minimum: 1.0
- type: 'null'
title: Expires In Days
description: Days until expiration. Default 90 (vs 365 for workspace keys) — agency keys have wider blast radius and warrant shorter rotation.
default: 90
allowed_ips:
anyOf:
- items:
type: string
type: array
maxItems: 50
- type: 'null'
title: Allowed Ips
type: object
required:
- name
title: AgencyAPIKeyCreate
description: 'Request schema for creating an agency-scoped API key.
Agency keys authorize requests against ANY workspace under the agency,
so creation is restricted to dashboard users with the agency_user (or
super_user) role. Rate limit tier is auto-derived from the agency''s
highest active subscription across companies.'
example:
allowed_ips:
- 203.0.113.0/24
environment: live
expires_in_days: 90
name: Catalyst Agency Production
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