Skip to main content
POST
/
v1
/
rerank
curl --request POST \
  --url 'https://api.elkapi.com/v1/rerank' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "model": "jina-reranker-v2-base-multilingual",
  "query": "query",
  "documents": [
    "document"
  ]
}'

{
  "id": "id",
  "results": [
    {
      "index": 1,
      "relevance_score": 1,
      "document": {}
    }
  ],
  "meta": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.elkapi.com/llms.txt

Use this file to discover all available pages before exploring further.

curl --request POST \
  --url 'https://api.elkapi.com/v1/rerank' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "model": "jina-reranker-v2-base-multilingual",
  "query": "query",
  "documents": [
    "document"
  ]
}'

{
  "id": "id",
  "results": [
    {
      "index": 1,
      "relevance_score": 1,
      "document": {}
    }
  ],
  "meta": {}
}

​
Authorizations

​
Authorization
string
required
All endpoints require Bearer Token authentication.Add it to the request headers:
Authorization: Bearer YOUR_API_KEY

​
Body

​
model
string
default:"jina-reranker-v2-base-multilingual"
required
Example: jina-reranker-v2-base-multilingual
​
query
string
required
Query text
​
documents
array<string or object>
required
List of documents to rerank
​
top_n
integer
Return the top N results
​
return_documents
boolean
default:"false"

​
Response

​
id
string
​
results
array<object>
​
results.index
integer
​
results.relevance_score
number
​
results.document
object
​
meta
object