KleverKey API
67
AI ReadinessAI-Aware (B)67/100
Agent-ready OpenAPI document · curated by JenticIOTDevice ManagementapiKey15 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Provision smart locks, issue access invitations, manage smart cards and gateways, and audit door events on the KleverKey access platform.
Use for: List the access groups for the organization with id 42, Issue an invitation to a guest for the meeting room lock, Retrieve the event log for the past 24 hours from KleverKey, Find all gateways registered to a given organization
Not supported: Does not handle CCTV video, alarm systems, or visitor identity verification - use for smart lock provisioning, access invitations, smart card management, and door event auditing only.
Jentic publishes the only available OpenAPI specification for KleverKey API, keeping it validated and agent-ready. KleverKey is a smart lock and access management platform for offices, co-working spaces, and short-term rentals. The API exposes organizations, access groups, smart cards, gateways, locks, invitations, bookings, lock activation links, and the underlying event log, so an operator can provision a lock fleet, hand out access invitations, and audit who entered which door. It is well suited for property managers and co-working operators who need programmatic access control alongside their booking system.
Install Jentic One Beta
Connect the KleverKey API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the KleverKey API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fkleverkey.com%2Fkleverkey" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fkleverkey.com%2Fkleverkey" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with KleverKey API.
Provision an organization and its access groups on KleverKey
Register and inspect smart locks attached to a KleverKey gateway
Issue an access invitation so a guest can unlock a specific door
Bind a physical smart card to a user inside an organization
Pull the event log to audit lock unlocks and access attempts
Manage bookings that grant time-bound access to a lock
Generate a lock activation link for a freshly installed device
Use Cases
Patterns agents use KleverKey API for, with concrete tasks.
★ Property Manager Access Control
Manage building access for a multi-tenant property without distributing keys. The /api/v1/organizations/{organizationId}/locks and /api/v1/organizations/{organizationId}/invitations endpoints let an operator add a lock, assign it to an access group, and invite a tenant in one workflow. Useful for serviced apartments, short-term rentals, and small property portfolios where tenants rotate frequently.
Create an invitation under organization 42 for guest email guest@example.com tied to lock id LK-001 valid until next Sunday.
Co-Working Booking Integration
Wire KleverKey into a co-working booking flow so a confirmed booking automatically unlocks the right door at the right time. The /api/v1/organizations/{organizationId}/bookings/{serviceName} endpoint creates a booking record bound to a lock and a window. Combined with the gateway and lock endpoints, an operator can run a fully automated unattended access flow for desks and meeting rooms.
Create a booking under organization 42 for service 'meeting-room-A' from 14:00 to 15:00 today for user member@example.com.
Access Audit and Event Reporting
Build a security audit feed by polling the KleverKey event log. The /api/v1/event-log endpoint returns lock unlocks, failed attempts, and gateway events that can be replayed into a SIEM, Slack channel, or compliance report. Best suited for facility managers who need a tamper-evident record of physical access for shared offices and regulated spaces.
Pull the KleverKey event log for the last 24 hours and post a summary of unlock events per lock to a Slack channel.
Smart Card Lifecycle Management
Manage the full lifecycle of physical smart cards in a KleverKey deployment. The /api/v1/organizations/{organizationId}/devices/smart-cards endpoint registers a card to a user and can revoke it later, so an HR or IT team can offboard departing staff without changing locks. Pairs naturally with HR systems that drive hiring and termination events.
Register a new smart card with id SC-99887 under organization 42 and bind it to user employee@example.com.
Agent-Driven Facility Operations via Jentic
Let an AI agent answer facility questions like 'who entered the lab last night' or 'invite this contractor for tomorrow' by calling KleverKey through Jentic. The agent searches Jentic for the right access operation, loads the schema, and executes with the API key drawn from your Jentic One instance. Far faster than wiring a custom KleverKey client into the operator's tooling.
Through Jentic, search for 'list KleverKey event log', load the /api/v1/event-log operation, and report failed unlock attempts in the last hour.
Key Endpoints
15 endpoints — jentic publishes the only available openapi specification for kleverkey api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
GET
/api/v1/event-log
Retrieve the access event log
GET
/api/v1/organizations
List organizations
GET
/api/v1/organizations/{organizationId}/locks
List locks for an organization
GET
/api/v1/organizations/{organizationId}/access-groups
List access groups
POST
/api/v1/organizations/{organizationId}/invitations
Send a guest access invitation
POST
/api/v1/organizations/{organizationId}/devices/smart-cards
Register a smart card
POST
/api/v1/organizations/{organizationId}/bookings/{serviceName}
Create a booking that grants access
GET
/api/v1/event-log
Retrieve the access event log
GET
/api/v1/organizations
List organizations
GET
/api/v1/organizations/{organizationId}/locks
List locks for an organization
GET
/api/v1/organizations/{organizationId}/access-groups
List access groups
POST
/api/v1/organizations/{organizationId}/invitations
Send a guest access invitation
POST
/api/v1/organizations/{organizationId}/devices/smart-cards
Register a smart card
POST
/api/v1/organizations/{organizationId}/bookings/{serviceName}
Create a booking that grants access
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
K
KleverKey API
- AI-Aware (B)67/100
85
Foundational Compliance63
Developer Experience & Jentic Compatibility51
AI-Readiness & Agent Experience94
Agent Usability50
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
85
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: ASignals: 4
98%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
42%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
63
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B-Signals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
51
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: C-Signals: 4
43%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
60%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
50
Security
Trust, risk posture, and security compliance.
Grade: C-Signals: 1
50%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring KleverKey by hand means learning its Authorization-header API key and handling the KleverKey API host and its errors yourself. Through Jentic you install once, import KleverKey from the API Directory, store the key once, and your agent calls it.
Permission scoping
KleverKey puts the organization id in the URL path (/organizations/{organizationId}/locks), so a rule can pin your agent to one organization: it can read that organization's locks and event logs and nothing else. You choose the operations it may call, so sending access invitations or issuing smart cards are not included unless you add them.
Credential isolation
Your KleverKey API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'list locks for an organization' or 'read door event logs', and Jentic returns the matching KleverKey operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
Complementary
Stripe API
Handles payment for the bookings that KleverKey grants access to
Use Stripe to charge for a booking, then call KleverKey to issue the matching invitation or booking that unlocks the door.
FAQs
Specific to using KleverKey API through Jentic.
Why is there no official OpenAPI spec for KleverKey API?
KleverKey does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call KleverKey API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.
What authentication does the KleverKey API use?
The KleverKey API uses an API key sent in the Authorization header on every request. Through Jentic, the API key is stored in your Jentic One instance and injected into the request at execution time so the agent never holds the raw key.
Can I issue a guest invitation through the KleverKey API?
Yes. POST /api/v1/organizations/{organizationId}/invitations creates a time-bound invitation for a specific lock or access group. The recipient receives a link they can use to unlock the door during the configured window.
What are the rate limits for the KleverKey API?
KleverKey does not publish a public rate limit and the spec does not declare one. Treat per-organization endpoints as moderately throttled and avoid tight polling on /api/v1/event-log; use longer windows or webhooks where available.
How do I audit door unlocks through Jentic?
Search Jentic for 'KleverKey event log', load the GET /api/v1/event-log operation, and execute with a time range. Jentic injects the API key from the vault and returns the structured event entries for the agent to summarise.
Does the KleverKey API expose smart card management?
Yes. POST /api/v1/organizations/{organizationId}/devices/smart-cards registers a card for an organization and binds it to a user. This makes onboarding and offboarding employees programmatic instead of a manual desk operation.
Can I limit what my agent is allowed to do with the KleverKey API?
Yes. Because you run Jentic One yourself, your own rules decide which KleverKey operations and credentials your agent may use. Since KleverKey puts the organization id in the URL path, such as /api/v1/organizations/{organizationId}/locks, you can pin the agent to a single organization so it only reads that organization's locks and event log. You choose the operations it may call, so writes like POST invitations or POST smart-cards stay off limits unless you explicitly allow them.
GET STARTED