Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.openlens.com/llms.txt

Use this file to discover all available pages before exploring further.

Almost everything on the Settings page is per-client (per project). Brand profile, location, languages, prompt attributes, competitors, AI platforms, scheduled runs, even Delete client. All scoped to the client you have open. The one exception is API keys, which are account-wide and authenticate every project under your account.

​
Your brand

The client’s brand profile.
  • Name. How your brand should be detected in AI responses.
  • Website URL. Locks the brand to a specific domain.
  • Aliases. Multi-tag input. Add any names the AI might use that aren’t the main brand name. Nicknames, sub-brands, common misspellings. The matcher checks aliases too when scoring brand mentions.

​
Location and languages

Used to generate location-aware prompts in the right language(s).
  • Location. Free text like ‘Pittsburgh, PA’. Affects prompt generation when the topic is regional.
  • Languages. Multi-tag input. Each language present here gets prompts generated in it during onboarding and any time you regenerate.

​
Prompt attributes

The labels you can assign to prompts for this client.
  • Reserved attributes. Built-in, can’t be archived. Currently includes branded, auto-assigned to prompts that name a brand.
  • Custom attributes. Whatever you want, scoped to this client. Type the name, click Add. Examples: pricing, enterprise-readiness, awareness-stage.
For the full mechanics of how attributes flow through the dashboard, see Prompt attributes.

​
Competitors

The brands you want to track alongside yours.
  • Each competitor has a name and an optional website URL.
  • Each competitor has its own aliases, same as your own brand.
  • Use the URL when the competitor’s name is common enough that the matcher might pick up the wrong company.

​
AI platforms

The platforms this project queries on each run. Each row shows the data channel for that platform.
PlatformChannel
ChatGPTWeb
PerplexityWeb
Google AIWeb
GeminiWeb
GrokWeb
ClaudeAPI
DeepSeekAPI
Toggle individual platforms on or off. Web platforms use the consumer chat surface. API platforms use the public API. See How OpenLens sources data for the mechanics.

​
Scheduled runs

Auto-run on a schedule so your visibility data stays current without you clicking Run.
  • Enable toggle. Off means no auto-runs. You can still trigger runs on-demand anytime.
  • Frequency. Daily, weekly, or monthly.
  • Time. A time of day in UTC.
  • Next run preview. Shows the next scheduled run in your local timezone so you know exactly when it’ll fire.
On-demand runs are independent of the schedule. Three paths to trigger one:
  • The Run queries button at the top of the dashboard.
  • POST /api/prompts/run via the REST API.
  • The run_prompts tool via MCP.
Run on-demand before a client call without disturbing the recurring cadence.

​
Account (account-wide)

The one section on Settings that isn’t scoped to the client you have open.

​
API keys

Account-wide credentials for programmatic access to the OpenLens REST API. One key authenticates against every project under your account.
  • Each key has a name for your own bookkeeping, plus created and last used dates.
  • Send every API request with the key in the Authorization header:
Authorization: Bearer <your_key>
  • Create as many keys as you need. Delete any key from the Actions column.
  • See REST API for the worked walkthrough.

​
Delete client

Removes the project from your dashboard. The underlying data isn’t dropped. Reach out to support if you ever need it restored.