Direct Web Search API

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>"
  ]
}
'

import requests

url = "https://nano-gpt.com/api/web"

payload = {
    "query": "<string>",
    "provider": "<string>",
    "depth": "<string>",
    "outputType": "<string>",
    "structuredOutputSchema": "<string>",
    "includeImages": True,
    "fromDate": "<string>",
    "toDate": "<string>",
    "includeDomains": ["<string>"],
    "excludeDomains": ["<string>"]
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    query: '<string>',
    provider: '<string>',
    depth: '<string>',
    outputType: '<string>',
    structuredOutputSchema: '<string>',
    includeImages: true,
    fromDate: '<string>',
    toDate: '<string>',
    includeDomains: ['<string>'],
    excludeDomains: ['<string>']
  })
};

fetch('https://nano-gpt.com/api/web', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://nano-gpt.com/api/web",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'query' => '<string>',
    'provider' => '<string>',
    'depth' => '<string>',
    'outputType' => '<string>',
    'structuredOutputSchema' => '<string>',
    'includeImages' => true,
    'fromDate' => '<string>',
    'toDate' => '<string>',
    'includeDomains' => [
        '<string>'
    ],
    'excludeDomains' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://nano-gpt.com/api/web"

	payload := strings.NewReader("{\n  \"query\": \"<string>\",\n  \"provider\": \"<string>\",\n  \"depth\": \"<string>\",\n  \"outputType\": \"<string>\",\n  \"structuredOutputSchema\": \"<string>\",\n  \"includeImages\": true,\n  \"fromDate\": \"<string>\",\n  \"toDate\": \"<string>\",\n  \"includeDomains\": [\n    \"<string>\"\n  ],\n  \"excludeDomains\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://nano-gpt.com/api/web")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"<string>\",\n  \"provider\": \"<string>\",\n  \"depth\": \"<string>\",\n  \"outputType\": \"<string>\",\n  \"structuredOutputSchema\": \"<string>\",\n  \"includeImages\": true,\n  \"fromDate\": \"<string>\",\n  \"toDate\": \"<string>\",\n  \"includeDomains\": [\n    \"<string>\"\n  ],\n  \"excludeDomains\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://nano-gpt.com/api/web")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": \"<string>\",\n  \"provider\": \"<string>\",\n  \"depth\": \"<string>\",\n  \"outputType\": \"<string>\",\n  \"structuredOutputSchema\": \"<string>\",\n  \"includeImages\": true,\n  \"fromDate\": \"<string>\",\n  \"toDate\": \"<string>\",\n  \"includeDomains\": [\n    \"<string>\"\n  ],\n  \"excludeDomains\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

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

POST

api

web

Direct Web Search API

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>"
  ]
}
'

import requests

url = "https://nano-gpt.com/api/web"

payload = {
    "query": "<string>",
    "provider": "<string>",
    "depth": "<string>",
    "outputType": "<string>",
    "structuredOutputSchema": "<string>",
    "includeImages": True,
    "fromDate": "<string>",
    "toDate": "<string>",
    "includeDomains": ["<string>"],
    "excludeDomains": ["<string>"]
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    query: '<string>',
    provider: '<string>',
    depth: '<string>',
    outputType: '<string>',
    structuredOutputSchema: '<string>',
    includeImages: true,
    fromDate: '<string>',
    toDate: '<string>',
    includeDomains: ['<string>'],
    excludeDomains: ['<string>']
  })
};

