Skip to main content
POST
TypeScript SDK

Authorizations

Authorization
string
header
required

Use an API key created in the NinjaChat developer console.

Headers

Idempotency-Key
string

Safely retry the same logical write without duplicate billing or execution.

Required string length: 1 - 255

Body

application/json
query
string
required
Required string length: 1 - 2000
group
enum<string>
default:web
Available options:
web,
news
max_results
integer
default:10
Required range: 1 <= x <= 20
search_depth
enum<string>
default:basic
Available options:
basic,
advanced
topic
enum<string>
default:general
Available options:
general,
news,
finance
include_answer
boolean
default:true
include_images
boolean
default:false

Response

Search results and optional answer.

object
enum<string>
required
Available options:
search.results
query
string
required
answer
string | null
required
sources
object[]
required
follow_up_questions
string[]
required
provider
string
required
cost_usd
number
required
Required range: x >= 0
request_id
string
required
cost
object
balance
string
metadata
object
images
object[]