Console Overview

SurfacedBy Console is a pay-as-you-go home for the SurfacedBy API. Sign up at console.surfacedby.com, load prepaid credits, and trigger on-demand AI visibility scans with your own keywords on the platforms you choose.

Console is open to anyone: no dashboard subscription required. If you already have a dashboard subscription, Console is a separate account that holds credits and gives you an API surface for triggering scans outside your monitored domains.

Two APIs, one platform

SurfacedBy exposes two REST APIs that share the same data model:

The two APIs are complementary. The Data API is about the data; the Console API is about running new scans.

When to use Console

Console is the right fit if any of these apply:

• You want to run a scan without subscribing to the dashboard.
• You want to scan domains that are not in your dashboard.
• You want to pick custom keywords and platforms per scan.
• You want a pay-per-use billing model instead of a subscription.
• You are building a tool that runs scans on behalf of end users and wants a clean API surface.

What happens when you trigger a scan

Every Console scan follows the same lifecycle:

1. You submit a scan with a list of keywords, a set of platforms, and any optional add-ons.
2. The required credits are deducted from your balance upfront. The exact cost is visible from the POST /scans/preview endpoint before you commit.
3. The scan runs in the background. You receive a scan id immediately.
4. You can poll the scan id, or subscribe to webhooks to be notified on completion.
5. If the scan fails at a terminal stage (not recoverable on our side), the credits are refunded to your balance automatically and a scan.failed webhook is delivered.

Next steps

• Credit model: how credits are calculated for every scan.
• Scan triggering: end-to-end example.
• Webhooks: receive scan lifecycle events.
• API reference: full Console endpoint catalog.