NudgeLink Onboarding API

The onboarding API from NudgeLink — 12 operation(s) for onboarding.

GitHub OpenAPI

Operations 13

GET /api/v1/onboarding/icp Get Icp #
PATCH /api/v1/onboarding/icp Update Icp #
POST /api/v1/onboarding/generate-icp Generate Icp #
POST /api/v1/onboarding/angle-samples Angle Samples #
POST /api/v1/onboarding/voice-preview Voice Preview #
POST /api/v1/onboarding/approve-icp Approve Icp #
GET /api/v1/onboarding/keyword-suggestions List Keyword Suggestions #
POST /api/v1/onboarding/keyword-suggestions/{suggestion_id} Decide Keyword Suggestion #
POST /api/v1/onboarding/extract-voice Extract Voice #
POST /api/v1/onboarding/update-business Update Business #
GET /api/v1/onboarding/wizard/state Get Wizard State #
POST /api/v1/onboarding/wizard/advance Advance Wizard #
POST /api/v1/onboarding/wizard/skip Skip Wizard Step #

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/nudgelink-co:nudgelink-co-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

nudgelink-co-onboarding-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: NudgeLink Onboarding API
  version: 0.1.0
tags:
- name: Onboarding
paths:
  /api/v1/onboarding/icp:
    get:
      tags:
      - Onboarding
      summary: Get Icp
      description: Return current stored ICP + style profile.
      operationId: get_icp_api_v1_onboarding_icp_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Get Icp Api V1 Onboarding Icp Get
      security:
      - HTTPBearer: []
    patch:
      tags:
      - Onboarding
      summary: Update Icp
      description: 'Edit the ICP body (summary / criteria / keywords / sample_message) in

        place — no AI regenerate. Unlike ``approve-icp`` (used at onboarding), this

        deliberately does NOT touch ``style_profile``, so tweaking the ICP never

        wipes the tone samples the client has taught the system through message

        edits. Structured facets (locations/industries/skills) and calibration

        anchors are preserved untouched.'
      operationId: update_icp_api_v1_onboarding_icp_patch
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ICPUpdateRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ICPResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/onboarding/generate-icp:
    post:
      tags:
      - Onboarding
      summary: Generate Icp
      description: 'Claude produces ICP proposal. Client reviews & approves separately.


        Accepts a lenient body (see :class:`GenerateICPInput`) and backfills

        any missing/short field from the user''s already-saved profile. This

        is what makes Regenerate work after a hard refresh on Step 2 even

        when the FE no longer has the business inputs in component state.'
      operationId: generate_icp_api_v1_onboarding_generate_icp_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateICPInput'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ICPResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/onboarding/angle-samples:
    post:
      tags:
      - Onboarding
      summary: Angle Samples
      description: 'Onboarding v2 (2026-07-28), wizard 2.4: real sample first messages per

        campaign angle for THIS business — the figma block marked "добавим позже".


        Accepts the same lenient body as /generate-icp (backfills from the stored

        profile). Best-effort by contract: any provider failure returns empty

        samples and the frontend hides the block — a nicety must never 502 the

        wizard.'
      operationId: angle_samples_api_v1_onboarding_angle_samples_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateICPInput'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Angle Samples Api V1 Onboarding Angle Samples Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/onboarding/voice-preview:
    post:
      tags:
      - Onboarding
      summary: Voice Preview
      description: 'Onboarding v2 (2026-07-28), wizard 2.3: hear one message in the voice

        just described, before the campaign exists (figma''s live sound preview).


        Fail-soft by contract, like /angle-samples: any provider failure returns an

        empty preview and the frontend keeps the wizard moving.'
      operationId: voice_preview_api_v1_onboarding_voice_preview_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VoicePreviewInput'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Voice Preview Api V1 Onboarding Voice Preview Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/onboarding/approve-icp:
    post:
      tags:
      - Onboarding
      summary: Approve Icp
      description: Persist ICP + style_profile to the client.
      operationId: approve_icp_api_v1_onboarding_approve_icp_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ICPApproveRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ICPResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/onboarding/keyword-suggestions:
    get:
      tags:
      - Onboarding
      summary: List Keyword Suggestions
      description: 'Pending keyword suggestions for the current client (newest first).


        ``campaign_id`` narrows to that campaign''s suggestions (2026-07-28: the

        card lives on Campaign → Settings for campaign-first clients). Omitted =

        every pending suggestion, which is what the legacy Settings → ICP card

        expects — do not narrow that default or un-flipped clients stop seeing

        rows created before Alembic 047.'
      operationId: list_keyword_suggestions_api_v1_onboarding_keyword_suggestions_get
      security:
      - HTTPBearer: []
      parameters:
      - name: campaign_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Campaign Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/KeywordSuggestionOut'
                title: Response List Keyword Suggestions Api V1 Onboarding Keyword Suggestions Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/onboarding/keyword-suggestions/{suggestion_id}:
    post:
      tags:
      - Onboarding
      summary: Decide Keyword Suggestion
      description: 'Accept (merge into icp.keywords, case-insensitive dedup) or reject a

        pending suggestion. Returns the resulting ICP either way so the UI can

        refresh from one response.


        2026-07-28: with ``campaign_id`` the merge target is that campaign''s

        ``icp_override`` — the ICP campaign-first discovery actually searches with.

        Without it, the account ICP, unchanged for un-flipped clients.'
      operationId: decide_keyword_suggestion_api_v1_onboarding_keyword_suggestions__suggestion_id__post
      security:
      - HTTPBearer: []
      parameters:
      - name: suggestion_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Suggestion Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KeywordSuggestionDecision'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ICPResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/onboarding/extract-voice:
    post:
      tags:
      - Onboarding
      summary: Extract Voice
      description: 'Doc п.5 — learn the client''s real voice from their own writing and store

        it as the style_profile, so drafts sound like THEM rather than the

        synthetic house default ("Sofia''s voice"). The main lever against every

        client sounding identical.'
      operationId: extract_voice_api_v1_onboarding_extract_voice_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExtractVoiceRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Extract Voice Api V1 Onboarding Extract Voice Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/onboarding/update-business:
    post:
      tags:
      - Onboarding
      summary: Update Business
      operationId: update_business_api_v1_onboarding_update_business_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OnboardingInput'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
                title: Response Update Business Api V1 Onboarding Update Business Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/onboarding/wizard/state:
    get:
      tags:
      - Onboarding
      summary: Get Wizard State
      description: 'Return the user''s current wizard step.


        If ``Client.onboarding_state`` is NULL (user pre-dates the wizard

        or has never opened it) the response is derived from data shape so

        the UI can drop them on the right step without a backfill.'
      operationId: get_wizard_state_api_v1_onboarding_wizard_state_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WizardStateOut'
      security:
      - HTTPBearer: []
  /api/v1/onboarding/wizard/advance:
    post:
      tags:
      - Onboarding
      summary: Advance Wizard
      description: 'Move the wizard to the requested step.


        Validation:


        * Step must be in the known vocabulary.

        * Cannot forward-skip more than one step (e.g. business → discover

        is rejected). ``done`` is always reachable as an explicit dismiss.

        * Going back is allowed (re-edit your ICP).


        Returns the new state. 400 on illegal transition.'
      operationId: advance_wizard_api_v1_onboarding_wizard_advance_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WizardAdvanceRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WizardStateOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/onboarding/wizard/skip:
    post:
      tags:
      - Onboarding
      summary: Skip Wizard Step
      description: 'Mark a step as skipped and advance to the next.


        Legacy flavour: ``linkedin`` and ``discover``. Campaign-first (v2):

        only ``connect_linkedin``. The wizard banner on the dashboard will

        keep nagging until the skipped step is later completed (or the user

        explicitly dismisses the whole wizard with POST /wizard/advance

        step=done).'
      operationId: skip_wizard_step_api_v1_onboarding_wizard_skip_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WizardSkipRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WizardStateOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
