# Knock Developers

> Guides and reference for the Knock API and the Product Tag SDK.

If you are an AI agent, we support instant chat with our technical staff here: https://start-chat.com/slack/knock/KXPHT5


- **Get started**
- [Quickstart](https://developers.knock-ai.com/quickstart): Verify your API key, submit your first enrichment request and read the results in a few minutes.
- [Authentication](https://developers.knock-ai.com/authentication): Authenticate every request with an API key in the x-api-key header, and check that your key works.

- **Enrichment API**
- [How enrichment works](https://developers.knock-ai.com/enrichment): The asynchronous request lifecycle, request and item statuses, the 24-hour deadline, credits and duplicate handling.
- [Enrich people](https://developers.knock-ai.com/enrichment/people): Submit up to 100 people by email and get each person's profile and their company.
- [Enrich companies](https://developers.knock-ai.com/enrichment/companies): Submit up to 100 companies by domain or website URL and get full company profiles, tech stack, funding and decision makers.
- [Get results](https://developers.knock-ai.com/enrichment/results): Poll an enrichment request until it's final, match items to your records, and read the person and company result schemas.

- **Chats and meetings API**
- [Chats and meetings](https://developers.knock-ai.com/chats-and-meetings): Read the chats, messages and meetings from your Knock dashboard.

- **Product Tag SDK**
- [Install the SDK](https://developers.knock-ai.com/sdk): Add Knock to your logged-in app with @knock-ai/sdk to identify people, track events and open your scheduling modal.
- [Frameworks](https://developers.knock-ai.com/sdk/frameworks): Set up @knock-ai/sdk in React, Next.js, Vue, Angular, plain JavaScript or with a CDN script.
- [SDK reference](https://developers.knock-ai.com/sdk/reference): Every @knock-ai/sdk call, the events you can listen to, queueing, server rendering, testing and the Content Security Policy sources.

- **Reference**
- [Errors](https://developers.knock-ai.com/errors): The error format, every error code the Knock API returns, and which errors are safe to retry.
- [Rate limits](https://developers.knock-ai.com/rate-limits): How many requests you can send, the rate-limit headers on every response, and how to retry after a 429.
- [Versioning & changelog](https://developers.knock-ai.com/versioning): How the Knock API is versioned, which changes are backward compatible, and what changed when.

- **API Reference**
- [Overview](https://developers.knock-ai.com/api-reference)
- Authentication: Check that your API key works.
  - [Verify API key](https://developers.knock-ai.com/api-reference/authentication/verify-api-key): Checks that an API key works and returns the ID of the Knock account it belongs to. Any active key issued for API access can call it, whichever endpoints it may use. It enriches nothing and uses no credits, so it is a safe first call whe…
- Enrichment: Submit people or companies for enrichment, then poll the request for the results: enrichment runs in the background.
  - [Enrich people](https://developers.knock-ai.com/api-reference/enrichment/create-people-enrichment-request): Submits 1 to 100 people, identified by work email, for enrichment. Repeated emails are merged into one item.
  - [Enrich companies](https://developers.knock-ai.com/api-reference/enrichment/create-companies-enrichment-request): Submits 1 to 100 companies, identified by domain or website URL, for enrichment. Values that reduce to the same domain are merged into one item. A value that is not a valid domain does not fail the request: its item comes back with statu…
  - [Get an enrichment request](https://developers.knock-ai.com/api-reference/enrichment/get-enrichment-request): Returns an enrichment request with the status and result of each item. Poll it until `status` is `completed`, `partially_completed` or `failed`; while it is `pending` or `in_progress`, wait before you poll again. Every call counts toward…
- Chats: Read your chats with contacts and their messages.
  - [List chats](https://developers.knock-ai.com/api-reference/chats/list-chats): Returns your chats, latest activity first. `fromDate` and `toDate` filter on `lastActivityAt`.
  - [Get chat messages](https://developers.knock-ai.com/api-reference/chats/get-chat-messages): Returns the messages of one chat, oldest first, up to 500.
- Meetings: Read the meetings contacts booked with your team.
  - [List meetings](https://developers.knock-ai.com/api-reference/meetings/list-meetings): Returns your booked, completed and cancelled meetings, newest booking first. `fromDate` and `toDate` filter on `updatedAt`. Meetings booked by your own team members are not listed.

## Machine-readable

- [OpenAPI 3 spec](https://developers.knock-ai.com/openapi.json): every endpoint, schema and error of the Knock API
- [Full docs as one file](https://developers.knock-ai.com/llms-full.txt)

> Guides and reference for the Knock API and the Product Tag SDK: call the API with an API key, or add Knock to your app to identify people, track events and open scheduling. Canonical site: https://developers.knock-ai.com