NUDG3 Onboarding API

The Onboarding API from NUDG3 — 10 operation(s) for onboarding.

GitHub OpenAPI

Operations 10

GET /onboarding/status Get Onboarding Status Query #
GET /onboarding/{workspace_id}/status Get Onboarding Status Path #
GET /onboarding/progress Get Onboarding Progress Query #
GET /onboarding/{workspace_id}/progress Get Onboarding Progress Path #
POST /onboarding/{workspace_id}/complete Complete Workspace Onboarding #
POST /onboarding/user/complete Complete User Onboarding #
DELETE /onboarding/{workspace_id}/reset Reset Workspace Onboarding #
GET /onboarding/checklist Get Checklist #
POST /onboarding/milestones/complete Complete Milestones #
POST /onboarding/checklist/dismiss Dismiss Checklist #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/nudg3-ai:nudg3-ai-onboarding-api"
All apis
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.

Get an API 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 Specification

nudg3-ai-onboarding-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Nudg3 Onboarding 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: Onboarding
paths:
  /onboarding/status:
    get:
      tags:
      - Onboarding
      summary: Get Onboarding Status Query
      description: 'Get current onboarding status for the logged-in user and specified workspace.


        Query Parameters:

        workspace_id: The specific workspace to check


        Returns status flags that determine which onboarding flow to show:

        - needs_setup: True if workspace not onboarded and user not onboarded (full setup)

        - needs_tour: True if workspace onboarded but user not onboarded (tour only)

        - Both False: User has completed onboarding, go to dashboard'
      operationId: get_onboarding_status_query_onboarding_status_get
      security:
      - HTTPBearer: []
      parameters:
      - name: workspace_id
        in: query
        required: true
        schema:
          type: string
          format: uuid
          description: Workspace ID to check
          title: Workspace Id
        description: Workspace ID to check
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingStatusResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /onboarding/{workspace_id}/status:
    get:
      tags:
      - Onboarding
      summary: Get Onboarding Status Path
      description: 'Get current onboarding status for the logged-in user and specified workspace.


        Path Parameters:

        workspace_id: The specific workspace to check


        Returns status flags that determine which onboarding flow to show:

        - needs_setup: True if workspace not onboarded and user not onboarded (full setup)

        - needs_tour: True if workspace onboarded but user not onboarded (tour only)

        - Both False: User has completed onboarding, go to dashboard'
      operationId: get_onboarding_status_path_onboarding__workspace_id__status_get
      security:
      - HTTPBearer: []
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Workspace Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingStatusResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /onboarding/progress:
    get:
      tags:
      - Onboarding
      summary: Get Onboarding Progress Query
      description: 'Get workspace setup progress for validation.


        Query Parameters:

        workspace_id: The specific workspace to check


        Used during onboarding to show progress and validate completion requirements.'
      operationId: get_onboarding_progress_query_onboarding_progress_get
      security:
      - HTTPBearer: []
      parameters:
      - name: workspace_id
        in: query
        required: true
        schema:
          type: string
          format: uuid
          description: Workspace ID to check
          title: Workspace Id
        description: Workspace ID to check
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingProgressResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /onboarding/{workspace_id}/progress:
    get:
      tags:
      - Onboarding
      summary: Get Onboarding Progress Path
      description: 'Get workspace setup progress for validation.


        Path Parameters:

        workspace_id: The specific workspace to check


        Used during onboarding to show progress and validate completion requirements.'
      operationId: get_onboarding_progress_path_onboarding__workspace_id__progress_get
      security:
      - HTTPBearer: []
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Workspace Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingProgressResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /onboarding/{workspace_id}/complete:
    post:
      tags:
      - Onboarding
      summary: Complete Workspace Onboarding
      description: 'Mark workspace onboarding as complete after validation.


        Path Parameters:

        workspace_id: The specific workspace to complete


        Request Body:

        location (optional): Default location configuration for the workspace (country, city, region)


        Validates:

        - Minimum 3 active tracked competitors

        - Minimum 3 active prompt templates

        - At least 1 collection run exists


        Returns 400 error if validation fails with specific message.'
      operationId: complete_workspace_onboarding_onboarding__workspace_id__complete_post
      security:
      - HTTPBearer: []
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Workspace Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompleteWorkspaceOnboardingRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompleteOnboardingResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /onboarding/user/complete:
    post:
      tags:
      - Onboarding
      summary: Complete User Onboarding
      description: 'Mark user''s onboarding tour as complete.


        This is called after the user completes the dashboard tour,

        whether they did full setup or tour-only flow.'
      operationId: complete_user_onboarding_onboarding_user_complete_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompleteOnboardingResponse'
      security:
      - HTTPBearer: []
  /onboarding/{workspace_id}/reset:
    delete:
      tags:
      - Onboarding
      summary: Reset Workspace Onboarding
      description: 'Reset workspace onboarding - deletes all brands, prompts, and collections.


        Path Parameters:

        workspace_id: The specific workspace to reset


        This endpoint performs a full reset of the workspace onboarding state:

        - Deletes all collection runs (cascades to provider_responses, citations)

        - Deletes all prompt templates

        - Deletes all competitor brands (preserves primary brand)

        - Resets workspace location data


        Only allowed during onboarding (workspace.onboarded = False).

        Returns 400 error if workspace has already completed onboarding.


        Returns deletion counts for tracking and verification.'
      operationId: reset_workspace_onboarding_onboarding__workspace_id__reset_delete
      security:
      - HTTPBearer: []
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Workspace Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResetOnboardingResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /onboarding/checklist:
    get:
      tags:
      - Onboarding
      summary: Get Checklist
      description: 'Return the getting-started checklist for the current user.


        `is_new_user` is True when the account is <=30 days old AND the checklist

        has not been dismissed. All 8 milestones are always returned so the UI

        can render the full list without a second request.'
      operationId: get_checklist_onboarding_checklist_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChecklistResponse'
      security:
      - HTTPBearer: []
  /onboarding/milestones/complete:
    post:
      tags:
      - Onboarding
      summary: Complete Milestones
      description: 'Mark one or more milestones as completed (idempotent).


        Already-completed milestones are silently skipped; only newly inserted

        IDs are returned in `updated`.'
      operationId: complete_milestones_onboarding_milestones_complete_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompleteMilestonesRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompleteMilestonesResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /onboarding/checklist/dismiss:
    post:
      tags:
      - Onboarding
      summary: Dismiss Checklist
      description: 'Permanently dismiss the getting-started checklist for the current user.


        Idempotent -- calling it again on an already-dismissed checklist succeeds

        and returns the original `dismissed_at` timestamp.'
      operationId: dismiss_checklist_onboarding_checklist_dismiss_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DismissChecklistResponse'
      security:
      - HTTPBearer: []
