NUDG3 Workspace Claim API

The Workspace Claim API from NUDG3 — 2 operation(s) for workspace claim.

GitHub OpenAPI

Operations 2

GET /public/claim/{claim_token} Get Claim Info #
POST /public/claim/workspace Claim Workspace #

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-workspace-claim-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-workspace-claim-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Nudg3 Workspace Claim 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: Workspace Claim
paths:
  /public/claim/{claim_token}:
    get:
      tags:
      - Workspace Claim
      summary: Get Claim Info
      description: 'Get information about a claimable workspace.


        Used to display the claim page with brand name and masked email.

        Returns whether the workspace has already been claimed.


        **No authentication required** - Uses claim token from URL.'
      operationId: get_claim_info_public_claim__claim_token__get
      parameters:
      - name: claim_token
        in: path
        required: true
        schema:
          type: string
          title: Claim Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClaimInfoResponse'
        '404':
          description: Invalid or expired token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClaimErrorResponse'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClaimErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /public/claim/workspace:
    post:
      tags:
      - Workspace Claim
      summary: Claim Workspace
      description: 'Claim a workspace and create user account.


        Creates a user account with the provided password, moves the company

        to the Free Trial agency, and starts a 7-day trial.


        Returns JWT access token for immediate auto-login.


        **No authentication required** - Uses claim token for authorization.'
      operationId: claim_workspace_public_claim_workspace_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClaimWorkspaceRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClaimWorkspaceResponse'
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClaimErrorResponse'
        '401':
          description: Invalid or expired token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClaimErrorResponse'
        '409':
          description: Already claimed or email exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClaimErrorResponse'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClaimErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ClaimInfoResponse:
      properties:
        success:
          type: boolean
          title: Success
          default: true
        brand_name:
          type: string
          title: Brand Name
          description: Brand name for the workspace
        masked_email:
          type: string
          title: Masked Email
          description: Partially masked email (e.g., s***@example.com)
        already_claimed:
          type: boolean
          title: Already Claimed
          description: Whether workspace is already claimed
          default: false
      type: object
      required:
      - brand_name
      - masked_email
      title: ClaimInfoResponse
      description: Response for claim info endpoint.
    ClaimWorkspaceRequest:
      properties:
        claim_token:
          type: string
          title: Claim Token
          description: Claim token from email link
        name:
          type: string
          maxLength: 255
          minLength: 1
          title: Name
          description: Full name for the account
        password:
          type: string
          minLength: 6
          title: Password
          description: Password for new account
      type: object
      required:
      - claim_token
      - name
      - password
      title: ClaimWorkspaceRequest
      description: Request to claim a workspace.
    ClaimWorkspaceResponse:
      properties:
        success:
          type: boolean
          title: Success
          default: true
        user_id:
          type: string
          title: User Id
          description: Created user UUID
        workspace_id:
          type: string
          title: Workspace Id
          description: Claimed workspace UUID
        firebase_custom_token:
          type: string
          title: Firebase Custom Token
          description: Firebase custom token for auto-login
        redirect_url:
          type: string
          title: Redirect Url
          description: URL to redirect after login
          default: /
        trial_end_date:
          type: string
          title: Trial End Date
          description: Trial expiration date (ISO format)
        message:
          type: string
          title: Message
          description: Success message
      type: object
      required:
      - user_id
      - workspace_id
      - firebase_custom_token
      - trial_end_date
      - message
      title: ClaimWorkspaceResponse
      description: Response after claiming workspace.
    ClaimErrorResponse:
      properties:
        success:
          type: boolean
          title: Success
          default: false
        error:
          type: string
          title: Error
          description: Error code
        message:
          type: string
          title: Message
          description: User-friendly error message
      type: object
      required:
      - error
      - message
      title: ClaimErrorResponse
      description: Error response for claim endpoints.
    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