Skip to main content

GET/1.0/shims/:id

Reads one shim — what the list gives, plus the question's answers with their descriptions. Required scope: workbench:shims:read (scopes reference).

Path parameters

idstringRequired

The shim's stable id, from GET /1.0/shims or the Quickstart tab in Workbench.

Response

{
  "id": "6607ac72-4e8e-47e2-8b83-a011a10b4ea7",
  "name": "Support triage",
  "question": "Which team should read this message?",
  "answers": [
    { "label": "billing", "description": "Money, invoices, refunds." },
    { "label": "technical", "description": "Something is broken or not working as expected." },
    { "label": "sales", "description": null }
  ],
  "examples": 83,
  "version": "v2",
  "accuracy": 0.94,
  "weightsBytes": 50112,
  "updatedAt": "2026-09-22T17:04:00.000Z"
}

The examples themselves stay in Workbench. To make decisions, fetch the weights with GET /1.0/shims/:id/weights.

Returns 404 not_found when the id doesn't exist in the key's workspace; an id from another workspace also returns 404 not_found.

1 min read