Search the web
Runs a live web search and returns ranked results (title, URL, snippet).
Billed at a flat rate per request regardless of how many results are returned. See Models & pricing.
POST
https://api.deutschlandgpt.de/v2/searchExample request
curl https://api.deutschlandgpt.de/v2/search \
-X POST \
-H "Authorization: Bearer $DGPT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"query": "latest EU AI regulation",
"count": 10,
"country": "DE",
"search_lang": "de",
"model": "web-search"
}'curl https://api.deutschlandgpt.de/v2/search \
-X POST \
-H "Authorization: Bearer $DGPT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"query": "latest EU AI regulation",
"count": 10,
"country": "DE",
"search_lang": "de",
"model": "web-search"
}'import os, requests
response = requests.post(
"https://api.deutschlandgpt.de/v2/search",
headers={"Authorization": f"Bearer {os.environ['DGPT_API_KEY']}"},
json={
"query": "latest EU AI regulation",
"count": 10,
"country": "DE",
"search_lang": "de",
"model": "web-search"
},
)
print(response.json())import os, requests
response = requests.post(
"https://api.deutschlandgpt.de/v2/search",
headers={"Authorization": f"Bearer {os.environ['DGPT_API_KEY']}"},
json={
"query": "latest EU AI regulation",
"count": 10,
"country": "DE",
"search_lang": "de",
"model": "web-search"
},
)
print(response.json())const response = await fetch('https://api.deutschlandgpt.de/v2/search', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.DGPT_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"query": "latest EU AI regulation",
"count": 10,
"country": "DE",
"search_lang": "de",
"model": "web-search"
}),
});
console.log(await response.json());const response = await fetch('https://api.deutschlandgpt.de/v2/search', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.DGPT_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"query": "latest EU AI regulation",
"count": 10,
"country": "DE",
"search_lang": "de",
"model": "web-search"
}),
});
console.log(await response.json());Request body
querystringrequiredThe search query.
countintegeroptionalMaximum number of results to return (1–20). Does not affect billing.
countrystringoptionalTwo-letter country code to localize results.
search_langstringoptionalLanguage code for the results.
modelstringoptionalWeb-search model ID.
Response
200application/json
{
"object": "web_search",
"model": "string",
"query": "string",
"data": [
{
"title": "string",
"url": "string",
"description": "string",
"age": "string"
}
],
"usage": {
"queries": 0
}
}{
"object": "web_search",
"model": "string",
"query": "string",
"data": [
{
"title": "string",
"url": "string",
"description": "string",
"age": "string"
}
],
"usage": {
"queries": 0
}
}Web search results
objectstringmodelstringquerystringdataobject[]titlestringurlstringdescriptionstringagestringusageobjectqueriesintegerResponse codes
200
Web search results
object400
Invalid request
401
Unauthorized
402
Insufficient credits
404
Model not found
502
Web search failed
Was this page helpful?