---
title: "Extract Markdown"
method: POST
path: "/global/extract/markdown/v1"
tags: ["Global", "Croma"]
---

# Extract Markdown

`POST /global/extract/markdown/v1`

## Request

- Base URL: `https://api.croma.run`
- URL: `https://api.croma.run/global/extract/markdown/v1`
- Auth: HTTP bearer

Turn any public web page into clean Markdown. `scope` keeps either the article body or the whole page, and `include_metadata` adds the page's title, author, published date and image. Handles pages that render themselves in the browser at `effort: max`.

## Headers

- `Idempotency-Key` string

## Request body

- object
  - `url` string, uri, required: Public http or https URL of the page to read. Loopback and private addresses are not accepted.
  - `scope` 'main' | 'full': `main` keeps the article body and drops navigation and boilerplate; `full` keeps the whole page.
  - `effort` 'min' | 'standard' | 'max': Effort to spend on the page: `min` is fastest and may serve a recent copy, `standard` is the balanced default, `max` always reads the page live and handles pages that render themselves in the browser.
  - `include_metadata` boolean: Include the page's title, author, published date and image in the response.

## Response `200`

Successful response

- ExtractMarkdownResponse
  - `data` object, required
    - `url` string, uri, required: The page that was read, after any redirects.
    - `markdown` string, required
    - `metadata` PageMetadata, required
      - `title` string, nullable, required
      - `author` string, nullable, required
      - `published_at` string, nullable, required
      - `image` string, uri, nullable, required

## Other responses

- `400`: Invalid request body
- `401`: Missing or invalid API key
- `404`: Resource not found in upstream source
- `429`: Rate limit exceeded
- `500`: Internal error
- `502`: Upstream source returned an error

---

[API](https://skmtc.dev/usecroma/apis/croma-marketplace-api.md) · [All operations](https://skmtc.dev/usecroma/apis/croma-marketplace-api/llms.txt) · [OpenAPI document](https://skmtc.dev/usecroma/apis/croma-marketplace-api/revisions/df016cdb29d7?raw)