NUDG3 Trial API
The Trial API from NUDG3 — 1 operation(s) for trial.
The Trial API from NUDG3 — 1 operation(s) for trial.
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-trial-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 Trial 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: Trial
paths:
/trial/status:
get:
tags:
- Trial
summary: Get Trial Status
description: 'Get current trial status for a specific workspace.
Returns trial countdown information used by the dashboard trial widget.
Process:
1. Validate user has access to workspace
2. Get workspace status from WorkspaceService
3. Return trial status with countdown and subscription info
Args:
workspace_id: UUID of the workspace to check
current_user: Authenticated user (from dependency)
db: Database session (from dependency)
Returns:
Workspace trial status with days remaining and subscription details
Raises:
403: User does not have access to workspace
404: Workspace not found'
operationId: get_trial_status_trial_status_get
security:
- HTTPBearer: []
parameters:
- name: workspace_id
in: query
required: true
schema:
type: string
format: uuid
title: Workspace Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/api__trial__TrialStatusResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
api__trial__TrialStatusResponse:
properties:
workspace_id:
type: string
title: Workspace Id
description: Workspace ID
status:
type: string
title: Status
description: 'Workspace status: active, trial, expired, free'
access_level:
type: string
title: Access Level
description: 'Access level: paid, trial, free_tier, none'
is_trial:
type: boolean
title: Is Trial
description: Whether workspace is on trial
trial_expired:
type: boolean
title: Trial Expired
description: Whether trial has expired
has_subscription:
type: boolean
title: Has Subscription
description: Whether workspace has active subscription
has_payment_method:
type: boolean
title: Has Payment Method
description: Whether workspace has a payment method on file (PayFast token or Stripe subscription)
default: false
payment_provider:
anyOf:
- type: string
- type: 'null'
title: Payment Provider
description: 'Payment provider if payment method exists: ''payfast'' or ''stripe'''
trial_end_date:
anyOf:
- type: string
- type: 'null'
title: Trial End Date
description: Trial end date (ISO format, null if not on trial)
days_remaining:
anyOf:
- type: integer
- type: 'null'
title: Days Remaining
description: Days remaining in trial (null if not on trial or has subscription)
prompt_limit:
anyOf:
- type: integer
- type: 'null'
title: Prompt Limit
description: Daily prompt limit based on plan or trial
subscription_plan:
anyOf:
- type: string
- type: 'null'
title: Subscription Plan
description: Subscription plan name (null if not subscribed)
subscription_status:
anyOf:
- type: string
- type: 'null'
title: Subscription Status
description: Subscription status (null if not subscribed)
onboarded:
type: boolean
title: Onboarded
description: Whether workspace has completed onboarding (used by PaymentGuard to distinguish legacy free-tier users from new signups)
default: false
message:
type: string
title: Message
description: Human-readable status message
type: object
required:
- workspace_id
- status
- access_level
- is_trial
- trial_expired
- has_subscription
- message
title: TrialStatusResponse
description: Response schema for trial status.
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