Failure

The body of every failed request.

code is a stable machine-readable token a client branches on. message is untranslated developer text that a client must never show to a person - it is for logs and bug reports. A client renders its own words, in its own language, from the code.

Type object

Shape

Field	Type	Description
coderequired	string	A stable token to branch on.
messagerequired	string	Untranslated developer text; never shown to a person. Render your own words, in your own language, from the code.
waiting_on	array of string	Display names of the devices a parked blob hydration is waiting on. Display data for the client's own sentence - never part of `code`, and absent on every failure that is not a parked hydration.
hold	string or null	Why blob transfer is holding, when that is what refused this - a `TransferHold` code from the blob engine's registry (`mode_refuses_transport`, `network_metered`, `network_low_data`, `network_offline`, `paused_by_person`, `cloud_access_unavailable`). Structured beside `code` rather than inside it, for the same reason `waiting_on` is: these are the blob plane's vocabulary and `code` is the Store's, and a client that had to recover one by parsing the other would be branching on developer text. Without it, every hold that is not one of the Store's three blob codes arrives as `storage_failed` and the placeholder has nothing true to say - which is D259's second defect exactly: a person told to wake another device for a Workspace this one was never switched on for. Absent on every failure that is not a blob transfer hold.

Example

{
  "code": "string",
  "message": "string",
  "waiting_on": [
    "string"
  ],
  "hold": "string"
}

The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.

Used by

Generated from contract version 1. Last updated November 12, 2026.