# OpenLens

> Track brand visibility across the 7 AI platforms users actually use.

## Docs

- [Deprecated: schedule lives on the project (410 Gone)](https://docs.openlens.com/api-reference/account/deprecated:-schedule-lives-on-the-project-410-gone.md): Use `/projects/{id}/schedule` instead.
- [List the caller's allowed platforms (read-only entitlement)](https://docs.openlens.com/api-reference/account/list-the-callers-allowed-platforms-read-only-entitlement.md)
- [Return the caller's effective rate limits and quotas](https://docs.openlens.com/api-reference/account/return-the-callers-effective-rate-limits-and-quotas.md)
- [Token usage and scraper spend, aggregated by model and call type](https://docs.openlens.com/api-reference/account/token-usage-and-scraper-spend-aggregated-by-model-and-call-type.md)
- [Top cited domains for the latest run](https://docs.openlens.com/api-reference/citations/top-cited-domains-for-the-latest-run.md)
- [Top topics where your own brand was mentioned, with the URLs cited](https://docs.openlens.com/api-reference/citations/top-topics-where-your-own-brand-was-mentioned-with-the-urls-cited.md)
- [Download a client-ready PDF visibility report](https://docs.openlens.com/api-reference/deliverables/download-a-client-ready-pdf-visibility-report.md): Renders a multi-page PDF for the chosen run. `runId` is required — the caller picks the run from `/reports/runs`. Optionally include the full per-prompt detail via `includePrompts=1`.
- [Recent run history for the report picker](https://docs.openlens.com/api-reference/deliverables/recent-run-history-for-the-report-picker.md)
- [AI-generated insight paragraph for one topic](https://docs.openlens.com/api-reference/metrics/ai-generated-insight-paragraph-for-one-topic.md): Synthesises visibility, attribute, and citation data for the topic into a 2–3 sentence actionable insight. Returns 404 when the project has no usable run or the topic is unknown.
- [Per-platform source behavior patterns for the latest run](https://docs.openlens.com/api-reference/metrics/per-platform-source-behavior-patterns-for-the-latest-run.md)
- [Time-series visibility for a brand or all competitors](https://docs.openlens.com/api-reference/metrics/time-series-visibility-for-a-brand-or-all-competitors.md)
- [Visibility scores for the latest usable run](https://docs.openlens.com/api-reference/metrics/visibility-scores-for-the-latest-usable-run.md): Default returns an array of `VisibilityScore` (one per brand). Use `type=topics` for a per-topic summary, `type=attributes&topicId=…` for a per-attribute breakdown, or `topicId=…` alone for a single topic's scores.
- [Analyze a brand or confirm a new project](https://docs.openlens.com/api-reference/onboarding/analyze-a-brand-or-confirm-a-new-project.md): Two-step onboarding over Server-Sent Events. `action: analyze` researches a URL and proposes competitors and topics. `action: confirm` creates the project and generates prompts.
- [Add a brand (competitor or own)](https://docs.openlens.com/api-reference/resources/add-a-brand-competitor-or-own.md)
- [Add a custom prompt-attribute value](https://docs.openlens.com/api-reference/resources/add-a-custom-prompt-attribute-value.md)
- [Archive a custom prompt-attribute by value](https://docs.openlens.com/api-reference/resources/archive-a-custom-prompt-attribute-by-value.md)
- [Archive a project (soft delete)](https://docs.openlens.com/api-reference/resources/archive-a-project-soft-delete.md)
- [Create a new project](https://docs.openlens.com/api-reference/resources/create-a-new-project.md)
- [Create a prompt under a topic](https://docs.openlens.com/api-reference/resources/create-a-prompt-under-a-topic.md)
- [Create a topic; prompts are generated in the background](https://docs.openlens.com/api-reference/resources/create-a-topic;-prompts-are-generated-in-the-background.md)
- [Delete a brand](https://docs.openlens.com/api-reference/resources/delete-a-brand.md)
- [Delete a topic and its prompts](https://docs.openlens.com/api-reference/resources/delete-a-topic-and-its-prompts.md)
- [Get the project's active platforms and the caller's entitlement](https://docs.openlens.com/api-reference/resources/get-the-projects-active-platforms-and-the-callers-entitlement.md)
- [Get the project's scan schedule](https://docs.openlens.com/api-reference/resources/get-the-projects-scan-schedule.md)
- [List allowed prompt-attribute values for the project](https://docs.openlens.com/api-reference/resources/list-allowed-prompt-attribute-values-for-the-project.md)
- [List brands in a project (your own + competitors)](https://docs.openlens.com/api-reference/resources/list-brands-in-a-project-your-own-+-competitors.md)
- [List prompts, optionally filtered by topic or fetched by id](https://docs.openlens.com/api-reference/resources/list-prompts-optionally-filtered-by-topic-or-fetched-by-id.md)
- [List topics in a project](https://docs.openlens.com/api-reference/resources/list-topics-in-a-project.md)
- [List your projects](https://docs.openlens.com/api-reference/resources/list-your-projects.md)
- [Rename or archive an existing custom prompt-attribute](https://docs.openlens.com/api-reference/resources/rename-or-archive-an-existing-custom-prompt-attribute.md)
- [Set the project's active platforms](https://docs.openlens.com/api-reference/resources/set-the-projects-active-platforms.md)
- [Soft-delete a prompt](https://docs.openlens.com/api-reference/resources/soft-delete-a-prompt.md)
- [Update a brand's aliases](https://docs.openlens.com/api-reference/resources/update-a-brands-aliases.md)
- [Update a project](https://docs.openlens.com/api-reference/resources/update-a-project.md)
- [Update prompt text, attributes, or active flag](https://docs.openlens.com/api-reference/resources/update-prompt-text-attributes-or-active-flag.md): Editing prompt text after results exist will clone the prompt to preserve historical run identity. The first call returns 409 with `requiresConfirmation: true`; resend with `confirmClone: true` to commit.
- [Update the project's scan schedule](https://docs.openlens.com/api-reference/resources/update-the-projects-scan-schedule.md)
- [Cancel the running run for a project](https://docs.openlens.com/api-reference/runs/cancel-the-running-run-for-a-project.md)
- [Poll the status of a run](https://docs.openlens.com/api-reference/runs/poll-the-status-of-a-run.md): Pass `runId` for a specific run, or only `projectId` to fetch the project's most recent run. Returns `status: "none"` when no run exists yet.
- [Raw platform responses from the latest usable run](https://docs.openlens.com/api-reference/runs/raw-platform-responses-from-the-latest-usable-run.md): Returns enriched platform responses (one per prompt × platform) with brand mentions, citations, and attributes attached. Empty array when no usable run exists.
- [Start (or resume) a prompt run](https://docs.openlens.com/api-reference/runs/start-or-resume-a-prompt-run.md): Kicks off a fresh scan across the project's active platforms. Returns immediately with a `runId`. If a previous run was interrupted, this resumes it instead of starting a new one. Concurrent runs against the same project return 409.
- [Archive a workstream](https://docs.openlens.com/api-reference/workstreams/archive-a-workstream.md)
- [Create a workstream](https://docs.openlens.com/api-reference/workstreams/create-a-workstream.md)
- [List workstreams for a project](https://docs.openlens.com/api-reference/workstreams/list-workstreams-for-a-project.md)
- [Load a workstream's header and trend](https://docs.openlens.com/api-reference/workstreams/load-a-workstreams-header-and-trend.md)
- [Set the current goal on a workstream](https://docs.openlens.com/api-reference/workstreams/set-the-current-goal-on-a-workstream.md)
- [Top prompt movers and competitor share for a workstream](https://docs.openlens.com/api-reference/workstreams/top-prompt-movers-and-competitor-share-for-a-workstream.md)
- [Unarchive a workstream](https://docs.openlens.com/api-reference/workstreams/unarchive-a-workstream.md)
- [Update a workstream's name, topics, or attributes](https://docs.openlens.com/api-reference/workstreams/update-a-workstreams-name-topics-or-attributes.md)
- [Changelog](https://docs.openlens.com/changelog/overview.md): What's new in OpenLens.
- [How OpenLens sources data](https://docs.openlens.com/data-sources.md): Two channels, one schedule. What we measure and how.
- [Dashboard deep-dive](https://docs.openlens.com/how-tos/dashboard-deep-dive.md): What the dashboard numbers actually mean and what to do about a bad result.
- [How-tos](https://docs.openlens.com/how-tos/overview.md): Task-oriented guides for the most common OpenLens workflows.
- [Introduction](https://docs.openlens.com/introduction.md): Track brand visibility across the AI platforms users actually use.
- [Dashboard](https://docs.openlens.com/manual/dashboard.md): The home view of a project: visibility score and everything that explains it.
- [Onboarding](https://docs.openlens.com/manual/onboarding.md): Sign up, point at a website, run your first measurement.
- [Web UI manual](https://docs.openlens.com/manual/overview.md): What each surface of the OpenLens dashboard does and how to read it.
- [Prompt attributes](https://docs.openlens.com/manual/prompt-attributes.md): Labels on prompts that flow through the dashboard as filters.
- [Reports](https://docs.openlens.com/manual/reports.md): Client-ready PDF reports generated from your latest run.
- [Settings](https://docs.openlens.com/manual/settings.md): Per-client and account configuration.
- [Topic performance](https://docs.openlens.com/manual/topic-performance.md): Per-topic deep-dive: AI recommendation, trend, platform breakdown, engine behavior, citations.
- [Workstreams](https://docs.openlens.com/manual/workstreams.md): Goal-tracked clusters of topics and prompt attributes.
- [MCP server](https://docs.openlens.com/mcp/overview.md): Connect OpenLens to your AI agent. One OAuth sign-in, no API keys to copy.
- [MCP tools reference](https://docs.openlens.com/mcp/tools.md): Every tool the OpenLens MCP server exposes, grouped by surface.
- [Quickstart](https://docs.openlens.com/quickstart.md): Sign-up to first useful result in about 15 minutes.

## OpenAPI Specs

- [openapi](https://docs.openlens.com/api-reference/openapi.json)
- [openapi_spec](https://docs.openlens.com/openapi_spec.yaml)