---
title: "Re-run a worked example's pinned steps"
method: GET
path: "/example/{slug}/run"
tags: ["Worked examples"]
---

# Re-run a worked example's pinned steps

`GET /example/{slug}/run`

## Request

- Base URL: `https://api.craftquantities.com/v1`
- URL: `https://api.craftquantities.com/v1/example/{slug}/run`
- Auth: none declared

## Path parameters

- `slug` string, required: The calculator's slug, such as concrete-calculator.

## Query parameters

- `detail` 'full' | 'summary': full (the default): the whole answer. summary: the result lines, the citation line and the page only — fewer tokens to read.
- `format` 'json' | 'md'

## Response `200`

Each step now, and whether it meets the published figure.

- union
  - object
    - `engine` object, required
    - `example` object, required
      - `slug` string, required
      - `title` string, required
      - `job` string, required
      - `market` string, required
      - `system` 'metric' | 'imperial', required
      - `basis` 'modelled' | 'recorded', required
      - `summary` string, required
      - `published` string
      - `updated` string
      - `url` string, required
      - `takeoff` string, nullable
    - `steps` object[], required
      - `step` string, required
      - `calculator` object, required
      - `answer` object, required
      - `otherSystem` object, required
      - `canonical` object, required
      - `expect` number, required
      - `places` integer, required
      - `meets` boolean, required
      - `shown` string, required
      - `link` string, required
    - `unpinned` string[], required
    - `allMeet` boolean, required
    - `citation` object, required
      - `author` string, required
      - `title` string, required
      - `version` string, nullable
      - `sourcesChecked` string, nullable
      - `url` string, required
      - `accessDate` string, nullable, required
      - `formats` object, required
        - `plain` string, required
        - `apa` string, required
        - `harvard` string, required
        - `bibtex` string, required
    - `licence` object, required
      - `name` string, required
      - `url` string, required
      - `attribution` string, required
    - `notice` string, required
  - object
    - `detail` 'summary', required
    - `tool` string, required
    - `title` string, required
    - `lines` object[], required: The result lines, as the report's table gives them.
    - `notes` string[], required: What a professional must decide, when to call one, a false-friend warning, that adoption is local: kept in every summary.
    - `citation` string, required: The one citation line, built from the answer's own data.
    - `url` string, nullable, required
    - `open` string, nullable, required
    - `more` string, nullable, required

## Other responses

- `404`: The request was refused; every problem is listed.

---

[API](https://skmtc.dev/craftquantities/apis/craft-quantities-engine-api.md) · [All operations](https://skmtc.dev/craftquantities/apis/craft-quantities-engine-api/llms.txt) · [OpenAPI document](https://skmtc.dev/craftquantities/apis/craft-quantities-engine-api/revisions/a69883abc23b?raw)