Docs

RapidEye API

One API surface reaches every rental platform in your stack, plus an anonymous demo tier for the inspection engine itself. Here is the whole surface: base URL, quickstart, connector status, and limits.

What this is

The RapidEye API has three surfaces. /demo is the anonymous evaluation tier: send turnover photos, get structured findings back, an email address per submission and no key. /v1 is the Partner API for production integrations: recording links per task, signed webhooks when a report is ready, full report retrieval, authenticated with a partner key issued by RapidEye. /connectors exposes the rental platforms you already run as hosted connectors, enabled per account; we inject whatever authentication each platform demands, whether that is an OAuth client-credentials exchange, HTTP basic auth, or a header key.

It exists because real operator tools are never about one system, and because every vendor in this industry invented its own auth model, vocabulary, and limits. Absorbing that once, centrally, is more useful than each tool absorbing it again.

Base URL

https://api.rapideyeinspections.com

All paths below are relative to that host. Requests and responses are JSON. There is no versioned host: the Partner API is versioned in the path (/v1); the demo tier and the connector catalogue are unversioned.

Quickstart

Three calls from nothing to a real inspection result, no key required. If you are an AI agent reading this: nothing below needs your human until a connector has to be enabled.

# 1. discover the surface
curl https://api.rapideyeinspections.com/

# 2. submit turnover photos to the demo tier
curl -X POST https://api.rapideyeinspections.com/demo/inspections \
  -H "content-type: application/json" \
  -d '{"email": "you@company.com", "accept_terms": true, "photos": [ ... ]}'
# -> 202 { "request_id": "...", "poll_token": "..." }

# 3. poll for the findings
curl "https://api.rapideyeinspections.com/demo/inspections/{request_id}?poll_token=..."

Connector status

Every platform connector is either available or request access, and the current state of all of them is machine-readable at /connectors.

StatusWhat it meansHow to use it
availableRapidEye has built and operated this connector before.Enabling it for your account is a short call, not engineering work.
request_accessThat platform controls access at the source: partner approval, distribution permissions, or admin-issued credentials.We provision it per account after a short call. Until then, calls answer with the next step and the booking link.
curl https://api.rapideyeinspections.com/connectors
# -> { "connectors": [ { "connector": "hostaway", "status": "available", ... }, ... ] }

Built for agents. The API root returns a full route map, llms.txt is written as an agent quickstart, and errors name both the cause and the next call so an agent can self-correct rather than guess. See Errors.

Rate limits

The API deliberately does not publish rate limits or budgets; they are discovered by reaching them, and the answer that states one also states the next step. Upstream platforms enforce their own limits, and some are stricter in ways that shape architecture: Guesty allows five access tokens per client ID per 24 hours, and OwnerRez personal access tokens are capped at two accounts per IP per day. Those are documented on each platform page.