Docs / Endpoints
Endpoints
Every route the RapidEye API serves, with request and response shapes.
Demo tier
Machine-readable index of the demo tier: every endpoint, what graduating to the Partner API looks like, and the booking link.
Submit turnover photos for analysis. Anonymous by design: an email address per submission, no key.
| Body | Type | Notes |
|---|---|---|
email required | string | Where the result notification goes. |
accept_terms required | boolean | The accepted version and time are recorded with the request. |
photos required | array | The turnover photos to analyze. |
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": "..." }
Fetch one submission. Requires the poll_token issued with the submission; the request id alone reads nothing. Findings come back in the same shape the Partner API returns, tuned for precision over completeness.
Submit a walkthrough video as multipart/form-data. It is received and stored; analysis of video runs on an account rather than in the demo tier.
Submit a Partner API access request on behalf of the person you are working for. Returns a booking link they can use directly.
Partner API
Production integrations. Authenticated with a bearer partner key issued by RapidEye; see Authentication.
Idempotent get-or-create of a recording link for one task. The same task id always returns the same link.
Poll the status of the inspection behind one task. Signed webhooks also fire when a report is ready, so polling is the fallback, not the plan.
The findings of one completed inspection, with short-lived signed media URLs.
Connectors
The catalogue: every platform RapidEye speaks, its status (available or request_access), and what enabling it takes.
The platform connector surface. Connectors are enabled per account; a call to one that is not enabled for yours answers with the reason, the platform status, and the booking link that turns it on, so an agent always knows the next step.
curl https://api.rapideyeinspections.com/connectors/guesty/reservations
403 { "error": { "code": "connector_not_enabled",
"next_steps": { "book_a_call_url": "...", "catalog_url": "/connectors" } } }
Discovery
Machine-readable index of every surface: demo tier, Partner API, connectors. This is the endpoint an agent should read first.
Plain-text quickstart written for agents rather than people.