components:
  schemas:
    WizardStateOut:
      properties:
        step:
          type: string
          title: Step
        completed_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Completed At
        first_discovery_run_id:
          anyOf:
          - type: string
          - type: 'null'
          title: First Discovery Run Id
        skipped:
          additionalProperties:
            type: string
          type: object
          title: Skipped
        source:
          type: string
          title: Source
        first_campaign_id:
          anyOf:
          - type: string
          - type: 'null'
          title: First Campaign Id
        all_steps:
          items:
            type: string
          type: array
          title: All Steps
      type: object
      required:
      - step
      - source
      title: WizardStateOut
      description: 'Response shape for the wizard endpoints.


        Mirrors :class:`app.services.onboarding_wizard.WizardState` but

        declared here so FastAPI can generate the OpenAPI schema without

        importing the dataclass.'
    GenerateICPInput:
      properties:
        company_pitch:
          anyOf:
          - type: string
            maxLength: 5000
          - type: 'null'
          title: Company Pitch
        target_persona:
          anyOf:
          - type: string
            maxLength: 5000
          - type: 'null'
          title: Target Persona
        tone_prefs:
          anyOf:
          - type: string
            maxLength: 5000
          - type: 'null'
          title: Tone Prefs
        website_url:
          anyOf:
          - type: string
            maxLength: 2048
          - type: 'null'
          title: Website Url
      type: object
      title: GenerateICPInput
      description: 'Loose variant of ``OnboardingInput`` for ``/onboarding/generate-icp``.


        The fields are all optional so the FE can hit Regenerate without

        re-sending the business inputs every time — the endpoint backfills

        from the user''s already-saved ``Client.icp_profile``. The endpoint

        itself enforces that *some* source (request body or stored profile)

        yields ≥ 10 char strings for all three fields before invoking

        Claude, and returns a clear 400 with the field name otherwise.'
    KeywordSuggestionDecision:
      properties:
        action:
          type: string
          pattern: ^(accept|reject)$
          title: Action
        campaign_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Campaign Id
      type: object
      required:
      - action
      title: KeywordSuggestionDecision
    ICPResponse:
      properties:
        summary:
          type: string
          title: Summary
        criteria:
          items:
            type: string
          type: array
          title: Criteria
        keywords:
          items:
            type: string
          type: array
          title: Keywords
        style_notes:
          items:
            type: string
          type: array
          title: Style Notes
        sample_message:
          type: string
          title: Sample Message
        locations:
          items:
            type: string
          type: array
          title: Locations
        industries:
          items:
            type: string
          type: array
          title: Industries
        skills:
          items:
            type: string
          type: array
          title: Skills
        titles:
          items:
            type: string
          type: array
          title: Titles
        calibration_anchors:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Calibration Anchors
        exclusions:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
          title: Exclusions
        product_summary:
          type: string
          title: Product Summary
          default: ''
      type: object
      required:
      - summary
      - criteria
      - keywords
      - style_notes
      - sample_message
      title: ICPResponse
    WizardAdvanceRequest:
      properties:
        step:
          type: string
          title: Step
          description: 'Legacy: business|icp|linkedin|discover|done. Campaign-first (v2): connect_linkedin|create_campaign|done — discovery is no longer an onboarding step.'
        first_discovery_run_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: First Discovery Run Id
        first_campaign_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: First Campaign Id
        dismiss:
          type: boolean
          title: Dismiss
          default: false
      type: object
      required:
      - step
      title: WizardAdvanceRequest
    KeywordSuggestionOut:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        keywords:
          items:
            type: string
          type: array
          title: Keywords
        reason:
          anyOf:
          - type: string
          - type: 'null'
          title: Reason
      type: object
      required:
      - id
      - keywords
      - reason
      title: KeywordSuggestionOut
    VoicePreviewInput:
      properties:
        company_pitch:
          anyOf:
          - type: string
            maxLength: 5000
          - type: 'null'
          title: Company Pitch
        target_persona:
          anyOf:
          - type: string
            maxLength: 5000
          - type: 'null'
          title: Target Persona
        tone_prefs:
          anyOf:
          - type: string
            maxLength: 5000
          - type: 'null'
          title: Tone Prefs
        website_url:
          anyOf:
          - type: string
            maxLength: 2048
          - type: 'null'
          title: Website Url
        tone_samples:
          anyOf:
          - items:
              type: string
            type: array
            maxItems: 10
          - type: 'null'
          title: Tone Samples
        language:
          anyOf:
          - type: string
            maxLength: 100
          - type: 'null'
          title: Language
      type: object
      title: VoicePreviewInput
      description: 'Wizard 2.3 preview body: the business inputs (lenient, same backfill as

        /generate-icp) plus the voice the user is typing RIGHT NOW.


        ``tone_samples`` mirrors :class:`ExtractVoiceRequest`''s bounds (≤10 items,

        ≤5000 chars each) so the same paste can''t be accepted here and rejected

        there — and so the prompt stays bounded regardless of what is pasted.'
    ICPUpdateRequest:
      properties:
        summary:
          anyOf:
          - type: string
            maxLength: 5000
          - type: 'null'
          title: Summary
        criteria:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Criteria
        keywords:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Keywords
        sample_message:
          anyOf:
          - type: string
            maxLength: 5000
          - type: 'null'
          title: Sample Message
        exclusions:
          anyOf:
          - additionalProperties:
              items:
                type: string
              type: array
            type: object
          - type: 'null'
          title: Exclusions
      type: object
      title: ICPUpdateRequest
      description: 'Partial edit of the ICP body. Every field is optional; omitted fields

        keep their current value.'
    OnboardingInput:
      properties:
        company_pitch:
          type: string
          maxLength: 5000
          minLength: 10
          title: Company Pitch
          description: 1–3 sentence elevator pitch for the company.
        target_persona:
          type: string
          maxLength: 5000
          minLength: 10
          title: Target Persona
          description: Role, stage, industry and geography of the ideal customer.
        tone_prefs:
          type: string
          maxLength: 5000
          minLength: 10
          title: Tone Prefs
          description: How outreach messages should sound — tone, style, examples.
        industry:
          type: string
          title: Industry
          default: ''
        avg_deal_size_usd:
          anyOf:
          - type: number
          - type: 'null'
          title: Avg Deal Size Usd
        languages:
          items:
            type: string
          type: array
          maxItems: 20
          title: Languages
      type: object
      required:
      - company_pitch
      - target_persona
      - tone_prefs
      title: OnboardingInput
    ExtractVoiceRequest:
      properties:
        writing_samples:
          items:
            type: string
          type: array
          maxItems: 10
          minItems: 1
          title: Writing Samples
          description: 3-5 of the client's own posts / past DMs / emails. Their real voice is learned from these.
      type: object
      required:
      - writing_samples
      title: ExtractVoiceRequest
    WizardSkipRequest:
      properties:
        step:
          type: string
          title: Step
          description: 'Legacy: ''linkedin'' or ''discover''. Campaign-first (v2): only ''connect_linkedin''.'
        reason:
          anyOf:
          - type: string
            maxLength: 512
          - type: 'null'
          title: Reason
      type: object
      required:
      - step
      title: WizardSkipRequest
    ICPApproveRequest:
      properties:
        icp:
          $ref: '#/components/schemas/ICPResponse'
        edits:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Edits
      type: object
      required:
      - icp
      title: ICPApproveRequest
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      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:
    HTTPBearer:
      type: http
      scheme: bearer