Documentation menu

API reference

Request & result schemas

Inspect the complete generated type catalog and download the machine-readable schema.

On this page

Schema catalog

Expand a type to inspect its complete JSON Schema. References resolve against the $defs in the downloadable catalog. Structural validity does not grant permission or guarantee a domain-valid transaction.

Download schema catalog

Download source provenance

`AccessPath`

Field	Type	Required
`collection`	`string`	Yes
`direction`	`IndexDirection \| null`	No
`fields`	`Array<string>`	Yes
`index`	`string \| null`	No
`kind`	`AccessPathKind`	Yes
`uses`	`integer`	Yes

View complete schema

AccessPath

{
  "additionalProperties": false,
  "properties": {
    "collection": {
      "type": "string"
    },
    "direction": {
      "anyOf": [
        {
          "$ref": "#/$defs/IndexDirection"
        },
        {
          "type": "null"
        }
      ]
    },
    "fields": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "index": {
      "type": [
        "string",
        "null"
      ]
    },
    "kind": {
      "$ref": "#/$defs/AccessPathKind"
    },
    "uses": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "collection",
    "kind",
    "fields",
    "uses"
  ],
  "type": "object"
}

`AccessPathKind`

View complete schema

AccessPathKind

{
  "enum": [
    "scan",
    "empty",
    "primary",
    "equality",
    "prefix",
    "range",
    "union",
    "ordered_index"
  ],
  "type": "string"
}

`ApiError`

Field	Type	Required
`code`	`string`	Yes
`message`	`string`	Yes
`requestId`	`string \| null`	No
`retryable`	`boolean`	Yes

View complete schema

ApiError

{
  "additionalProperties": false,
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "requestId": {
      "type": [
        "string",
        "null"
      ]
    },
    "retryable": {
      "type": "boolean"
    }
  },
  "required": [
    "code",
    "message",
    "retryable"
  ],
  "type": "object"
}

`BeginUpload`

Field	Type	Required
`contentType`	`string`	Yes
`name`	`string`	Yes
`requestId`	`string`	Yes
`totalSize`	`integer`	Yes

View complete schema

BeginUpload

{
  "additionalProperties": false,
  "properties": {
    "contentType": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    },
    "totalSize": {
      "format": "uint64",
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "requestId",
    "name",
    "totalSize",
    "contentType"
  ],
  "type": "object"
}

`CollectionSummary`

Field	Type	Required
`count`	`integer`	Yes
`indexes`	`Array<IndexSummary>`	Yes
`name`	`string`	Yes
`schema`	`JSON`	Yes

View complete schema

CollectionSummary

{
  "properties": {
    "count": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "indexes": {
      "items": {
        "$ref": "#/$defs/IndexSummary"
      },
      "type": "array"
    },
    "name": {
      "type": "string"
    },
    "schema": true
  },
  "required": [
    "name",
    "count",
    "schema",
    "indexes"
  ],
  "type": "object"
}

`Collections`

Field	Type	Required
`collections`	`Array<CollectionSummary>`	Yes
`revision`	`string`	Yes

View complete schema

Collections

{
  "additionalProperties": false,
  "properties": {
    "collections": {
      "items": {
        "$ref": "#/$defs/CollectionSummary"
      },
      "type": "array"
    },
    "revision": {
      "type": "string"
    }
  },
  "required": [
    "collections",
    "revision"
  ],
  "type": "object"
}

`DatabaseInfo`

Field	Type	Required
`instanceId`	`string`	Yes
`inventory`	`DatabaseInventory`	Yes
`limits`	`DatabaseLimits`	Yes
`runtime`	`RuntimeInfo`	Yes

View complete schema

DatabaseInfo

{
  "additionalProperties": false,
  "properties": {
    "instanceId": {
      "type": "string"
    },
    "inventory": {
      "$ref": "#/$defs/DatabaseInventory"
    },
    "limits": {
      "$ref": "#/$defs/DatabaseLimits"
    },
    "runtime": {
      "$ref": "#/$defs/RuntimeInfo"
    }
  },
  "required": [
    "instanceId",
    "inventory",
    "limits",
    "runtime"
  ],
  "type": "object"
}

`DatabaseInventory`

Field	Type	Required
`appliedWalPosition` Authenticated checkpoint frontier. Entries above this position remain recoverable from WAL and are awaiting or undergoing background apply.	`string`	Yes
`collections`	`integer`	Yes
`committedPageBytes` Authenticated committed page prefix, excluding WAL and object files.	`string \| null`	Yes
`encryptionAtRest`	`boolean`	Yes
`indexes` User indexes plus schema-owned constraints; primary keys are separate.	`integer`	Yes
`intakes` Active/pending and fully retained terminal lifecycle records.	`integer`	Yes
`logicalBytes` Engine logical admission accounting, not process RAM or disk allocation.	`integer`	Yes
`objects`	`integer`	Yes
`receipts`	`integer`	Yes
`records`	`integer`	Yes
`retiredIntakes` Compact terminal identity fences after result cleanup.	`integer`	Yes
`sequence` Decimal commit sequence; all inventory fields describe this snapshot.	`string`	Yes
`storage`	`StorageLayout`	Yes
`unappliedWalEntries` `wal_position - applied_wal_position`, represented exactly for clients that cannot safely hold every u64 in a native numeric type.	`string`	Yes
`uploads` Includes completed and aborted upload histories.	`integer`	Yes
`walPosition` Raw durable WAL position, including intake and lifecycle entries.	`string`	Yes

