Create rerank

cURL

curl --request POST \
  --url https://aigw.portkey.ai/v1/rerank \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "<string>",
  "query": "<string>",
  "documents": [
    "<string>"
  ],
  "top_n": 2,
  "return_documents": false,
  "max_tokens_per_doc": 2,
  "priority": 123,
  "rank_fields": [
    "<string>"
  ],
  "truncation": true,
  "parameters": {}
}
'

import requests

url = "https://aigw.portkey.ai/v1/rerank"

payload = {
    "model": "<string>",
    "query": "<string>",
    "documents": ["<string>"],
    "top_n": 2,
    "return_documents": False,
    "max_tokens_per_doc": 2,
    "priority": 123,
    "rank_fields": ["<string>"],
    "truncation": True,
    "parameters": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    model: '<string>',
    query: '<string>',
    documents: ['<string>'],
    top_n: 2,
    return_documents: false,
    max_tokens_per_doc: 2,
    priority: 123,
    rank_fields: ['<string>'],
    truncation: true,
    parameters: {}
  })
};

fetch('https://aigw.portkey.ai/v1/rerank', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://aigw.portkey.ai/v1/rerank",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'model' => '<string>',
    'query' => '<string>',
    'documents' => [
        '<string>'
    ],
    'top_n' => 2,
    'return_documents' => false,
    'max_tokens_per_doc' => 2,
    'priority' => 123,
    'rank_fields' => [
        '<string>'
    ],
    'truncation' => true,
    'parameters' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://aigw.portkey.ai/v1/rerank"

	payload := strings.NewReader("{\n  \"model\": \"<string>\",\n  \"query\": \"<string>\",\n  \"documents\": [\n    \"<string>\"\n  ],\n  \"top_n\": 2,\n  \"return_documents\": false,\n  \"max_tokens_per_doc\": 2,\n  \"priority\": 123,\n  \"rank_fields\": [\n    \"<string>\"\n  ],\n  \"truncation\": true,\n  \"parameters\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://aigw.portkey.ai/v1/rerank")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"model\": \"<string>\",\n  \"query\": \"<string>\",\n  \"documents\": [\n    \"<string>\"\n  ],\n  \"top_n\": 2,\n  \"return_documents\": false,\n  \"max_tokens_per_doc\": 2,\n  \"priority\": 123,\n  \"rank_fields\": [\n    \"<string>\"\n  ],\n  \"truncation\": true,\n  \"parameters\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://aigw.portkey.ai/v1/rerank")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"model\": \"<string>\",\n  \"query\": \"<string>\",\n  \"documents\": [\n    \"<string>\"\n  ],\n  \"top_n\": 2,\n  \"return_documents\": false,\n  \"max_tokens_per_doc\": 2,\n  \"priority\": 123,\n  \"rank_fields\": [\n    \"<string>\"\n  ],\n  \"truncation\": true,\n  \"parameters\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "object": "list",
  "results": [
    {
      "index": 123,
      "relevance_score": 123,
      "document": {
        "text": "<string>"
      }
    }
  ],
  "model": "<string>",
  "id": "<string>",
  "usage": {
    "search_units": 123
  },
  "provider": "<string>"
}

POST

rerank

cURL

curl --request POST \
  --url https://aigw.portkey.ai/v1/rerank \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "<string>",
  "query": "<string>",
  "documents": [
    "<string>"
  ],
  "top_n": 2,
  "return_documents": false,
  "max_tokens_per_doc": 2,
  "priority": 123,
  "rank_fields": [
    "<string>"
  ],
  "truncation": true,
  "parameters": {}
}
'

import requests

url = "https://aigw.portkey.ai/v1/rerank"

payload = {
    "model": "<string>",
    "query": "<string>",
    "documents": ["<string>"],
    "top_n": 2,
    "return_documents": False,
    "max_tokens_per_doc": 2,
    "priority": 123,
    "rank_fields": ["<string>"],
    "truncation": True,
    "parameters": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    model: '<string>',
    query: '<string>',
    documents: ['<string>'],
    top_n: 2,
    return_documents: false,
    max_tokens_per_doc: 2,
    priority: 123,
    rank_fields: ['<string>'],
    truncation: true,
    parameters: {}
  })
};

fetch('https://aigw.portkey.ai/v1/rerank', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://aigw.portkey.ai/v1/rerank",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'model' => '<string>',
    'query' => '<string>',
    'documents' => [
        '<string>'
    ],
    'top_n' => 2,
    'return_documents' => false,
    'max_tokens_per_doc' => 2,
    'priority' => 123,
    'rank_fields' => [
        '<string>'
    ],
    'truncation' => true,
    'parameters' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://aigw.portkey.ai/v1/rerank"

	payload := strings.NewReader("{\n  \"model\": \"<string>\",\n  \"query\": \"<string>\",\n  \"documents\": [\n    \"<string>\"\n  ],\n  \"top_n\": 2,\n  \"return_documents\": false,\n  \"max_tokens_per_doc\": 2,\n  \"priority\": 123,\n  \"rank_fields\": [\n    \"<string>\"\n  ],\n  \"truncation\": true,\n  \"parameters\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://aigw.portkey.ai/v1/rerank")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"model\": \"<string>\",\n  \"query\": \"<string>\",\n  \"documents\": [\n    \"<string>\"\n  ],\n  \"top_n\": 2,\n  \"return_documents\": false,\n  \"max_tokens_per_doc\": 2,\n  \"priority\": 123,\n  \"rank_fields\": [\n    \"<string>\"\n  ],\n  \"truncation\": true,\n  \"parameters\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://aigw.portkey.ai/v1/rerank")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"model\": \"<string>\",\n  \"query\": \"<string>\",\n  \"documents\": [\n    \"<string>\"\n  ],\n  \"top_n\": 2,\n  \"return_documents\": false,\n  \"max_tokens_per_doc\": 2,\n  \"priority\": 123,\n  \"rank_fields\": [\n    \"<string>\"\n  ],\n  \"truncation\": true,\n  \"parameters\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "object": "list",
  "results": [
    {
      "index": 123,
      "relevance_score": 123,
      "document": {
        "text": "<string>"
      }
    }
  ],
  "model": "<string>",
  "id": "<string>",
  "usage": {
    "search_units": 123
  },
  "provider": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-portkey-trace-id

string

x-portkey-span-id

string

x-portkey-parent-span-id

string

x-portkey-span-name

string

x-portkey-metadata

object

Body

application/json

model

string

required

query

string

required

documents

(string | object · object)[]

required

Minimum array length: 1

top_n

integer

Required range: x >= 1

return_documents

boolean

default:false

max_tokens_per_doc

integer

Required range: x >= 1

priority

number

rank_fields

string[]

truncation

boolean

parameters

object

Response

200 - application/json

object

enum<string>

required

Available options:

list

results

object[]

required

Show child attributes

model

string

required

string

usage

object

Show child attributes

provider

string

Last modified on September 17, 2026

API Reference

Inference

Authorizations

Headers

Body

Response