NeonAPI Docs

POST /v1/rerank

Authentication

Use your NeonAPI API key in Authorization: Bearer YOUR_API_KEY. Keep the key in a trusted application environment.

Availability and compatibility

Check the selected model’s protocol, permissions, price and supported parameters before calling. Unsupported parameters may be rejected. Request examples use placeholders.

Request fields

application/json

Field	Type	Required	Constraints	Meaning
`model`	`string`	Yes	—	Exact published model ID.
`query`	`string`	Yes	—	Query used to rank documents.
`documents`	`string / object[]`	Yes	—	Candidate documents to rank.
`top_n`	`integer`	No	—	—
`return_documents`	`boolean`	No	default: `false`	—

Full field definitions, nested objects and referenced schemas are available in the downloadable specification.

Request example

export NEON_API_KEY="YOUR_API_KEY"
curl https://neon-api.com/v1/rerank \
  -H "Authorization: Bearer $NEON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "YOUR_MODEL_ID",
  "query": "constellation",
  "documents": [
    "A star map",
    "A travel guide"
  ]
}'

Responses

Fields vary by model and protocol. The schema below describes the documented successful response; streams use protocol-specific events.

Status	Meaning
200	Successful response

Response schema

Field	Type	Required	Constraints	Meaning
`id`	`string`	No	—	Identifier returned for this result or task.
`results`	`object[]`	No	—	—
`meta`	`object`	No	—	—

Download the user API OpenAPI specification

See errors and streaming & tasks.

Rerank documents