Chat Completions

Create chat completions using various AI models. This endpoint is compatible with OpenAI's chat completions API.

POST /v1/chat/completions Generate chat completions
▼
Creates a model response for the given chat conversation. Supports streaming and non-streaming responses.

Request Parameters

model string required
ID of the model to use. See available models in the Models tab.
messages array required
A list of messages comprising the conversation so far.
max_tokens integer optional
The maximum number of tokens to generate in the completion.
stream boolean optional
If set, partial message deltas will be sent as server-sent events.
temperature number optional
Controls randomness in the output. Range: 0.0 to 2.0.
top_p number optional
Nucleus sampling parameter. Range: 0.0 to 1.0.
timeout integer optional
Request timeout in seconds.

Try it out

Enter the model identifier you want to use
Maximum tokens to generate
Controls randomness (0.0 - 2.0)
Nucleus sampling (0.0 - 1.0)
Request timeout in seconds

Image Generation

Generate images from text descriptions using various AI image generation models.

POST /v1/images/generations Generate stunning images from text descriptions
Creates an image given a text prompt. Compatible with OpenAI's image generation API.

Request Parameters

prompt string required
A text description of the desired image(s). Maximum length is 1000 characters.
model string optional
The model to use for image generation. Defaults to dall-e-2.
n integer optional
The number of images to generate. Must be between 1 and 10. Default: 1
size string optional
The size of the generated images. Options: "256x256", "512x512", "1024x1024"

Try it out

Enter the image generation model identifier

Models

List and retrieve information about available AI models.

GET /v1/models List all available AI models
Lists the currently available models, and provides basic information about each one.

📋 Try it out

GET /v1/TTI/models List TTI models
▼
Lists the currently available Text-to-Image (TTI) models for image generation.

🎨 Try it out

Authentication

Manage API keys and authentication for the WebScout API.

POST /v1/auth/generate-key Generate API key
▼
Generate a new API key for accessing the WebScout API.

Request Parameters

username string required
Username for the API key.
name string optional
Friendly name for the API key.
rate_limit integer optional
Rate limit for the API key (requests per minute). Default: 10
expires_in_days integer optional
Number of days until the API key expires.

🔑 Try it out

GET /v1/auth/validate Validate API key
▼
Validate an API key and get information about its usage and limits.

✅ Try it out

Web Search

Search the web using various search engines including Google, Yep, and DuckDuckGo.

GET /search Unified web search
▼
Perform web searches across multiple search engines with support for different content types.

Query Parameters

q string required
Search query string.
engine string optional
Search engine: google, yep, duckduckgo. Default: google
max_results integer optional
Maximum number of results. Default: 10
type string optional
Search type: text, news, images, suggestions. Default: text
region string optional
Region code for localized results. Default: all
safesearch string optional
Safe search setting: on, moderate, off. Default: moderate

🔍 Try it out

System

System health and status endpoints.

GET /health Health check
▼
Check the health status of the API server and its components.

💚 Try it out