View complete schema

DatabaseInventory

{
  "additionalProperties": false,
  "properties": {
    "appliedWalPosition": {
      "description": "Authenticated checkpoint frontier. Entries above this position remain\nrecoverable from WAL and are awaiting or undergoing background apply.",
      "type": "string"
    },
    "collections": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "committedPageBytes": {
      "description": "Authenticated committed page prefix, excluding WAL and object files.",
      "type": [
        "string",
        "null"
      ]
    },
    "encryptionAtRest": {
      "type": "boolean"
    },
    "indexes": {
      "description": "User indexes plus schema-owned constraints; primary keys are separate.",
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "intakes": {
      "description": "Active/pending and fully retained terminal lifecycle records.",
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "logicalBytes": {
      "description": "Engine logical admission accounting, not process RAM or disk allocation.",
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "objects": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "receipts": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "records": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "retiredIntakes": {
      "description": "Compact terminal identity fences after result cleanup.",
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "sequence": {
      "description": "Decimal commit sequence; all inventory fields describe this snapshot.",
      "type": "string"
    },
    "storage": {
      "$ref": "#/$defs/StorageLayout"
    },
    "unappliedWalEntries": {
      "description": "`wal_position - applied_wal_position`, represented exactly for clients\nthat cannot safely hold every u64 in a native numeric type.",
      "type": "string"
    },
    "uploads": {
      "description": "Includes completed and aborted upload histories.",
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "walPosition": {
      "description": "Raw durable WAL position, including intake and lifecycle entries.",
      "type": "string"
    }
  },
  "required": [
    "sequence",
    "walPosition",
    "appliedWalPosition",
    "unappliedWalEntries",
    "storage",
    "encryptionAtRest",
    "logicalBytes",
    "collections",
    "records",
    "indexes",
    "receipts",
    "intakes",
    "retiredIntakes",
    "objects",
    "uploads",
    "committedPageBytes"
  ],
  "type": "object"
}

`DatabaseLimits`

Field	Type	Required
`collections`	`integer`	Yes
`intakes`	`integer`	Yes
`logicalBytes`	`integer`	Yes
`operations`	`integer`	Yes
`receipts`	`integer`	Yes
`recordBytes`	`integer`	Yes
`requestBytes`	`integer`	Yes
`resultBytes`	`integer`	Yes
`retiredIntakes`	`integer`	Yes

View complete schema

DatabaseLimits

{
  "additionalProperties": false,
  "properties": {
    "collections": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "intakes": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "logicalBytes": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "operations": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "receipts": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "recordBytes": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "requestBytes": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "resultBytes": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "retiredIntakes": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "logicalBytes",
    "collections",
    "receipts",
    "intakes",
    "retiredIntakes",
    "recordBytes",
    "requestBytes",
    "resultBytes",
    "operations"
  ],
  "type": "object"
}

`DatabaseState`

View complete schema

DatabaseState

{
  "enum": [
    "uninitialized",
    "locked",
    "ready",
    "recovery_required"
  ],
  "type": "string"
}

`EmptyRequest`

View complete schema

EmptyRequest

{
  "additionalProperties": false,
  "type": "object"
}

`Envelope`

View complete schema

Envelope

{
  "anyOf": [
    {
      "additionalProperties": false,
      "properties": {
        "data": true,
        "ok": {
          "$ref": "#/$defs/True"
        }
      },
      "required": [
        "ok",
        "data"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "error": {
          "$ref": "#/$defs/ApiError"
        },
        "ok": {
          "$ref": "#/$defs/False"
        }
      },
      "required": [
        "ok",
        "error"
      ],
      "type": "object"
    }
  ]
}

`ExecutionProfile`

Field	Type	Required
`omittedPaths` Path occurrences omitted after the bounded distinct-path inventory fills.	`integer`	Yes
`paths`	`Array<AccessPath>`	Yes
`version`	`ExecutionProfileVersion`	Yes
`work`	`ExecutionWork`	Yes

View complete schema

ExecutionProfile

{
  "additionalProperties": false,
  "properties": {
    "omittedPaths": {
      "description": "Path occurrences omitted after the bounded distinct-path inventory fills.",
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "paths": {
      "items": {
        "$ref": "#/$defs/AccessPath"
      },
      "type": "array"
    },
    "version": {
      "$ref": "#/$defs/ExecutionProfileVersion"
    },
    "work": {
      "$ref": "#/$defs/ExecutionWork"
    }
  },
  "required": [
    "version",
    "work",
    "paths",
    "omittedPaths"
  ],
  "type": "object"
}

`ExecutionProfileVersion`

View complete schema

ExecutionProfileVersion

{
  "const": 1,
  "type": "integer"
}

`ExecutionWork`

Field	Type	Required
`aggregateBufferedRows`	`integer`	Yes
`aggregateFieldVisits`	`integer`	Yes
`aggregateInputRows`	`integer`	Yes
`collectionScanPrefixRows`	`integer`	Yes
`collectionScanRecordReuses`	`integer`	Yes
`collectionScanReuses`	`integer`	Yes
`collectionScanRows`	`integer`	Yes
`collectionScans`	`integer`	Yes
`fullFieldDecodes`	`integer`	Yes
`fullFieldReuses`	`integer`	Yes
`joinFieldDecodes`	`integer`	Yes
`joinIndexProbes`	`integer`	Yes
`joinOutputRows`	`integer`	Yes
`joinProbeReuses`	`integer`	Yes
`joinRecordLoads`	`integer`	Yes
`joinRecordReuses`	`integer`	Yes
`joinScanRows`	`integer`	Yes
`joinScans`	`integer`	Yes
`orderedIndexRows`	`integer`	Yes
`orderedIndexScans`	`integer`	Yes
`peakRetainedBytes`	`integer`	Yes
`programSourceRows`	`integer`	Yes
`recordProbes`	`integer`	Yes
`recordReuses`	`integer`	Yes
`recordUpdates`	`integer`	Yes
`retainedBytes`	`integer`	Yes
`selectedFieldViews`	`integer`	Yes
`sortComparisons`	`integer`	Yes
`sortInputRows`	`integer`	Yes
`sortKeyResolutions`	`integer`	Yes
`sortOutputRows`	`integer`	Yes

View complete schema

ExecutionWork

{
  "additionalProperties": false,
  "properties": {
    "aggregateBufferedRows": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "aggregateFieldVisits": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "aggregateInputRows": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "collectionScanPrefixRows": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "collectionScanRecordReuses": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "collectionScanReuses": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "collectionScanRows": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "collectionScans": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "fullFieldDecodes": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "fullFieldReuses": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "joinFieldDecodes": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "joinIndexProbes": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "joinOutputRows": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "joinProbeReuses": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "joinRecordLoads": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "joinRecordReuses": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "joinScanRows": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "joinScans": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "orderedIndexRows": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "orderedIndexScans": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "peakRetainedBytes": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "programSourceRows": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "recordProbes": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "recordReuses": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "recordUpdates": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "retainedBytes": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "selectedFieldViews": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "sortComparisons": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "sortInputRows": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "sortKeyResolutions": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "sortOutputRows": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "programSourceRows",
    "recordProbes",
    "recordReuses",
    "recordUpdates",
    "collectionScans",
    "collectionScanRows",
    "collectionScanReuses",
    "collectionScanPrefixRows",
    "collectionScanRecordReuses",
    "joinScans",
    "joinScanRows",
    "joinIndexProbes",
    "joinRecordLoads",
    "joinRecordReuses",
    "joinFieldDecodes",
    "fullFieldDecodes",
    "fullFieldReuses",
    "selectedFieldViews",
    "joinProbeReuses",
    "joinOutputRows",
    "aggregateInputRows",
    "aggregateFieldVisits",
    "aggregateBufferedRows",
    "sortInputRows",
    "sortKeyResolutions",
    "sortComparisons",
    "sortOutputRows",
    "orderedIndexScans",
    "orderedIndexRows",
    "retainedBytes",
    "peakRetainedBytes"
  ],
  "type": "object"
}

`False`

View complete schema

False

{
  "const": false,
  "type": "boolean"
}

`IndexDirection`

View complete schema

IndexDirection

{
  "enum": [
    "ascending",
    "descending"
  ],
  "type": "string"
}

`IndexSummary`

Field	Type	Required
`expireAfter`	`integer \| null`	No
`fields`	`Array<string>`	Yes
`name`	`string \| null`	No
`sparse`	`boolean`	Yes
`unique`	`boolean`	Yes

View complete schema

IndexSummary

{
  "properties": {
    "expireAfter": {
      "format": "uint64",
      "minimum": 0,
      "type": [
        "integer",
        "null"
      ]
    },
    "fields": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "name": {
      "type": [
        "string",
        "null"
      ]
    },
    "sparse": {
      "type": "boolean"
    },
    "unique": {
      "type": "boolean"
    }
  },
  "required": [
    "fields",
    "unique",
    "sparse"
  ],
  "type": "object"
}

`InstanceMode`

View complete schema

InstanceMode

{
  "enum": [
    "standalone"
  ],
  "type": "string"
}

`IntakePhase`

View complete schema

IntakePhase

{
  "description": "Durable intake outcome. Pending can include a business commit whose terminal\nbookkeeping has not yet been reconciled; cancel_admitted checks its receipt.",
  "enum": [
    "pending",
    "committed",
    "read_complete",
    "rejected",
    "cancelled",
    "retired"
  ],
  "type": "string"
}

`IntakeStatus`

Field	Type	Required
`acceptedPosition` Exact raw WAL position of durable admission. Decimal text prevents loss of precision in JSON clients that represent numbers as IEEE-754.	`string`	Yes
`applied` Whether the current lifecycle state is covered by `checkpointPosition`. A false result means WAL remains authoritative and recovery-safe.	`boolean`	Yes
`checkpointPosition` Exact authenticated checkpoint boundary in the immutable read snapshot.	`string`	Yes
`phase`	`IntakePhase`	Yes
`requestId`	`string`	Yes
`statusPosition` Exact raw WAL position that established the currently reported state. A legacy retained tombstone predating this field uses its terminal position, because its historical retirement position was not retained.	`string`	Yes
`terminalPosition` Exact raw WAL position of the terminal result, when one exists.	`string \| null`	Yes

View complete schema

IntakeStatus

{
  "additionalProperties": false,
  "properties": {
    "acceptedPosition": {
      "description": "Exact raw WAL position of durable admission. Decimal text prevents loss\nof precision in JSON clients that represent numbers as IEEE-754.",
      "type": "string"
    },
    "applied": {
      "description": "Whether the current lifecycle state is covered by `checkpointPosition`.\nA false result means WAL remains authoritative and recovery-safe.",
      "type": "boolean"
    },
    "checkpointPosition": {
      "description": "Exact authenticated checkpoint boundary in the immutable read snapshot.",
      "type": "string"
    },
    "phase": {
      "$ref": "#/$defs/IntakePhase"
    },
    "requestId": {
      "type": "string"
    },
    "statusPosition": {
      "description": "Exact raw WAL position that established the currently reported state.\nA legacy retained tombstone predating this field uses its terminal\nposition, because its historical retirement position was not retained.",
      "type": "string"
    },
    "terminalPosition": {
      "description": "Exact raw WAL position of the terminal result, when one exists.",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "requestId",
    "acceptedPosition",
    "terminalPosition",
    "statusPosition",
    "checkpointPosition",
    "applied",
    "phase"
  ],
  "type": "object"
}

`KeyProvider`

View complete schema

KeyProvider

{
  "enum": [
    "native",
    "external"
  ],
  "type": "string"
}

`Login`

Field	Type	Required
`token`	`string`	Yes

View complete schema

{
  "additionalProperties": false,
  "properties": {
    "token": {
      "type": "string"
    }
  },
  "required": [
    "token"
  ],
  "type": "object"
}

`ObjectReference`

Field	Type	Required
`contentType`	`string`	Yes
`name`	`string`	Yes
`objectId`	`string`	Yes
`partCount`	`integer`	Yes
`partSize`	`integer`	Yes
`sha256`	`string`	Yes
`size`	`integer`	Yes
`version`	`string`	Yes

View complete schema

ObjectReference

{
  "additionalProperties": false,
  "properties": {
    "contentType": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "objectId": {
      "type": "string"
    },
    "partCount": {
      "format": "uint32",
      "minimum": 0,
      "type": "integer"
    },
    "partSize": {
      "format": "uint64",
      "minimum": 0,
      "type": "integer"
    },
    "sha256": {
      "type": "string"
    },
    "size": {
      "format": "uint64",
      "minimum": 0,
      "type": "integer"
    },
    "version": {
      "type": "string"
    }
  },
  "required": [
    "objectId",
    "version",
    "name",
    "size",
    "contentType",
    "sha256",
    "partSize",
    "partCount"
  ],
  "type": "object"
}

`Objects`

Field	Type	Required
`objects`	`Array<ObjectReference>`	Yes

View complete schema

Objects

{
  "additionalProperties": false,
  "properties": {
    "objects": {
      "items": {
        "$ref": "#/$defs/ObjectReference"
      },
      "type": "array"
    }
  },
  "required": [
    "objects"
  ],
  "type": "object"
}

`Operation`

View complete schema

Operation

{
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "name": {
          "type": "string"
        },
        "op": {
          "const": "create_collection",
          "type": "string"
        },
        "schema": {
          "default": null
        },
        "unique": {
          "default": [],
          "items": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "type": "array"
        }
      },
      "required": [
        "op",
        "name"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "collection": {
          "type": "string"
        },
        "fields": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "name": {
          "type": "string"
        },
        "op": {
          "const": "create_index",
          "type": "string"
        },
        "sparse": {
          "type": "boolean"
        },
        "unique": {
          "type": "boolean"
        }
      },
      "required": [
        "op",
        "collection",
        "name",
        "fields"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "collection": {
          "type": "string"
        },
        "expireAfter": {
          "format": "uint64",
          "minimum": 0,
          "type": "integer"
        },
        "field": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "op": {
          "const": "create_ttl_index",
          "type": "string"
        }
      },
      "required": [
        "op",
        "collection",
        "name",
        "field",
        "expireAfter"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "collection": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "op": {
          "const": "drop_index",
          "type": "string"
        }
      },
      "required": [
        "op",
        "collection",
        "name"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "after": {
          "default": null,
          "type": [
            "string",
            "null"
          ]
        },
        "collection": {
          "type": "string"
        },
        "limit": {
          "default": null,
          "format": "uint",
          "minimum": 0,
          "type": [
            "integer",
            "null"
          ]
        },
        "op": {
          "const": "list_records",
          "type": "string"
        }
      },
      "required": [
        "op",
        "collection"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "collection": {
          "type": "string"
        },
        "key": {
          "type": "string"
        },
        "op": {
          "const": "get",
          "type": "string"
        }
      },
      "required": [
        "op",
        "collection",
        "key"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "collection": {
          "type": "string"
        },
        "key": {
          "default": null,
          "type": [
            "string",
            "null"
          ]
        },
        "op": {
          "const": "insert",
          "type": "string"
        },
        "value": {
          "additionalProperties": true,
          "type": "object"
        }
      },
      "required": [
        "op",
        "collection",
        "value"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "description": "Administrator-only insertion preserving an external opaque revision.\nExisting keys are never replaced. Native revisions use verified restore.",
      "properties": {
        "collection": {
          "type": "string"
        },
        "op": {
          "const": "import_record",
          "type": "string"
        },
        "record": {
          "$ref": "#/$defs/StoredRecord"
        }
      },
      "required": [
        "op",
        "collection",
        "record"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "collection": {
          "type": "string"
        },
        "key": {
          "type": "string"
        },
        "op": {
          "const": "replace",
          "type": "string"
        },
        "revision": {
          "type": "string"
        },
        "value": {
          "additionalProperties": true,
          "type": "object"
        }
      },
      "required": [
        "op",
        "collection",
        "key",
        "revision",
        "value"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "collection": {
          "type": "string"
        },
        "key": {
          "type": "string"
        },
        "op": {
          "const": "delete",
          "type": "string"
        },
        "revision": {
          "type": "string"
        }
      },
      "required": [
        "op",
        "collection",
        "key",
        "revision"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "contentType": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "op": {
          "const": "begin_upload",
          "type": "string"
        },
        "totalSize": {
          "format": "uint64",
          "minimum": 0,
          "type": "integer"
        }
      },
      "required": [
        "op",
        "name",
        "totalSize",
        "contentType"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "key": {
          "default": null,
          "type": [
            "string",
            "null"
          ]
        },
        "op": {
          "const": "complete_upload",
          "type": "string"
        },
        "uploadId": {
          "type": "string"
        }
      },
      "required": [
        "op",
        "uploadId"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "bindings": {
          "additionalProperties": true,
          "default": {},
          "type": "object"
        },
        "expectedCount": {
          "description": "Require this many returned/affected rows or roll back the entire\ntransaction. SELECT counts its result after LIMIT, not all matches.",
          "format": "uint",
          "minimum": 0,
          "type": [
            "integer",
            "null"
          ]
        },
        "op": {
          "const": "query",
          "type": "string"
        },
        "qql": {
          "type": "string"
        }
      },
      "required": [
        "op",
        "qql"
      ],
      "type": "object"
    }
  ]
}

`OperationResult`

View complete schema

OperationResult

{
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "name": {
          "type": "string"
        },
        "op": {
          "const": "create_collection",
          "type": "string"
        }
      },
      "required": [
        "op",
        "name"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "name": {
          "type": "string"
        },
        "op": {
          "const": "create_index",
          "type": "string"
        }
      },
      "required": [
        "op",
        "name"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "name": {
          "type": "string"
        },
        "op": {
          "const": "create_ttl_index",
          "type": "string"
        }
      },
      "required": [
        "op",
        "name"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "name": {
          "type": "string"
        },
        "op": {
          "const": "drop_index",
          "type": "string"
        }
      },
      "required": [
        "op",
        "name"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "nextCursor": {
          "type": [
            "string",
            "null"
          ]
        },
        "op": {
          "const": "list_records",
          "type": "string"
        },
        "records": {
          "items": {
            "$ref": "#/$defs/StoredRecord"
          },
          "type": "array"
        }
      },
      "required": [
        "op",
        "records"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "op": {
          "const": "get",
          "type": "string"
        },
        "record": {
          "anyOf": [
            {
              "$ref": "#/$defs/StoredRecord"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "op",
        "record"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "op": {
          "const": "insert",
          "type": "string"
        },
        "record": {
          "$ref": "#/$defs/StoredRecord"
        }
      },
      "required": [
        "op",
        "record"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "op": {
          "const": "import_record",
          "type": "string"
        },
        "record": {
          "$ref": "#/$defs/StoredRecord"
        }
      },
      "required": [
        "op",
        "record"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "op": {
          "const": "replace",
          "type": "string"
        },
        "record": {
          "$ref": "#/$defs/StoredRecord"
        }
      },
      "required": [
        "op",
        "record"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "count": {
          "format": "uint",
          "minimum": 0,
          "type": "integer"
        },
        "op": {
          "const": "delete",
          "type": "string"
        }
      },
      "required": [
        "op",
        "count"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "op": {
          "const": "begin_upload",
          "type": "string"
        },
        "upload": {
          "$ref": "#/$defs/UploadStatus"
        }
      },
      "required": [
        "op",
        "upload"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "object": {
          "$ref": "#/$defs/ObjectReference"
        },
        "op": {
          "const": "complete_upload",
          "type": "string"
        }
      },
      "required": [
        "op",
        "object"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "count": {
          "format": "uint",
          "minimum": 0,
          "type": "integer"
        },
        "op": {
          "const": "query",
          "type": "string"
        },
        "records": {
          "items": {
            "$ref": "#/$defs/StoredRecord"
          },
          "type": "array"
        }
      },
      "required": [
        "op",
        "records",
        "count"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "description": "One ordered result per statement in a multi-statement QQL operation.",
      "properties": {
        "op": {
          "const": "query_batch",
          "type": "string"
        },
        "results": {
          "items": {
            "$ref": "#/$defs/OperationResult"
          },
          "type": "array"
        }
      },
      "required": [
        "op",
        "results"
      ],
      "type": "object"
    }
  ]
}

`Principal`

Field	Type	Required
`id`	`string`	Yes
`name`	`string`	Yes
`role`	`Role`	Yes

View complete schema

Principal

{
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "role": {
      "$ref": "#/$defs/Role"
    }
  },
  "required": [
    "id",
    "name",
    "role"
  ],
  "type": "object"
}

`RetireIntakes`

Field	Type	Required
`limit`	`integer`	Yes

View complete schema

RetireIntakes

{
  "additionalProperties": false,
  "description": "Bounded administrator-directed lifecycle cleanup. Cleanup keeps a compact\ntombstone for every retired request ID; it never authorizes ID reuse.",
  "properties": {
    "limit": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "limit"
  ],
  "type": "object"
}

`Role`

View complete schema

Role

{
  "enum": [
    "owner",
    "admin",
    "reader",
    "writer"
  ],
  "type": "string"
}

`RuntimeInfo`

Field	Type	Required
`activeJobs`	`integer`	Yes
`applicationErrorCode` Last non-sensitive application scheduler error classification. A later successful application or a process restart clears it.	`string \| null`	Yes
`applicationQueued` True while the standalone server has an executor-owned WAL application continuation queued or running. Durable/applied positions are reported separately in `DatabaseInventory`.	`boolean`	Yes
`cpuPercent`	`integer`	Yes
`maxConnections`	`integer`	Yes
`maxRequests`	`integer`	Yes
`queueCapacity`	`integer`	Yes
`queuedJobs`	`integer`	Yes
`targetWorkers`	`integer`	Yes
`threadPolicy`	`string`	Yes
`workers`	`integer`	Yes

View complete schema

RuntimeInfo

{
  "additionalProperties": false,
  "properties": {
    "activeJobs": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "applicationErrorCode": {
      "description": "Last non-sensitive application scheduler error classification. A later\nsuccessful application or a process restart clears it.",
      "type": [
        "string",
        "null"
      ]
    },
    "applicationQueued": {
      "description": "True while the standalone server has an executor-owned WAL application\ncontinuation queued or running. Durable/applied positions are reported\nseparately in `DatabaseInventory`.",
      "type": "boolean"
    },
    "cpuPercent": {
      "format": "uint8",
      "maximum": 255,
      "minimum": 0,
      "type": "integer"
    },
    "maxConnections": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "maxRequests": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "queueCapacity": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "queuedJobs": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "targetWorkers": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "threadPolicy": {
      "type": "string"
    },
    "workers": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "threadPolicy",
    "workers",
    "targetWorkers",
    "activeJobs",
    "queuedJobs",
    "queueCapacity",
    "cpuPercent",
    "maxRequests",
    "maxConnections",
    "applicationQueued",
    "applicationErrorCode"
  ],
  "type": "object"
}

`Session`

View complete schema

Session

{
  "anyOf": [
    {
      "additionalProperties": false,
      "properties": {
        "authenticated": {
          "$ref": "#/$defs/True"
        },
        "principal": {
          "$ref": "#/$defs/Principal"
        }
      },
      "required": [
        "authenticated",
        "principal"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "authenticated": {
          "$ref": "#/$defs/False"
        }
      },
      "required": [
        "authenticated"
      ],
      "type": "object"
    }
  ]
}

`Status`

Field	Type	Required
`capabilities`	`Array<string>`	Yes
`keyProvider`	`KeyProvider`	Yes
`mode`	`InstanceMode`	Yes
`name`	`string`	Yes
`state`	`DatabaseState`	Yes
`version`	`string`	Yes

View complete schema

Status

{
  "additionalProperties": false,
  "properties": {
    "capabilities": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "keyProvider": {
      "$ref": "#/$defs/KeyProvider"
    },
    "mode": {
      "$ref": "#/$defs/InstanceMode"
    },
    "name": {
      "type": "string"
    },
    "state": {
      "$ref": "#/$defs/DatabaseState"
    },
    "version": {
      "type": "string"
    }
  },
  "required": [
    "name",
    "version",
    "state",
    "mode",
    "keyProvider",
    "capabilities"
  ],
  "type": "object"
}

`StorageLayout`

View complete schema

StorageLayout

{
  "enum": [
    "logical",
    "physical"
  ],
  "type": "string"
}

`StoredRecord`

Field	Type	Required
`key`	`string`	Yes
`revision`	`string`	Yes
`value`	`object`	Yes

View complete schema

StoredRecord

{
  "additionalProperties": false,
  "properties": {
    "key": {
      "type": "string"
    },
    "revision": {
      "type": "string"
    },
    "value": {
      "additionalProperties": true,
      "type": "object"
    }
  },
  "required": [
    "key",
    "revision",
    "value"
  ],
  "type": "object"
}

`TransactionRequest`

Field	Type	Required
`operations`	`Array<Operation>`	Yes
`profile` Return work and access paths from the execution used for this result. This executes mutations normally; it is not a dry-run option.	`boolean`	No
`requestId`	`string`	Yes

View complete schema

TransactionRequest

{
  "additionalProperties": false,
  "properties": {
    "operations": {
      "items": {
        "$ref": "#/$defs/Operation"
      },
      "type": "array"
    },
    "profile": {
      "description": "Return work and access paths from the execution used for this result.\nThis executes mutations normally; it is not a dry-run option.",
      "type": "boolean"
    },
    "requestId": {
      "type": "string"
    }
  },
  "required": [
    "requestId",
    "operations"
  ],
  "type": "object"
}

`TransactionResponse`

Field	Type	Required
`profile`	`ExecutionProfile \| null`	No
`replayed`	`boolean`	Yes
`results`	`Array<OperationResult>`	Yes
`revision`	`string`	Yes

View complete schema

TransactionResponse

{
  "additionalProperties": false,
  "properties": {
    "profile": {
      "anyOf": [
        {
          "$ref": "#/$defs/ExecutionProfile"
        },
        {
          "type": "null"
        }
      ]
    },
    "replayed": {
      "type": "boolean"
    },
    "results": {
      "items": {
        "$ref": "#/$defs/OperationResult"
      },
      "type": "array"
    },
    "revision": {
      "type": "string"
    }
  },
  "required": [
    "revision",
    "results",
    "replayed"
  ],
  "type": "object"
}

`True`

View complete schema

True

{
  "const": true,
  "type": "boolean"
}

`Unlock`

Field	Type	Required
`password`	`string`	No

View complete schema

Unlock

{
  "additionalProperties": false,
  "properties": {
    "password": {
      "default": "",
      "type": "string"
    }
  },
  "type": "object"
}

`UploadStatus`

Field	Type	Required
`contentType`	`string`	Yes
`name`	`string`	Yes
`object`	`ObjectReference \| null`	No
`objectId`	`string`	Yes
`partCount`	`integer`	Yes
`partSize`	`integer`	Yes
`parts`	`Array<UploadedPart>`	Yes
`state`	`string`	Yes
`totalSize`	`integer`	Yes
`uploadId`	`string`	Yes
`uploadedBytes`	`integer`	Yes
`uploadedParts`	`integer`	Yes

View complete schema

UploadStatus

{
  "properties": {
    "contentType": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "object": {
      "anyOf": [
        {
          "$ref": "#/$defs/ObjectReference"
        },
        {
          "type": "null"
        }
      ]
    },
    "objectId": {
      "type": "string"
    },
    "partCount": {
      "format": "uint32",
      "minimum": 0,
      "type": "integer"
    },
    "partSize": {
      "format": "uint64",
      "minimum": 0,
      "type": "integer"
    },
    "parts": {
      "items": {
        "$ref": "#/$defs/UploadedPart"
      },
      "type": "array"
    },
    "state": {
      "type": "string"
    },
    "totalSize": {
      "format": "uint64",
      "minimum": 0,
      "type": "integer"
    },
    "uploadId": {
      "type": "string"
    },
    "uploadedBytes": {
      "format": "uint64",
      "minimum": 0,
      "type": "integer"
    },
    "uploadedParts": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "uploadId",
    "objectId",
    "name",
    "totalSize",
    "contentType",
    "partSize",
    "partCount",
    "uploadedParts",
    "uploadedBytes",
    "state",
    "parts"
  ],
  "type": "object"
}

`UploadSummary`

Field	Type	Required
`contentType`	`string`	Yes
`name`	`string`	Yes
`objectId`	`string`	Yes
`partCount`	`integer`	Yes
`partSize`	`integer`	Yes
`state`	`string`	Yes
`totalSize`	`integer`	Yes
`uploadId`	`string`	Yes
`uploadedBytes`	`integer`	Yes
`uploadedParts`	`integer`	Yes

View complete schema

UploadSummary

{
  "properties": {
    "contentType": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "objectId": {
      "type": "string"
    },
    "partCount": {
      "format": "uint32",
      "minimum": 0,
      "type": "integer"
    },
    "partSize": {
      "format": "uint64",
      "minimum": 0,
      "type": "integer"
    },
    "state": {
      "type": "string"
    },
    "totalSize": {
      "format": "uint64",
      "minimum": 0,
      "type": "integer"
    },
    "uploadId": {
      "type": "string"
    },
    "uploadedBytes": {
      "format": "uint64",
      "minimum": 0,
      "type": "integer"
    },
    "uploadedParts": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "uploadId",
    "objectId",
    "name",
    "totalSize",
    "contentType",
    "partSize",
    "partCount",
    "uploadedParts",
    "uploadedBytes",
    "state"
  ],
  "type": "object"
}

`UploadedPart`

Field	Type	Required
`index`	`integer`	Yes
`sha256`	`string`	Yes
`size`	`integer`	Yes

View complete schema

UploadedPart

{
  "additionalProperties": false,
  "properties": {
    "index": {
      "format": "uint32",
      "minimum": 0,
      "type": "integer"
    },
    "sha256": {
      "type": "string"
    },
    "size": {
      "format": "uint64",
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "index",
    "size",
    "sha256"
  ],
  "type": "object"
}

`Uploads`

Field	Type	Required
`uploads`	`Array<UploadSummary>`	Yes

View complete schema

Uploads

{
  "additionalProperties": false,
  "properties": {
    "uploads": {
      "items": {
        "$ref": "#/$defs/UploadSummary"
      },
      "type": "array"
    }
  },
  "required": [
    "uploads"
  ],
  "type": "object"
}

`WaitForIntakeApply`

Field	Type	Required
`timeoutMs` 1–30,000 milliseconds. Omitted uses a ten-second wait.	`integer`	No

View complete schema

WaitForIntakeApply

{
  "additionalProperties": false,
  "description": "Bounded authenticated long-poll control for a committed intake. The request\nnever changes transaction authority: it only waits for the durable WAL\nposition already associated with the owned intake to be covered by the\ncheckpoint/application frontier.",
  "properties": {
    "timeoutMs": {
      "default": 10000,
      "description": "1\u201330,000 milliseconds. Omitted uses a ten-second wait.",
      "format": "uint64",
      "maximum": 30000,
      "minimum": 1,
      "type": "integer"
    }
  },
  "type": "object"
}

`WebSocketLimits`

Field	Type	Required
`inFlight`	`integer`	Yes
`instanceConnections`	`integer`	Yes
`instanceRequests`	`integer`	Yes
`messageBytes`	`integer`	Yes

View complete schema

WebSocketLimits

{
  "additionalProperties": false,
  "properties": {
    "inFlight": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "instanceConnections": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "instanceRequests": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    },
    "messageBytes": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "messageBytes",
    "inFlight",
    "instanceConnections",
    "instanceRequests"
  ],
  "type": "object"
}

`WebSocketRequest`

View complete schema

WebSocketRequest

{
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "token": {
          "type": "string"
        },
        "type": {
          "const": "authenticate",
          "type": "string"
        }
      },
      "required": [
        "type",
        "token"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "request": {
          "$ref": "#/$defs/TransactionRequest"
        },
        "type": {
          "const": "execute",
          "type": "string"
        }
      },
      "required": [
        "type",
        "id",
        "request"
      ],
      "type": "object"
    }
  ]
}

`WebSocketResponse`

View complete schema

WebSocketResponse

{
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "limits": {
          "$ref": "#/$defs/WebSocketLimits"
        },
        "session": {
          "$ref": "#/$defs/Session"
        },
        "type": {
          "const": "ready",
          "type": "string"
        }
      },
      "required": [
        "type",
        "session",
        "limits"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "response": {
          "anyOf": [
            {
              "additionalProperties": false,
              "properties": {
                "data": {
                  "$ref": "#/$defs/TransactionResponse"
                },
                "ok": {
                  "$ref": "#/$defs/True"
                }
              },
              "required": [
                "ok",
                "data"
              ],
              "type": "object"
            },
            {
              "additionalProperties": false,
              "properties": {
                "error": {
                  "$ref": "#/$defs/ApiError"
                },
                "ok": {
                  "$ref": "#/$defs/False"
                }
              },
              "required": [
                "ok",
                "error"
              ],
              "type": "object"
            }
          ]
        },
        "status": {
          "format": "uint16",
          "maximum": 65535,
          "minimum": 0,
          "type": "integer"
        },
        "type": {
          "const": "result",
          "type": "string"
        }
      },
      "required": [
        "type",
        "id",
        "status",
        "response"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "error": {
          "$ref": "#/$defs/ApiError"
        },
        "type": {
          "const": "error",
          "type": "string"
        }
      },
      "required": [
        "type",
        "error"
      ],
      "type": "object"
    }
  ]
}