Skip to main content
POST
Rerank documents

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
model
enum<string>
required
Available options:
rerank-2.5,
rerank-2.5-lite
query
string
required
Minimum string length: 1
documents
string[]
required
Required array length: 1 - 1000 elements
Minimum string length: 1
top_n
integer
return_documents
boolean
default:false
truncation
boolean
default:false

Response

Document relevance and metered usage.

model
string
required
provider
string
required
results
object[]
required
usage
object
required
cost_usd
number
required
Required range: x >= 0
request_id
string
required