TypeScript SDK
import { NinjaChat } from "@ninjachat/sdk";
const client = new NinjaChat({ apiKey: process.env.NINJACHAT_API_KEY! });
const results = await client.search.query({ query: "Latest battery storage research" });
console.log(results);import os
from ninjachat import NinjaChat
client = NinjaChat(api_key=os.environ["NINJACHAT_API_KEY"])
results = client.search.query(query="Latest battery storage research")
print(results)curl --request POST \
--url https://www.ninjachat.ai/api/v1/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "<string>"
}
'{
"object": "search.results",
"query": "<string>",
"answer": "<string>",
"sources": [
{
"url": "<string>",
"title": "<string>",
"content": "<string>",
"published_date": "<string>"
}
],
"follow_up_questions": [
"<string>"
],
"provider": "<string>",
"cost_usd": 1,
"request_id": "<string>",
"cost": {
"this_request": "<string>",
"per_image": "<string>",
"per_video": "<string>",
"images": 1
},
"balance": "<string>",
"metadata": {
"latency_ms": 1,
"group": "<string>",
"search_depth": "<string>",
"results_count": 1
},
"images": [
{
"url": "<string>",
"description": "<string>"
}
]
}{
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"param": "<string>"
}
}{
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"param": "<string>"
}
}{
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"param": "<string>"
}
}{
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"param": "<string>"
}
}{
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"param": "<string>"
}
}Media & search
Search the web
POST
/
search
TypeScript SDK
import { NinjaChat } from "@ninjachat/sdk";
const client = new NinjaChat({ apiKey: process.env.NINJACHAT_API_KEY! });
const results = await client.search.query({ query: "Latest battery storage research" });
console.log(results);import os
from ninjachat import NinjaChat
client = NinjaChat(api_key=os.environ["NINJACHAT_API_KEY"])
results = client.search.query(query="Latest battery storage research")
print(results)curl --request POST \
--url https://www.ninjachat.ai/api/v1/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "<string>"
}
'{
"object": "search.results",
"query": "<string>",
"answer": "<string>",
"sources": [
{
"url": "<string>",
"title": "<string>",
"content": "<string>",
"published_date": "<string>"
}
],
"follow_up_questions": [
"<string>"
],
"provider": "<string>",
"cost_usd": 1,
"request_id": "<string>",
"cost": {
"this_request": "<string>",
"per_image": "<string>",
"per_video": "<string>",
"images": 1
},
"balance": "<string>",
"metadata": {
"latency_ms": 1,
"group": "<string>",
"search_depth": "<string>",
"results_count": 1
},
"images": [
{
"url": "<string>",
"description": "<string>"
}
]
}{
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"param": "<string>"
}
}{
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"param": "<string>"
}
}{
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"param": "<string>"
}
}{
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"param": "<string>"
}
}{
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"param": "<string>"
}
}Authorizations
Use an API key created in the NinjaChat developer console.
Headers
Safely retry the same logical write without duplicate billing or execution.
Required string length:
1 - 255Body
application/json
Required string length:
1 - 2000Available options:
web, news Required range:
1 <= x <= 20Available options:
basic, advanced Available options:
general, news, finance Response
Search results and optional answer.
Available options:
search.results Show child attributes
Show child attributes
Required range:
x >= 0Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes