Skip to main content
POST
/
api
/
v1
/
search
Web Search
curl --request POST \
  --url https://ninjachat.ai/api/v1/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "latest developments in AI safety"
}
'
{
  "query": "<string>",
  "answer": "<string>",
  "sources": [
    {
      "url": "<string>",
      "title": "<string>",
      "content": "<string>",
      "published_date": "<string>"
    }
  ],
  "images": [
    {
      "url": "<string>",
      "description": "<string>"
    }
  ],
  "follow_up_questions": [
    "<string>"
  ],
  "cost": {
    "this_request": "$0.006"
  },
  "metadata": {
    "group": "<string>",
    "search_depth": "<string>",
    "results_count": 123,
    "latency_ms": 123
  }
}

Authorizations

​
Authorization
string
header
required

API key starting with nj_sk_

Body

application/json
​
query
string
required

Search query.

Required string length: 1 - 2000
​
group
enum<string>
default:web

Search source.

Available options:
web,
academic,
news
​
max_results
integer
default:10

Number of results to return.

Required range: 1 <= x <= 20
​
search_depth
enum<string>
default:basic

basic for fast results, advanced for deeper search.

Available options:
basic,
advanced
​
topic
enum<string>
default:general

Topic filter.

Available options:
general,
news,
finance
​
include_answer
boolean
default:true

Generate an AI-synthesized answer from the results.

​
include_images
boolean
default:false

Include image results.

Response

Search results.

​
query
string
​
answer
string

AI-synthesized answer (if include_answer is true).

​
sources
object[]
​
images
object[]
​
follow_up_questions
string[]
​
cost
object
​
metadata
object