Skip to main content
POST
Retrieve product knowledge across documents and code

Authorizations

x-api-key
string
header
required

Organization-scoped API key. Available scopes:

  • content:read: Read site pages, markdown content, and llms.txt files
  • content:write: Create, update, and delete site pages and content
  • prompts:read: Read prompts, topics, and prompt analysis results
  • prompts:write: Create, update, archive prompts
  • simulations:read: Read agent-simulation tasks, runs, environments, and analytics
  • simulations:write: Create and trigger simulation runs
  • logs:read: Read AI-traffic logs and request-level audit events
  • analytics:read: Read analytics aggregates (rankings, mentions, sources, SOV)
  • products:read: Read product metadata and competitor data
  • products:write: Update product settings and competitor lists

Path Parameters

productId
string
required
Minimum string length: 1

Body

application/json
query
string
required
Required string length: 1 - 2000
include
enum<string>[]
Required array length: 1 - 3 elements
Available options:
documents,
generated,
code
limit
integer
default:12
Required range: 1 <= x <= 50

Response

Successful response

ok
enum<boolean>
required
Available options:
true
data
object
required