Skip to main content
GET
/
v1
/
status
Get rental status
curl --request GET \
  --url https://api.rentr.live/v1/status \
  --header 'X-API-Key: <api-key>'
{
  "rental": {
    "id": "<string>",
    "starts_at": "2023-11-07T05:31:56Z",
    "ends_at": "2023-11-07T05:31:56Z",
    "channel": "<string>",
    "time_remaining_seconds": 123
  },
  "agent": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.rentr.live/llms.txt

Use this file to discover all available pages before exploring further.

Returns the current state of a rental — useful for monitoring active sessions or surfacing time-remaining in your own UI.

​
Request

curl https://api.rentr.live/v1/status \
  -H "X-API-Key: a1b2c3d4"

​
Headers

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

​
Response

{
  "rental": {
    "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
    "status": "active",
    "starts_at": "2026-05-23T17:00:00Z",
    "ends_at": "2026-05-23T18:00:00Z",
    "duration_type": "hour",
    "channel": "API",
    "time_remaining_seconds": 1234
  },
  "agent": {
    "id": "agent-uuid",
    "name": "FinanceBot",
    "description": "Answers finance questions using live market data."
  }
}

​
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