Direct Web Search API

Run direct web search requests with explicit query control, Linkup output formats, and normalized metadata

POST /api/web

Direct Web Search API

cURL

curl --request POST \
  --url https://nano-gpt.com/api/web \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "provider": "<string>",
  "depth": "<string>",
  "outputType": "<string>",
  "structuredOutputSchema": "<string>",
  "includeImages": true,
  "fromDate": "<string>",
  "toDate": "<string>",
  "includeDomains": [
    "<string>"
  ],
  "excludeDomains": [
    "<string>"
  ]
}
'

200

{
  "data": [
    {}
  ],
  "metadata": {
    "query": "<string>",
    "provider": "<string>",
    "depth": "<string>",
    "outputType": "<string>",
    "timestamp": "<string>",
    "cost": 123
  }
}

Overview

Use POST /api/web when you want direct control over search requests and output formatting.

For chat-first workflows, use POST /api/v1/chat/completions with model suffixes like :online, :online/linkup, or :online/linkup-deep.

When to use which endpoint

Use case	Endpoint
You want the model to answer with web context in one call	POST /api/v1/chat/completions + :online...
You need explicit control over query, outputType, domain/date filters, or structured schema output	POST /api/web
You need OpenAI-native web search	POST /api/v1/chat/completions only

Authentication

Either auth header is supported:

Authorization · string

Bearer YOUR_API_KEY

x-api-key · string

YOUR_API_KEY

Request body

query · string · required

Search query string.

provider · string · default: "linkup"

Search provider. openai-native is not allowed on /api/web.

depth · string · default: "standard"

Search depth. For Linkup: standard or deep.

For Linkup, depth: "standard" is executed as Linkup fast under the hood.

outputType · string · default: "searchResults"

Output mode. Allowed values: searchResults, sourcedAnswer, structured.

structuredOutputSchema · string

Required when outputType is structured. Pass a JSON schema string.

includeImages · boolean · default: false

Include image results.

fromDate · string

Earliest result date (YYYY-MM-DD).

toDate · string

Latest result date (YYYY-MM-DD).

includeDomains · string[]

Restrict results to these domains.

excludeDomains · string[]

Exclude these domains.

Linkup supports outputType: "searchResults", "sourcedAnswer", and "structured". Non-Linkup providers currently support only outputType: "searchResults".

Response shape

data · array|object

Provider-formatted payload.

metadata · object

Show metadata

query · string

Executed query.

provider · string

Resolved provider (for example, linkup).

depth · string

Resolved depth.

outputType · string

Resolved output type.

timestamp · string

ISO-8601 timestamp.

cost · number

Request cost in USD.

For searchResults, data is an array of normalized results. For sourcedAnswer and structured, data is the provider response object.

Example response

{
  "data": "... provider-formatted payload ...",
  "metadata": {
    "query": "string",
    "provider": "linkup",
    "depth": "standard",
    "outputType": "sourcedAnswer",
    "timestamp": "ISO-8601",
    "cost": 0.006
  }
}

Pricing (hosted key)

Mode	Price
Linkup standard	$0.006
Linkup deep	$0.06

Error codes

HTTP status	Meaning
400	Invalid parameters
401	Invalid session or auth
402	Insufficient balance or usage cap
429	Rate limited
503	Provider key missing
504	Search failed or timed out

Examples

cURL (Authorization)

curl -X POST https://nano-gpt.com/api/web \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "What happened in AI this week?",
    "provider": "linkup",
    "depth": "standard",
    "outputType": "sourcedAnswer"
  }'

Related docs

• Chat Completion
• Web Search in Text Generation Guide
• Brave provider specifics