Skip to main content
GET
Get a reservation
Reserved TPM is in Beta and available to select pilot customers. To join the waitlist, send us a note from the support form in your Sail dashboard (recommended), or contact support.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

reservation_id
string
required

The reservation ID, starting with rtpm_.

Response

The reservation.

id
string
required

The reservation ID. It starts with rtpm_.

Pattern: ^rtpm_
object
enum<string>
required
Available options:
reserved_tpm
model
string
required

The reserved model.

service_tier
enum<string>
required

The reserved service tier.

Available options:
asap,
balanced,
flex
starts_at
string<date-time>
required

When the reservation starts.

ends_at
string<date-time>
required

When the reservation ends.

duration_hours
integer
required

The reservation's length in hours.

uncached_input_tpm
integer
required

Reserved uncached input tokens per minute.

output_tpm
integer
required

Reserved output tokens per minute.

routing
object | null
required

Where the reservation's requests run, or null when unrestricted.

price
object | null
required

What the reservation costs, or null when it is not charged.

prepayment
object | null
required

How much of the prepaid price is used and left. Null unless the reservation was charged and is booked or cancelled, and null after a refund. It can keep updating for a few hours after the reservation ends.

free_cancel_until
string<date-time> | null
required

When a free cancel stops being available, or null when cancelling now would not be refunded. See Cancel a reservation.

refund
object | null
required

The refund of a free cancel, or null.

status
enum<string>
required

pending_charge while payment is processing, then booked. charge_failed means nothing was charged and the capacity was released. cancelled means you cancelled it.

Available options:
pending_charge,
booked,
charge_failed,
cancelled
created_at
string<date-time>
required

When the reservation was made.

updated_at
string<date-time>
required

When the reservation last changed.

cancelled_at
string<date-time> | null
required

When you cancelled the reservation, or null.

current_minute
object | null

How much of the reservation's uncached input and output TPM is left in the current minute, or null when it isn't running. Only Get a reservation returns it. See Get a reservation.