Request a robot lease
request_leaseRequest a time-boxed lease on a listing (listing_id from browse_listings) for your account. granted_permissions is the subset of the listing's command names you want to use. A GetBody operator approves each lease request: it stays REQUESTED until then (poll get_lease), then CONFIRMED, or REJECTED with a reason. The robot is controlled one command at a time. Nothing is charged.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| currency | No | Payments are not enabled yet: must be null or omitted. | |
| body_kind | No | Which of the listing's bodies to lease; required when it offers both. | |
| listing_id | Yes | ||
| window_end | Yes | ISO 8601 datetime, after window_start. | |
| agreed_price | No | Payment isn't handled through the API (pricing and payouts: hello@getbody.md): must be null or omitted (else 400 payment_arranged_by_getbody). | |
| window_start | Yes | ISO 8601 datetime. | |
| granted_permissions | Yes | Subset of the listing's permissions_offered. |