components:
  schemas:
    CompleteMilestonesRequest:
      properties:
        milestone_ids:
          items:
            type: string
          type: array
          minItems: 1
          title: Milestone Ids
          description: One or more milestone IDs to mark as completed
      type: object
      required:
      - milestone_ids
      title: CompleteMilestonesRequest
      description: Request body for POST /onboarding/milestones/complete.
      example:
        milestone_ids:
        - add_competitors
        - add_prompts
    ResetOnboardingResponse:
      properties:
        success:
          type: boolean
          title: Success
          description: Whether reset was successful
        workspace_id:
          type: string
          format: uuid
          title: Workspace Id
          description: ID of the workspace that was reset
        deleted_counts:
          additionalProperties: true
          type: object
          title: Deleted Counts
          description: Count of deleted items by type
        message:
          type: string
          title: Message
          description: Success message
      type: object
      required:
      - success
      - workspace_id
      - deleted_counts
      - message
      title: ResetOnboardingResponse
      description: Response schema for workspace onboarding reset.
      example:
        deleted_counts:
          collection_runs: 1
          competitor_brands: 3
          prompt_templates: 5
        message: Workspace onboarding reset successfully
        success: true
        workspace_id: 123e4567-e89b-12d3-a456-426614174000
    OnboardingProgressResponse:
      properties:
        competitor_count:
          type: integer
          title: Competitor Count
          description: Number of active tracked competitors
        prompt_count:
          type: integer
          title: Prompt Count
          description: Number of active prompt templates
        has_collection:
          type: boolean
          title: Has Collection
          description: Whether at least one collection run exists
        min_competitors:
          type: integer
          title: Min Competitors
          description: Minimum required competitors
          default: 3
        min_prompts:
          type: integer
          title: Min Prompts
          description: Minimum required prompts
          default: 3
        ready_for_collection:
          type: boolean
          title: Ready For Collection
          description: Whether workspace can trigger collection
        can_complete:
          type: boolean
          title: Can Complete
          description: Whether workspace onboarding can be completed
      type: object
      required:
      - competitor_count
      - prompt_count
      - has_collection
      - ready_for_collection
      - can_complete
      title: OnboardingProgressResponse
      description: Response schema for workspace setup progress validation.
      example:
        can_complete: false
        competitor_count: 5
        has_collection: false
        min_competitors: 3
        min_prompts: 3
        prompt_count: 4
        ready_for_collection: true
    ChecklistResponse:
      properties:
        is_new_user:
          type: boolean
          title: Is New User
          description: True when user was created within the last 30 days and has not dismissed the checklist
        milestones:
          items:
            $ref: '#/components/schemas/ChecklistMilestone'
          type: array
          title: Milestones
          description: All checklist milestones with completion state
      type: object
      required:
      - is_new_user
      - milestones
      title: ChecklistResponse
      description: Response for GET /onboarding/checklist.
      example:
        is_new_user: true
        milestones:
        - completed: true
          completed_at: '2026-03-24T10:00:00'
          id: add_competitors
        - completed: false
          id: add_prompts
    ChecklistMilestone:
      properties:
        id:
          type: string
          title: Id
          description: Stable milestone identifier
        completed:
          type: boolean
          title: Completed
          description: Whether the user has completed this milestone
        completed_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Completed At
          description: When the milestone was completed
      type: object
      required:
      - id
      - completed
      title: ChecklistMilestone
      description: State of a single getting-started milestone for the current user.
    OnboardingStatusResponse:
      properties:
        user_onboarded:
          type: boolean
          title: User Onboarded
          description: Whether user has completed onboarding tour
        workspace_onboarded:
          type: boolean
          title: Workspace Onboarded
          description: Whether workspace has completed setup
        needs_setup:
          type: boolean
          title: Needs Setup
          description: Whether user needs full workspace setup
        needs_tour:
          type: boolean
          title: Needs Tour
          description: Whether user needs dashboard tour only
        workspace_name:
          type: string
          title: Workspace Name
          description: Name of the user's workspace
        user_name:
          type: string
          title: User Name
          description: Name of the current user
        workspace_id:
          type: string
          format: uuid
          title: Workspace Id
          description: ID of the user's workspace
      type: object
      required:
      - user_onboarded
      - workspace_onboarded
      - needs_setup
      - needs_tour
      - workspace_name
      - user_name
      - workspace_id
      title: OnboardingStatusResponse
      description: Response schema for current onboarding status.
      example:
        needs_setup: true
        needs_tour: false
        user_name: John Doe
        user_onboarded: false
        workspace_id: 123e4567-e89b-12d3-a456-426614174000
        workspace_name: Acme Corp
        workspace_onboarded: false
    DismissChecklistResponse:
      properties:
        success:
          type: boolean
          title: Success
          description: Whether the checklist was dismissed
        dismissed_at:
          type: string
          format: date-time
          title: Dismissed At
          description: Timestamp when the checklist was dismissed
      type: object
      required:
      - success
      - dismissed_at
      title: DismissChecklistResponse
      description: Response for POST /onboarding/checklist/dismiss.
    CompleteMilestonesResponse:
      properties:
        updated:
          items:
            type: string
          type: array
          title: Updated
          description: Milestone IDs that were newly completed (already-completed ones are skipped)
        completed_at:
          type: string
          format: date-time
          title: Completed At
          description: Timestamp applied to newly completed milestones
      type: object
      required:
      - updated
      - completed_at
      title: CompleteMilestonesResponse
      description: Response for POST /onboarding/milestones/complete.
      example:
        completed_at: '2026-03-24T10:00:00'
        updated:
        - add_competitors
    LocationData:
      properties:
        country:
          type: string
          maxLength: 2
          minLength: 2
          title: Country
          description: ISO 3166-1 alpha-2 country code (e.g., 'US', 'GB', 'ZA')
        city:
          anyOf:
          - type: string
            maxLength: 100
          - type: 'null'
          title: City
          description: City name (optional)
        region:
          anyOf:
          - type: string
            maxLength: 100
          - type: 'null'
          title: Region
          description: Region/state code or name (optional)
      type: object
      required:
      - country
      title: LocationData
      description: Location configuration schema.
      example:
        city: New York
        country: US
        region: NY
    CompleteOnboardingResponse:
      properties:
        success:
          type: boolean
          title: Success
          description: Whether onboarding was completed successfully
        entity_id:
          type: string
          format: uuid
          title: Entity Id
          description: ID of the user or workspace that completed onboarding
        entity_type:
          type: string
          title: Entity Type
          description: 'Type of entity: ''user'' or ''workspace'''
        completed_at:
          type: string
          format: date-time
          title: Completed At
          description: Timestamp when onboarding was completed
        message:
          type: string
          title: Message
          description: Success message
      type: object
      required:
      - success
      - entity_id
      - entity_type
      - completed_at
      - message
      title: CompleteOnboardingResponse
      description: Response schema for onboarding completion.
      example:
        completed_at: '2025-10-11T12:00:00'
        entity_id: 123e4567-e89b-12d3-a456-426614174000
        entity_type: workspace
        message: Workspace onboarding completed successfully
        success: true
    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
    CompleteWorkspaceOnboardingRequest:
      properties:
        location:
          anyOf:
          - $ref: '#/components/schemas/LocationData'
          - type: 'null'
          description: Default location configuration for the workspace
      type: object
      title: CompleteWorkspaceOnboardingRequest
      description: Request schema for completing workspace onboarding.
      example:
        location:
          city: San Francisco
          country: US
          region: CA
  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