KeyNest API

Name: KeyNest API
Brand: KeyNest API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentProductivityCollaborationapiKey14 EndpointsREST

For Agents

List physical key-exchange locations, register and manage keys, generate collection and drop-off codes, and run single key-exchange flows through 14 X-API-Key endpoints on the KeyNest network.

Install Jentic One Beta

Connect the KeyNest API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the KeyNest 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.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic 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 KeyNest API.

List the KeyNest store locations available to the authenticated account

Generate collection codes that authorise a third party to pick up a key

GET STARTED

Start building with KeyNest API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI specification for KeyNest API, keeping it validated and agent-ready. The KeyNest API lets partners and clients integrate with KeyNest's physical key exchange network — the system used by short-let hosts, estate agents, and property managers to drop off, store, and hand over physical keys. The 14 endpoints cover Keys (the registered key records), KeyNests (the physical store locations), Codes (collection codes and drop-off codes used to authorise pickup or drop-off), MyOffices, and the SingleKeyExchange flow that pairs one drop-off with one collection. Authentication is an X-API-Key header, and the base URL is https://api.keynest.com/api/v3.

Use Cases

Patterns agents use KeyNest API for, with concrete tasks.

★ Short-Let Guest Key Handover

Hand over a property's physical keys to a short-let guest by generating a collection code through the API, sending it to the guest, and letting them pick up the keys at the nearest KeyNest store. The flow uses POST /Codes/CollectionCode/{store} to create the code and GET /Codes/CollectionCode to track outstanding codes. Most hosts wire this into their reservation system in a single afternoon.

POST /Codes/CollectionCode/LOC01 with a key_id to issue a collection code, then send the code to the guest

Estate Agent Viewings Workflow

Coordinate viewings by registering each property's keys in KeyNest and issuing a fresh drop-off and collection code per agent visit. The drop-off endpoint returns a code the agent uses to leave the keys; the matching collection code lets the next agent pick them up without office hand-offs. The /SingleKeyExchange endpoints chain these into one record so the audit trail is complete.

POST /SingleKeyExchange to start an exchange, then POST /SingleKeyExchange/NextPair to advance through paired drop-off and collection codes

Property Manager Office Inventory

Keep an audit of which keys are registered to each office by listing keys with GET /Keys and store metadata via GET /KeyNests. Pair the data with the office record (/MyOffices) to produce a per-office inventory that surfaces missing or unaccounted-for keys before they cause a check-in delay.

GET /Keys for the authenticated account and join with GET /KeyNests to produce a per-store inventory of held keys

AI Agent Check-in Concierge

An AI agent that helps short-let guests check in uses Jentic to call KeyNest at the right moment — issuing a collection code when the booking is confirmed, surfacing the nearest store, and confirming when the code has been used. Jentic injects the X-API-Key per call so the agent never holds the raw key, and intent-based discovery selects the right operation among the 14 in the API.

Use Jentic to execute POST /Codes/CollectionCode/{store} with the guest's booking key_id and return the resulting code in the agent's reply

Key Endpoints

14 endpoints — jentic publishes the only available openapi specification for keynest api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

GET

/KeyNests

List available KeyNest store locations

GET

/Keys

List registered keys

POST

/Keys/LOC01

PUT

/Keys

Update a registered key

DELETE

/Keys/{KeyId}

Delete a registered key

POST

/Codes/CollectionCode/LOC01

Issue a collection code at a store

GET

/Codes/DropOffCode/{KeyId}

Get a drop-off code for a key

POST

/SingleKeyExchange

Start a single key exchange

GET

/KeyNests

List available KeyNest store locations

GET

/Keys

List registered keys

POST

/Keys/LOC01

PUT

/Keys

Update a registered key

DELETE

/Keys/{KeyId}

Delete a registered key

POST

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

The KeyNest X-API-Key is stored encrypted in the Jentic vault. Agents receive a scoped execution token at call time, so the raw key never enters the agent's context or logs.

Intent-based discovery

Agents search by intent (e.g. 'issue a keynest collection code') and Jentic returns the matching KeyNest operation with its input schema attached, so the agent does not have to navigate the 14-endpoint surface manually.

Time to first call

Direct KeyNest integration: half a day to a day for endpoint wiring, store-code handling, and error recovery. Through Jentic: under 30 minutes — search, load, execute.

FAQs

Specific to using KeyNest API through Jentic.

Why is there no official OpenAPI spec for KeyNest API?

KeyNest does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call KeyNest API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the KeyNest API use?

An X-API-Key header on every request. The key scopes calls to the partner account that issued it. Through Jentic the X-API-Key is held in the encrypted vault and injected per call so an agent never sees the raw key.

Can I issue a collection code with the KeyNest API?

Yes. POST /Codes/CollectionCode/{store} with the key_id and any optional metadata returns a collection code for the named store. Send the code to the recipient — they can then pick up the keys at that KeyNest location without involving you in person.

What are the rate limits for the KeyNest API?

The OpenAPI spec does not publish a rate limit. With 14 endpoints the surface is small, so most callers stay well within whatever limits KeyNest applies at the platform level. If you receive HTTP 429, back off and retry the code-issuance call.

How do I run a single key exchange through Jentic?

Search Jentic for 'start a keynest single key exchange' to find POST /SingleKeyExchange, load its schema, and execute it. Then call POST /SingleKeyExchange/NextPair to advance through paired drop-off and collection codes. The Jentic flow is pip install jentic, then client.search, client.load, and client.execute.

Does the KeyNest API expose the list of available stores?

Yes. GET /KeyNests returns the store locations available to the authenticated account, including the location codes used in the path of the codes endpoints (for example /Codes/CollectionCode/LOC01).

KeyNest API

Connect the KeyNest API to your agent

Capabilities

Start building with KeyNest API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs