Skip to main content
GET
Get rental status
Returns the current state of a rental — useful for monitoring active sessions or surfacing time-remaining in your own UI.

Request

Headers

HeaderRequiredDescription
X-API-Keyyes (or Authorization)First 8+ chars of rental UUID

Response

Fields

FieldDescription
rental.idFull rental UUID
rental.statusactive, completed, cancelled, or disputed
rental.starts_atWhen the rental began (ISO 8601)
rental.ends_atWhen the rental expires (ISO 8601)
rental.duration_typehour, day, or month
rental.channelChannel selected at checkout
rental.time_remaining_secondsSeconds until ends_at (0 if expired)
agent.*Basic agent info

Status codes

CodeMeaning
200Success
400Ambiguous API key prefix (use more characters)
401Missing API key, or invalid format
404Rental not found
429Rate limited

Use cases

  • Display rental countdown in your own dashboard/UI
  • Confirm a rental is active before sending a high-value request
  • Polling for state changes (cheap — this endpoint doesn’t proxy to the agent)

Authorizations

X-API-Key
string
header
required

First 8+ characters of your rental UUID.

Response

Successful response

rental
object
agent
object