White Label API¶

The nBlick White Label API lets a partner backend create a workspace for each customer website, run AI visibility reports, read the resulting recommendations, and generate supported article and social content. It is a server-to-server API: the partner-specific hostname selects the tenant, a bearer API key authenticates the caller, and scopes authorize each operation.

flowchart TB
    product[Partner backend] -->|HTTPS request| api[White Label API<br/>Host + bearer key + scope]
    api --> workspace[Customer workspace<br/>Website + enabled models]
    workspace --> report[Visibility report<br/>Scores + opportunities]
    report --> action[Actions<br/>Recommendations]
    action --> output[Generated output<br/>Article or social post]

Core integration flow¶

flowchart TB
    A[Create or reuse<br/>workspace] --> B[Launch<br/>visibility report]
    B --> C{Poll report}
    C -->|queued / running| C
    C -->|completed| D[Read report<br/>and actions]
    C -->|failed| E[Read error]
    D --> F{Executable action?}
    F -->|No| G[Implement manually]
    F -->|Yes| H[Launch action<br/>execution]
    H --> I{Poll execution}
    I -->|queued / running| I
    I -->|succeeded| J[Retrieve output<br/>and images]
    I -->|failed| K[Read error]

Workspaces, reports, actions, and executions belong to the authenticated partner tenant. X-External-Actor-Id can carry an optional partner-side trace identifier, but it does not own resources or grant access.

Start here¶

1. Follow the Quickstart for the complete workspace-to-content workflow.
2. Read the Integration Model before mapping customer accounts and projects.
3. Review Authentication & Hostnames before sending production traffic.
4. Use Workspaces, Visibility Reports, and Actions & Generated Content for practical endpoint guides.
5. Use the API Reference for the complete endpoint and schema summary.