---
url: /orchestration/reference/operations/InvokeWebScrapeStepTemplate.md
description: 'POST /v2/consumer/recipes/webScrape — WebScrape'
---

> Documentation index: https://developer.civitai.com/llms.txt — every page on this site has a markdown version at its URL + `.md`.

# WebScrape

`POST https://orchestration.civitai.com/v2/consumer/recipes/webScrape`

Operation `InvokeWebScrapeStepTemplate` · Recipes · Civitai Orchestration API, generated from the published OpenAPI spec ([v2-consumers.json](https://developer.civitai.com/openapi/v2-consumers.json)); the interactive HTML page is this URL without `.md`.

Fetches and renders a single web page, returning its content as markdown and/or HTML.

## Authentication

Send `Authorization: Bearer <token>` (the spec's `ApiKey` scheme); this operation documents `401 Unauthorized` for a missing or invalid token. See [Authentication](https://developer.civitai.com/orchestration/guide/authentication.md).

## Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `experimental` | query | boolean | no |  |
| `allowMatureContent` | query | boolean | no |  |
| `whatif` | query | boolean | no |  |
| `ephemeral` | query | boolean | no |  |
| `tier` | query | `WorkflowTier` (one of `paid`, `free`) | no | How a workflow is paid for. |

## Request body

Optional. Content types: `application/json`, `text/json`, `application/*+json`.

Schema `WebScrapeInput`.

| Field | Type | Required | Description |
|---|---|---|---|
| `url` | string (uri) | yes |  |
| `formats` | array of string | yes | The formats to return the page content in (e.g. "markdown", "html", "links"). |

## Responses

### 200 OK

Content type: `application/json`.

Schema `WebScrapeOutput`.

| Field | Type | Required | Description |
|---|---|---|---|
| `markdown` | string, nullable | no | The page content as markdown, when requested. |
| `html` | string, nullable | no | The page content as HTML, when requested. |
| `links` | array of string, nullable | no | The links found on the page, when requested. |
| `title` | string, nullable | no |  |
| `description` | string, nullable | no |  |
| `statusCode` | integer (int32), nullable | no |  |

### 400 Bad Request

Content type: `application/json`.

Schema `ProblemDetails`.

| Field | Type | Required | Description |
|---|---|---|---|
| `type` | string, nullable | no |  |
| `title` | string, nullable | no |  |
| `status` | integer (int32), nullable | no |  |
| `detail` | string, nullable | no |  |
| `instance` | string, nullable | no |  |

### 401 Unauthorized

Content type: `application/json`.

Schema `ProblemDetails` — fields as listed above.

### 403 Forbidden

Content type: `application/json`.

Schema `ProblemDetails` — fields as listed above.