---
url: /orchestration/reference/operations/InvokeWebSearchStepTemplate.md
description: 'POST /v2/consumer/recipes/webSearch — WebSearch'
---

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

# WebSearch

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

Operation `InvokeWebSearchStepTemplate` · 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`.

Searches the web, returning result titles, URLs and descriptions, optionally with the scraped content of each result page.

## 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 `WebSearchInput`.

| Field | Type | Required | Description |
|---|---|---|---|
| `query` | string | yes |  |
| `limit` | integer (int32) | yes | The maximum number of results to return (1-10). |
| `scrapeFormats` | array of string, nullable | no | Optional formats to scrape each result page in (e.g. ["markdown"]). When omitted, only titles, URLs and descriptions are returned. |

## Responses

### 200 OK

Content type: `application/json`.

Schema `WebSearchOutput`.

| Field | Type | Required | Description |
|---|---|---|---|
| `results` | array of `WebSearchResult` | yes | The search results, in relevance order. |

### 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.