# Jupyter notebook to Markdown

Turn a Jupyter notebook (.ipynb) into Markdown: text cells as they are, code and its output as code blocks.

Reads the cells of a notebook in order and writes them as one Markdown text. Made for giving a notebook to a language model, or for reading one without Jupyter.

- Endpoint: `POST https://setget.net/v1/tools/ipynb-to-markdown` with JSON `{"input": {...}}` (add `"wait": 30` to hold the reply until the job finishes)
- MCP: `run_tool` with `slug` = `ipynb-to-markdown`
- Page: https://setget.net/tools/ipynb-to-markdown

## Files in, files out

This is a file tool. Its file inputs take file references, not file contents and not web addresses.

- Get a reference by uploading: `curl -T FILE https://setget.net/drop/` prints a line `ref  <id>/f1`. Or `POST https://setget.net/v1/drops` with `{"files":[{"name","size"}]}`, PUT the bytes to the returned `upload.url` with the listed headers, and use the file's `ref`. Over MCP use the `drop` tool. A file under about 700 KB can also be sent in place as a `data:<type>;base64,<content>` URI.
- Uploads are at most 100 MB per file, are readable by anyone with the link, and expire (one hour by default). Programs are refused.
- The tool runs as a job. The reply is `{"tool", "ms", "result", "files", "job"}`: `result` is JSON, and every result file comes back in `files` as `{"name", "size", "content_type", "kind", "url", "ref"}`. Download it from `url`, or pass `ref` as the input of another file tool.
- A job still running when the wait ends answers 202 with `job`. Follow it with `GET https://setget.net/v1/jobs/<id>?wait=30`, or stream progress from `GET https://setget.net/v1/jobs/<id>/events` (over MCP: the `job` tool). A person can watch it at `job.url`.

## Inputs

- `file` (required, file, a file reference such as `DROP_ID/f1`, accepts text, binary): The Jupyter notebook (.ipynb) to convert.
- `outputs` (optional, boolean, default `true`): Include what the code cells printed and returned.

## Example 1: A notebook with code and output

Upload first. Each placeholder below stands for the reference of one upload: `DROP_ID/f1` = [sample.ipynb](https://setget.net/static/samples/sample.ipynb).

```json
{"input":{"file":"DROP_ID/f1"},"wait":30}
```

## Example 2: Text and code only

Upload first. Each placeholder below stands for the reference of one upload: `DROP_ID/f1` = [sample.ipynb](https://setget.net/static/samples/sample.ipynb).

```json
{"input":{"file":"DROP_ID/f1","outputs":false},"wait":30}
```

**How are cells written?** Markdown cells are copied as they are. Code cells become code blocks marked with the language of the notebook. Each output follows its code under the word "Output:".

**What happens to plots and pictures?** They are left out and counted in the result. Markdown holds text only.

**What about tables from pandas?** A table in an output becomes a Markdown table.

**Are long outputs cut?** Each output is cut at 10,000 characters, with a line saying how much was left out. Colour codes and overwritten progress lines are removed.

**Is the code run?** No. The notebook is only read.

**Where is the Markdown?** In a file named after your upload, ending in .md. The result also holds the Markdown itself in "markdown" when it is up to 200,000 characters; "truncated" is true when only the start fits there.

**Does it fetch anything from the internet?** No. Links and picture addresses found in the file are copied as text. Nothing they point to is opened or downloaded.
