---
title: "Shared Markdown Writeup"
method: GET
path: "/api/dashboards/{slug}/writeup"
tags: ["dashboards"]
---

# Shared Markdown Writeup

`GET /api/dashboards/{slug}/writeup`

## Path parameters

- `slug` string, required

## Response `200`

Successful Response

- SharedMarkdownWriteup
  - `format` 'markdown'
  - `kind` 'writeup' | 'dashboard'
  - `title` string, required
  - `markdown` string, required
  - `path` string, required
  - `asset_urls` string[], required
  - `content_version` string, required
  - `live_figures` object

## Other responses

- `422` — Validation Error

## Changes

- **2026-09-23** `d7f2f3b8e82d` — 1 info
  - added the optional property `live_figures` to the response with the `200` status
- **2026-09-22** `397ad3a1d858` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/quadrillion/apis/quadrillion-cloud-api/changes/api/dashboards/:slug/writeup/get.md)

---

[API](https://skmtc.dev/quadrillion/apis/quadrillion-cloud-api.md) · [All operations](https://skmtc.dev/quadrillion/apis/quadrillion-cloud-api/llms.txt) · [OpenAPI document](https://skmtc.dev/quadrillion/apis/quadrillion-cloud-api/revisions/d61e2ec5a271?raw)