NUDG3 Public - Free Audit API
The Public - Free Audit API from NUDG3 — 1 operation(s) for public - free audit.
The Public - Free Audit API from NUDG3 — 1 operation(s) for public - free audit.
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-public-free-audit-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 Public - Free Audit 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: Public - Free Audit
paths:
/public/free-audit/signup:
post:
tags:
- Public - Free Audit
summary: Free Audit Signup
description: 'Create a new account from the free audit form on the landing page.
This endpoint:
1. Creates a user account with temporary password
2. Sets up a workspace with 7-day trial
3. Creates the primary brand
4. Auto-generates competitors (optional, graceful degradation)
5. Auto-generates prompts (optional, graceful degradation)
6. Triggers initial data collection (optional, graceful degradation)
7. Returns JWT token for auto-login to dashboard
**Rate Limits**:
- IP-based: 10 attempts per minute, 50 per hour (prevents email rotation attacks)
- Email-based: 3 attempts per minute, 10 per hour (per email address)
**No authentication required** - This is a public signup endpoint.'
operationId: free_audit_signup_public_free_audit_signup_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FreeAuditSignupRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/FreeAuditSignupResponse'
'409':
description: Email already exists
content:
application/json:
schema:
$ref: '#/components/schemas/FreeAuditErrorResponse'
'429':
description: Rate limit exceeded
content:
application/json:
schema:
$ref: '#/components/schemas/FreeAuditErrorResponse'
'400':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/FreeAuditErrorResponse'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/FreeAuditErrorResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
FreeAuditErrorResponse:
properties:
success:
type: boolean
title: Success
description: Always False for error responses
default: false
error:
type: string
title: Error
description: Error code (e.g., 'email_exists', 'rate_limit', 'validation_error')
message:
type: string
title: Message
description: User-friendly error message
login_url:
anyOf:
- type: string
- type: 'null'
title: Login Url
description: Login URL if user already exists
retry_after:
anyOf:
- type: integer
- type: 'null'
title: Retry After
description: Seconds to wait before retrying (for rate limit errors)
type: object
required:
- error
- message
title: FreeAuditErrorResponse
description: Response schema for free audit signup errors.
SetupSummary:
properties:
brand_researched:
type: boolean
title: Brand Researched
description: Whether brand research via Perplexity completed successfully
industry:
anyOf:
- type: string
- type: 'null'
title: Industry
description: Industry detected from brand research
competitors_added:
type: integer
title: Competitors Added
description: Number of competitors auto-added
default: 0
prompts_generated:
type: integer
title: Prompts Generated
description: Number of prompts auto-generated
default: 0
collection_triggered:
type: boolean
title: Collection Triggered
description: Whether initial collection was triggered
default: false
type: object
required:
- brand_researched
title: SetupSummary
description: Summary of what was set up during free audit signup.
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
FreeAuditSignupResponse:
properties:
success:
type: boolean
title: Success
description: Whether signup was successful
default: true
user_id:
type: string
title: User Id
description: Created user's UUID
workspace_id:
type: string
title: Workspace Id
description: Created workspace's UUID
access_token:
anyOf:
- type: string
- type: 'null'
title: Access Token
description: Firebase custom token for auto-login (may be empty if token generation fails)
token_type:
type: string
title: Token Type
description: Token type for Authorization header
default: bearer
redirect_url:
type: string
title: Redirect Url
description: URL to redirect user to dashboard
message:
type: string
title: Message
description: User-friendly success message
default: Account created successfully. Analyzing your brand visibility...
setup_summary:
$ref: '#/components/schemas/SetupSummary'
description: Summary of what was set up
trial_end_date:
type: string
title: Trial End Date
description: Trial expiration date in ISO format
type: object
required:
- user_id
- workspace_id
- redirect_url
- setup_summary
- trial_end_date
title: FreeAuditSignupResponse
description: Response schema for successful free audit signup.
FreeAuditSignupRequest:
properties:
brand_name:
type: string
maxLength: 100
minLength: 2
title: Brand Name
description: Company/brand name
examples:
- Acme Inc
- TechStartup
website_url:
type: string
title: Website Url
description: Company website URL
examples:
- https://www.acme.com
- acme.com
email:
type: string
format: email
title: Email
description: Work email address for account creation
examples:
- user@acme.com
region:
anyOf:
- type: string
maxLength: 2
minLength: 2
- type: 'null'
title: Region
description: ISO country code from client geolocation (e.g. ZA, US)
type: object
required:
- brand_name
- website_url
- email
title: FreeAuditSignupRequest
description: Request schema for free audit signup from landing page.
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