# Zeller AI API

> The public REST API for the Zeller AI real-estate platform: contacts, leads, messaging, calls,
> deals, listings, appointments and webhooks. Every send passes the same compliance gate the
> product uses, and webhook deliveries include AI-originated activity.

Every page below is also available as markdown by appending `.md` to its path.

## Docs

- [Zeller AI API](https://zellerai.co/developers.md): Build on your workspace: contacts, leads, messaging, calls, deals and webhooks over REST.
- [Authentication](https://zellerai.co/developers/auth.md): API keys, OAuth2 (authorization code + PKCE, client credentials), scopes and revocation.
- [Pagination, field masks & rate limits](https://zellerai.co/developers/pagination.md): Cursor pagination, ?fields= masking, and the rate-limit headers on every response.
- [Errors](https://zellerai.co/developers/errors.md): The one error envelope, the closed set of machine codes, and why a cross-workspace id is a 404.
- [Compliance](https://zellerai.co/developers/compliance.md): Why a send can be refused, what 422 compliance_blocked means, and the consent posture on created leads.
- [Webhooks](https://zellerai.co/developers/webhooks.md): Subscribing, verifying the HMAC signature, the retry policy, and the full event catalogue.
- [API reference](https://zellerai.co/developers/reference.md): Every endpoint, its scope and its semantics — generated from the route registry.
- [Versioning & deprecation](https://zellerai.co/developers/versioning.md): What is additive, what is breaking, and the 12-month deprecation window.
- [CLI](https://zellerai.co/developers/cli.md): The @reos/cli npm package: browser login, resource commands and four output formats.

## Machine-readable

- [OpenAPI 3.1 specification](https://zellerai.co/developers/openapi.json): every endpoint, schema and security scheme.

## Optional

- [Product site](https://zellerai.co): what the platform does, for a human audience.