This endpoint is used to retrieve the post-processed contents of a web page in the format that the agentic search engine processes.

Location

Message

Error Type

ValidationError

ContentRequest

api key

HTTPValidationError

Critique AI Documentation

API Reference

Join Community

API Keys

Keys & Billing

Support

Get started using our superpowered browser extension

Welcome to the Critique Docs!

Search

Produce User Defined Service

List Designed Apis With Key

Design Api With Key

Delete Api With Key


> **⚠️ Important Note**: The auto-generated code samples in the playground will not work for this WebSocket endpoint, with the exception of the Python and JavaScript examples shown below. Please use these provided examples instead of the playground's auto-generated stubs.

This endpoint provides a WebSocket connection for streaming search results in real-time.

#### Connection
Connect to: `wss://api.critiquebrowser.app/v1/ws/search`

#### Headers
- **X-API-Key**: (Required) Your unique API key for authentication.

#### Message Format
After connecting, send a JSON message with the following structure:
```json
{
    "prompt": "your search query",
    "image": "optional base64 image or URL",
    "source_blacklist": ["optional list of domains to exclude"],
    "output_format": {
        // Optional structured output format
    }
}
```

#### Streaming Responses
The server will stream responses as JSON messages with the following structure:
```json
{
    "type": "response" | "context" | "error",
    "content": "the actual content"
}
```

- `type: "response"` - Contains generated response content
- `type: "context"` - Contains source context information
- `type: "error"` - Contains error messages if any occur


Streaming Search

API Reference

Contents

Authorizations

Body

Response