Skip to main content

GET/1.0/shims

Lists every shim the key's workspace can see. Required scope: workbench:shims:read (scopes reference).

A shim is a small decision model built in Workbench: one question, its answers, and examples, compiled into a weights file that decides inside your app with @zerowidth/shims-sdk, with no request and no key at runtime. Read the write-up at Labs: Shims.

Response

{
  "data": [
    {
      "id": "6607ac72-4e8e-47e2-8b83-a011a10b4ea7",
      "name": "Support triage",
      "question": "Which team should read this message?",
      "answers": 4,
      "examples": 83,
      "version": "v2",
      "accuracy": 0.94,
      "weightsBytes": 50112,
      "updatedAt": "2026-09-22T17:04:00.000Z"
    }
  ]
}

id is the shim's stable id. Use it with GET /1.0/shims/:id for the answers and with GET /1.0/shims/:id/weights to fetch the published version.

version is the label of the published version and accuracy its held-out accuracy (0–1). Both are null until a version is published in Workbench.

1 min read