Skip to content
HALOWERK

File Formats and Conversion

receipt peer only recovery spans

Peer recovery returns bytes held by a second receiver and still absent from the first. Use it when an agent needs a transfer plan between two partial copies.

POST https://format.halowerk.com/v1/receipt-peer-only-recovery-spans

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
sizeintegerYes
rangesarrayYes
peerarrayYes
Show full input schema
{
  "type": "object",
  "properties": {
    "size": {
      "type": "integer",
      "minimum": 1,
      "maximum": 1099511627776
    },
    "ranges": {
      "type": "array",
      "items": {
        "type": "array",
        "items": {
          "type": "integer",
          "minimum": 0,
          "maximum": 1099511627775
        },
        "maxItems": 2,
        "minItems": 2
      },
      "maxItems": 300,
      "minItems": 0
    },
    "peer": {
      "type": "array",
      "items": {
        "type": "array",
        "items": {
          "type": "integer",
          "minimum": 0,
          "maximum": 1099511627775
        },
        "maxItems": 2,
        "minItems": 2
      },
      "maxItems": 300,
      "minItems": 0
    }
  },
  "required": [
    "size",
    "ranges",
    "peer"
  ],
  "additionalProperties": false
}

Open original schema

Published input example

{
  "size": 2501504,
  "ranges": [
    [
      0,
      127
    ],
    [
      256,
      383
    ],
    [
      64,
      191
    ]
  ],
  "peer": [
    [
      1024,
      1151
    ],
    [
      1100,
      1200
    ],
    [
      4096,
      4351
    ]
  ]
}

Result & documentation

Show published result schema
{
  "type": "object",
  "required": [
    "measured_at",
    "source",
    "data",
    "limitations"
  ],
  "properties": {
    "measured_at": {
      "type": "string"
    },
    "source": {
      "type": "object",
      "required": [
        "reference",
        "retrieved_at"
      ],
      "properties": {
        "reference": {
          "type": "string"
        },
        "retrieved_at": {
          "type": "string"
        }
      }
    },
    "data": {
      "type": "object",
      "properties": {
        "available_from_peer": {
          "type": "integer"
        },
        "spans": {
          "type": "array",
          "items": {
            "type": "array",
            "items": {
              "type": "integer"
            }
          }
        }
      },
      "required": [
        "available_from_peer",
        "spans"
      ]
    },
    "limitations": {
      "type": "string"
    }
  }
}

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-20 UTC.

More endpoints in this hub

All endpoints in this hub โ†’