SurfacedBySurfacedBy Docs
DocumentationAPIReference

Platforms

List the AI platforms SurfacedBy checks and which plan or add-on includes each one.

Ask an AI:Open in ChatGPTOpen in Claude

The platforms endpoint lists every AI platform SurfacedBy supports, in display order, whatever plan your workspace is on. Use it to map platform keys that appear in other responses to display names, and to see how each platform is made available.

Read-only and available on Professional and Agency.

Platform object

FieldDescription
keyThe platform key used across the API, for example chatgpt or ai_mode.
nameDisplay name, for example "Google AI Mode".
companyThe company behind the platform.
min_tierThe lowest plan that includes the platform, or null when no plan includes it: trial, starter, professional, or agency. trial means every plan that runs checks (Trial, Starter, Professional, and Agency); professional means Professional and Agency.
available_as_addontrue when no plan includes the platform and it is sold as an add-on to a paid plan instead.
available_in_free_auditWhether the free AI visibility audit covers the platform.
enabledAlways true.

Exactly one of min_tier and available_as_addon applies to each platform. Whether your workspace has an add-on is not part of this response.

GET
/platforms
/platforms

Header Parameters

X-API-KeyX-Api-Key

curl -X GET "https://api.surfacedby.com/api/v1/ext/platforms" \
  -H "X-API-Key: string"

Successful Response

null

On this page