fetch('https://nano-gpt.com/api/web', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://nano-gpt.com/api/web",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'query' => '<string>',
    'provider' => '<string>',
    'depth' => '<string>',
    'outputType' => '<string>',
    'structuredOutputSchema' => '<string>',
    'includeImages' => true,
    'fromDate' => '<string>',
    'toDate' => '<string>',
    'includeDomains' => [
        '<string>'
    ],
    'excludeDomains' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://nano-gpt.com/api/web"

	payload := strings.NewReader("{\n  \"query\": \"<string>\",\n  \"provider\": \"<string>\",\n  \"depth\": \"<string>\",\n  \"outputType\": \"<string>\",\n  \"structuredOutputSchema\": \"<string>\",\n  \"includeImages\": true,\n  \"fromDate\": \"<string>\",\n  \"toDate\": \"<string>\",\n  \"includeDomains\": [\n    \"<string>\"\n  ],\n  \"excludeDomains\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://nano-gpt.com/api/web")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"<string>\",\n  \"provider\": \"<string>\",\n  \"depth\": \"<string>\",\n  \"outputType\": \"<string>\",\n  \"structuredOutputSchema\": \"<string>\",\n  \"includeImages\": true,\n  \"fromDate\": \"<string>\",\n  \"toDate\": \"<string>\",\n  \"includeDomains\": [\n    \"<string>\"\n  ],\n  \"excludeDomains\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://nano-gpt.com/api/web")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": \"<string>\",\n  \"provider\": \"<string>\",\n  \"depth\": \"<string>\",\n  \"outputType\": \"<string>\",\n  \"structuredOutputSchema\": \"<string>\",\n  \"includeImages\": true,\n  \"fromDate\": \"<string>\",\n  \"toDate\": \"<string>\",\n  \"includeDomains\": [\n    \"<string>\"\n  ],\n  \"excludeDomains\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "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. You can also call this tool through the unified Data API at POST /api/v1/data/web/search. The Data API preserves this endpoint’s request body, response body, billing, and provider behavior while adding discovery and dispatch metadata. For chat-first workflows, use POST /api/v1/chat/completions with model suffixes like :online, :online/linkup, or :online/linkup-deep, including provider-specific suffixes such as :online/exa-instant, :online/exa-deep-reasoning, :online/brave, and :online/valyu-web-deep. See Model Suffixes.

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 want one discoverable endpoint family for data tools	`POST /api/v1/data/web/search`
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

Accountless x402 Payment

For accountless payment, prefer the public Data API path:

curl -i https://nano-gpt.com/api/v1/data/web/search \
  -H "Content-Type: application/json" \
  -H "x-x402: true" \
  -d '{
    "query": "What happened in AI this week?",
    "provider": "linkup",
    "depth": "standard",
    "outputType": "sourcedAnswer"
  }'

To request an accountless x402 quote, send the API request without Authorization or x-api-key, and include x-x402: true. NanoGPT will return 402 Payment Required with available payment options. This endpoint supports accountless x402 payments where listed by GET /api/v1/x402/endpoints, including Lightning L402 when advertised. See Accountless x402 API Payments for the full flow. If you receive 401 missing_api_key immediately, check that the initial quote request includes x-x402: true. Without that header, NanoGPT does not enter the x402 quote flow.

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

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 -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"
  }'

curl -X POST https://nano-gpt.com/api/web \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "Latest OpenAI announcements",
    "provider": "linkup",
    "depth": "deep",
    "outputType": "searchResults"
  }'

curl -X POST https://nano-gpt.com/api/web \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "Top 5 AI coding tools in 2026 with pricing",
    "provider": "linkup",
    "depth": "standard",
    "outputType": "structured",
    "structuredOutputSchema": "{\"type\":\"object\",\"properties\":{\"tools\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"price\":{\"type\":\"string\"}},\"required\":[\"name\"]}}},\"required\":[\"tools\"]}"
  }'

curl -X POST https://nano-gpt.com/api/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4o:online/linkup",
    "messages": [
      { "role": "user", "content": "Summarize today'\''s top AI headlines." }
    ]
  }'

Batch API Data API

Get Started

Endpoint Examples

API Reference

Miscellaneous

Partner

Integrations

Direct Web Search API

Overview

When to use which endpoint

Authentication

Accountless x402 Payment

Request body

Response shape

Example response

Pricing (hosted key)

Error codes

Examples

​Overview

​When to use which endpoint

​Authentication

​Accountless x402 Payment

​Request body

​Response shape

​Example response

​Pricing (hosted key)

​Error codes

​Examples

​Related docs

Overview

When to use which endpoint

Authentication

Accountless x402 Payment

Request body

Response shape

Example response

Pricing (hosted key)

Error codes

Examples

Related docs