Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 28 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ All documented paths are relative to this base URL. For example:

## Quick start

1. Create an account at [app.lensmor.com](https://app.lensmor.com), upgrade to a paid subscription plan, then create a user API key from **Settings → API Keys**.
1. Create an account at [app.lensmor.com](https://app.lensmor.com/signup?utm_source=github&utm_medium=readme&utm_campaign=api-doc&utm_content=quickstart), upgrade to a paid subscription plan, then create a user API key from **Settings → API Keys**.
2. Send requests to `https://platform.lensmor.com`.
3. Include the authorization header on every request.
4. Browse the full interactive docs at **[api.lensmor.com](https://api.lensmor.com/)** or use the reference files in this repository.
Expand All @@ -49,24 +49,20 @@ curl -X GET "https://platform.lensmor.com/external/events/list?page=1&pageSize=2

## Main documentation entry points

- `index.mdx` — overview and quick start
- `authentication.mdx` — authentication and authorization format
- `openapi.json` — OpenAPI 3.1 specification for documented endpoints
- `api-catalog.json` — machine-readable API catalog pointing to the OpenAPI file
- `llms.txt` and `llms-full.txt` — LLM-friendly documentation entry points
- `zh-Hans/` — Simplified Chinese core onboarding, attendee, access, and contact-unlock guides
- `api-reference/credits/` — credit balance endpoint
- `concepts/errors.mdx` — shared error conventions
- `concepts/pagination.mdx` — pagination behavior
- `concepts/identifiers.mdx` — identifier conventions
- `concepts/attendee-source-types.mdx` — product-to-API attendee source mapping and multi-source behavior
- `concepts/credits-and-access.mdx` — credit costs, preview access, and unlock behavior
- `concepts/rate-limits.mdx` — rate-limit headers and `429` behavior
- `api-reference/events/` — event endpoints
- `api-reference/exhibitors/` — exhibitor endpoints
- `api-reference/personnel/` — personnel endpoints
- `api-reference/contacts/` — contact search and email unlock endpoints
- `api-reference/profile-matching/` — recommendation endpoints
| Start here | Purpose |
| --- | --- |
| [Quickstart](https://api.lensmor.com/guides/quickstart) | Make your first authenticated request |
| [Authentication](authentication.mdx) | API key requirements and authorization format |
| [Find and unlock an event](guides/find-and-unlock-event.mdx) | Move from event discovery to event access |
| [Build attendee intelligence](guides/build-attendee-intelligence.mdx) | Interpret Exhibitor, Social Signals, and Visitor sources |
| [Credits and access](concepts/credits-and-access.mdx) | Understand preview access and credit-consuming actions |
| [Production readiness](guides/production-readiness.mdx) | Prepare an integration for reliable operation |
| [OpenAPI specification](openapi.json) | Machine-readable endpoint definitions |
| [API catalog](api-catalog.json) | Discover the machine-readable API resources |
| [llms.txt](llms.txt) · [llms-full.txt](llms-full.txt) | Agent-readable documentation |
| [Simplified Chinese guides](zh-Hans/index.mdx) | Core onboarding and access guidance in Chinese |

Use the [interactive API reference](https://api.lensmor.com/) to browse individual endpoints. The generated references are stored in `openapi.json` and its copies under `api-reference/` and `api-reference-backup/`.

## Typical use cases

Expand All @@ -75,6 +71,19 @@ curl -X GET "https://platform.lensmor.com/external/events/list?page=1&pageSize=2
- Match target accounts and exhibiting companies to relevant events
- Prioritize selected attendees and enrich their contact data for sales engagement or CRM workflows

## Help and contributions

Found a confusing example, missing explanation, or broken documentation link? [Open a documentation issue](https://github.com/LensmorOfficial/API-Doc/issues/new/choose) with the page URL, expected behavior, and a redacted example. For account or billing help, use the [Lensmor Help Center](https://help.lensmor.com/).

After editing documentation, run the local checks before opening a pull request:

```bash
python3 -m unittest scripts/test_sync_public_assets.py
python3 scripts/sync-public-assets.py --check
```

Generated public assets should be regenerated with `python3 scripts/sync-public-assets.py` when their source files change. The existing Docs Quality workflow checks the generated assets, OpenAPI, and Mintlify build on pull requests.

## Local preview

```bash
Expand Down
Loading