#Rerank documents

Rerank a list of documents by relevance to a query

Service root: https://getrouter.ai

Protocol: Rerank API

Authentication: Authorization: Bearer YOUR_API_KEY

#Request body

The request body is required. Media type: application/json

#Request fields

#Example request

curl --request POST \
  --url https://getrouter.ai/v1/rerank \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "model": "MODEL_ID",
  "query": "string",
  "documents": [
    "string"
  ]
}'

#Responses

#Success response fields

#Example response

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

#Related guide

For complete workflows and examples, read the Rerank API Guide.

This page is generated from the public Relay OpenAPI specification. Browse the complete specification in the API Explorer.