Read a reservation

GET

credits

reservations

{reservation_id}

Read a reservation

curl --request GET \
  --url https://api.alguna.io/credits/reservations/{reservation_id} \
  --header 'Alguna-Version: <alguna-version>' \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.alguna.io/credits/reservations/{reservation_id}"

headers = {
    "Alguna-Version": "<alguna-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Alguna-Version': '<alguna-version>', Authorization: 'Bearer <token>'}
};

fetch('https://api.alguna.io/credits/reservations/{reservation_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.alguna.io/credits/reservations/{reservation_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Alguna-Version: <alguna-version>",
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.alguna.io/credits/reservations/{reservation_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Alguna-Version", "<alguna-version>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.alguna.io/credits/reservations/{reservation_id}")
  .header("Alguna-Version", "<alguna-version>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.alguna.io/credits/reservations/{reservation_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Alguna-Version"] = '<alguna-version>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "block_amount": "500",
  "closes": [
    {
      "capture_seq": 1,
      "close_key": "ik:close_run_88f_final",
      "closed": true,
      "covered": "80",
      "used": "80",
      "voided": true
    }
  ],
  "consumed": "266",
  "identities": [
    {
      "event_name": "inference_call",
      "metric_id": "mtr_tokens"
    }
  ],
  "open": true,
  "remaining": "234",
  "reservation_id": "crt_abc123",
  "status": "open",
  "expires_at": "2026-04-01T10:20:00Z",
  "expiry_frozen_reason": "billing_period_close"
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

Authorizations

Authorization

string

header

required

API key authentication. Pass your API key as a Bearer token.

Headers

Alguna-Version

enum<string>

required

Available options:

2026-04-01

Path Parameters

reservation_id

string

required

Unique identifier for the reservation

Response

Success

block_amount

string

required

Credits this reservation fenced when it opened.

Example:

"500"

closes

object[]

required

Every close already committed, oldest first. This is how a client that lost its Idempotency-Key discovers what already landed instead of resending and burning twice.

Show child attributes

consumed

string

required

What every close so far priced to: the sum of closes[].used, not of closes[].covered, less anything voided. Under on_envelope_exceeded: record a close can price past the hold, so this can exceed block_amount — and because remaining floors at zero, block_amount − consumed is not a way to derive it. Sum closes[].covered instead for what the ledger actually burned.

Example:

"266"

identities

object[]

required

The metrics this hold covers — one entry per credit-consuming metric its settles price against. A settle's events must carry event names these identities count.

Show child attributes

open

boolean

required

Whether the reservation can still be settled against.

remaining

string

required

Credits still authorised: block_amount − consumed, floored at zero. Zero once the reservation is terminal, whatever the arithmetic would otherwise allow.

Example:

"234"

reservation_id

string

required

Example:

"crt_abc123"

status

string

required

open, capturing, captured, released, expired, or recovery_pending.

Example:

"open"

expires_at

string<date-time> | null

When the hold expires. Absent once terminal.

Example:

"2026-04-01T10:20:00Z"

expiry_frozen_reason

string

Why the expiry stopped advancing, if it has. billing_period_close when an invoice close needs this hold to end.

Example:

"billing_period_close"

⌘I

Read a reservation

curl --request GET \
  --url https://api.alguna.io/credits/reservations/{reservation_id} \
  --header 'Alguna-Version: <alguna-version>' \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.alguna.io/credits/reservations/{reservation_id}"

headers = {
    "Alguna-Version": "<alguna-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Alguna-Version': '<alguna-version>', Authorization: 'Bearer <token>'}
};

fetch('https://api.alguna.io/credits/reservations/{reservation_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.alguna.io/credits/reservations/{reservation_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Alguna-Version: <alguna-version>",
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.alguna.io/credits/reservations/{reservation_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Alguna-Version", "<alguna-version>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.alguna.io/credits/reservations/{reservation_id}")
  .header("Alguna-Version", "<alguna-version>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.alguna.io/credits/reservations/{reservation_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Alguna-Version"] = '<alguna-version>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "block_amount": "500",
  "closes": [
    {
      "capture_seq": 1,
      "close_key": "ik:close_run_88f_final",
      "closed": true,
      "covered": "80",
      "used": "80",
      "voided": true
    }
  ],
  "consumed": "266",
  "identities": [
    {
      "event_name": "inference_call",
      "metric_id": "mtr_tokens"
    }
  ],
  "open": true,
  "remaining": "234",
  "reservation_id": "crt_abc123",
  "status": "open",
  "expires_at": "2026-04-01T10:20:00Z",
  "expiry_frozen_reason": "billing_period_close"
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

API Reference

Examples

SDKs

API Reference

Authorizations

Headers

Path Parameters

Response