SurfacedBySurfacedBy Docs
DocumentationConsoleReference

Platforms

List the AI platforms a Console check can run on.

Ask an AI:Open in ChatGPTOpen in Claude

The platforms endpoint returns every AI platform a Console check can run on, so you do not have to hard-code the set. Use each entry's key in the platforms field when you preview or submit a check. Each entry also carries name, company, and enabled. enabled is false while a platform is paused; a check that names a paused platform is refused with 422 platform_unavailable and nothing is charged.

min_tier (a plan key: trial, starter, professional, or agency) and available_as_addon describe how the platform is packaged in dashboard subscriptions. They do not restrict Console checks: any listed platform can be selected, and the credit cost depends only on how many platforms you choose. See Credit model.

GET
/platforms
/platforms

Header Parameters

X-API-KeyX-Api-Key

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

Successful Response

null