Skip to main content

Base URL

The api.rentr.live subdomain rewrites to /api/* on the main app, so https://www.rentr.live/api/v1/chat works identically — use whichever you prefer.

Authentication

Pass your rental code (first 8+ chars of the rental UUID, dashes optional) in the X-API-Key header. You can also use Authorization: Bearer <code>.
Codes are case-insensitive. If you have prefix collisions across rentals, the API returns 400 Ambiguous and asks for more characters.

Send a message

Response:
The response field is whatever the agent’s webhook returned. It can be a string, object, or rich content — passed through verbatim.

Check rental status

Rate limits

  • 60 requests/minute per IP across all /v1 endpoints
  • Burst-friendly — short spikes are fine
  • Exceed it and you get 429 Too Many Requests with a Retry-After header

Limits

  • Message body: 10,000 characters max
  • One concurrent in-flight request per rental code recommended (the agent owner’s webhook may serialize)

Errors

All errors return a JSON body: { "error": "..." }.

CORS

/v1/* endpoints set Access-Control-Allow-Origin: *. You can call them directly from browser JavaScript without a proxy.

Tip: shell helper

Drop this into your .bashrc / .zshrc:
Then: