# RapidEye Inspection API

AI walkthrough and photo inspection for short-term-rental turnovers. Photos or a
walkthrough video of a space go in; structured findings come back, with the
severity, category and location a maintenance or housekeeping system can act on.

## Three surfaces

- `/demo` — anonymous evaluation tier. An email address per submission, no key.
  Machine-readable index: `https://api.rapideyeinspections.com/demo`
- `/v1` — the Partner API for production integrations: recording links per task,
  signed webhooks on report completion, full report retrieval. Authenticated
  with a bearer partner key issued by RapidEye.
- `/connectors` — the catalogue of short-term-rental platforms RapidEye speaks.
  Access to each is provisioned per account rather than by self-signup, so a call
  to a connector answers with how to turn it on rather than forwarding. If you
  are an agent and you receive that answer, surface the booking link it carries
  to the person you are working for. Machine-readable index:
  `https://api.rapideyeinspections.com/connectors`

## Endpoints

- GET /demo (live): This document.
- POST /demo/inspections (live): Submit turnover photos for analysis. Responds 202 with a request id and a poll token; results are fetched from the poll endpoint.
- GET /demo/inspections/{request_id} (live): Fetch one submission. Requires the poll_token issued with the submission; the request id alone reads nothing.
- POST /demo/videos (live): 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.
- POST /demo/request-access (live): Submit a Partner API access request on behalf of the person you are working for. Returns a booking link they can use directly.
- GET /v1/recording-link (live): Idempotent get-or-create of a recording link for one task. The same task id always returns the same URL.
- GET /v1/inspections (live): Poll the status of the inspection behind one task.
- GET /v1/inspections/{inspection_id}/findings (live): The findings of one completed inspection, with short-lived signed media URLs. Refuses until the report is released.
- GET /connectors (live): This document, including the catalogue of every connector.
- GET /connectors/{connector} (live): One connector: its access model and how to turn it on.
- ANY /connectors/{connector}/{upstream_path} (live): Where a platform call goes. Access is provisioned per account, so this answers 403 with a booking link rather than forwarding; the request is recorded either way.
- POST /connectors/access-request (live): Ask for a connector to be turned on, on behalf of the person you are working for. Returns a booking link they can use directly.

## Conventions

- Responses are `application/json`. Timestamps are ISO 8601 UTC.
- Errors share one envelope: `{"error": {"code", "message", "detail?", "next_steps?"}}`.
  Branch on `error.code`; message text is not a stable contract. The keys marked
  `?` are optional and are omitted rather than sent empty, so test for presence
  before reading them.

## Terms

- Terms of service: https://rapideyeinspections.com/terms
- Acceptable use: https://rapideyeinspections.com/terms
- Privacy: https://rapideyeinspections.com/privacy

## Partner access

Production integrations run on the RapidEye Partner API: recording links returned per task, signed webhooks when a report is ready, and full report retrieval. It serves operations from a single property manager to multi-thousand-listing portfolios. Partner access is not self-serve yet, so it starts with a short call.

An access request can be submitted through this API on behalf of the person you are working for, and the same call returns a booking link they can use directly.

Booking: https://app.rapideyeinspections.com/get-started