API Reference

Jina Rerank

POST https://api.tu-zi.com/v1/rerank

Preview guide

Paste into an AI assistant to help with integration. Documentation and examples only; no real credentials.

# Jina Rerank

Jina Rerank

## Endpoint and authentication

`POST https://api.tu-zi.com/v1/rerank`

Transport: json

Use an inference API key. Examples contain placeholders; read credentials from environment variables.

```http
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
```

## Body parameters

| Field | Type | Required | Description / constraints |
| --- | --- | --- | --- |
| model | string | Yes | Reranking model identifier. Example: jina-reranker-v2-base-multilingual |
| query | string | Yes | Search query. Example: 退款多久能到账？ |
| documents | array | Yes | Documents to rank. Example: ["文档 A","文档 B"] |
| top_n | number | No | Return the N most relevant results. Form initial value (not an upstream default): 2 Range in this definition: 1 ~ 100 Example: 3 |

## Minimal request example

```json
{
  "model": "YOUR_MODEL",
  "query": "API gateway",
  "documents": [
    "An API gateway routes requests.",
    "A tree is green."
  ]
}
```

## Before running

Replace https://api.tu-zi.com with this site origin (do not append /v1 twice), and YOUR_MODEL with the exact marketplace model ID. Install requests for Python; use Node.js 20+ and save JavaScript as .mjs. WebSocket samples list their own dependencies.

Create an inference key on the site and set API_KEY in the environment; replace YOUR_API_KEY in cURL. Prepare local input.png/input.wav files for upload examples.

Start with a minimal request, then read the result using the response fields below. For async APIs, a returned task ID requires polling; acceptance does not mean generation has finished.

## Code examples

### curl

```bash
curl --request POST 'https://api.tu-zi.com/v1/rerank' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "model": "YOUR_MODEL",
  "query": "API gateway",
  "documents": [
    "An API gateway routes requests.",
    "A tree is green."
  ]
}'
```

### python

```python
import json
import os
import requests

url = "https://api.tu-zi.com/v1/rerank"
headers = json.loads("{\"Authorization\":\"Bearer YOUR_API_KEY\",\"Content-Type\":\"application/json\"}")
headers["Authorization"] = "Bearer " + os.environ["API_KEY"]
payload = json.loads("{\"model\":\"YOUR_MODEL\",\"query\":\"API gateway\",\"documents\":[\"An API gateway routes requests.\",\"A tree is green.\"]}")
response = requests.request("POST", url, headers=headers, json=payload, timeout=120)
response.raise_for_status()
result = response.json()
if isinstance(result, dict) and (result.get("success") is False or result.get("error")):
    raise RuntimeError(json.dumps(result, ensure_ascii=False))
print(result)  # Also inspect protocol-specific status/code fields.
```

### javascript

```javascript
// Node.js 20+
const url = "https://api.tu-zi.com/v1/rerank";
const headers = {
  "Authorization": "Bearer YOUR_API_KEY",
  "Content-Type": "application/json"
};
headers.Authorization = 'Bearer ' + process.env.API_KEY;
const response = await fetch(url, { method: "POST", headers, body: JSON.stringify({
  "model": "YOUR_MODEL",
  "query": "API gateway",
  "documents": [
    "An API gateway routes requests.",
    "A tree is green."
  ]
}) });
if (!response.ok) throw new Error(await response.text());
const result = await response.json();
if (result?.success === false || result?.error) throw new Error(JSON.stringify(result));
console.log(result); // Also inspect protocol-specific status/code fields.
```

## Response fields

| Field | Type | Description / constraints |
| --- | --- | --- |
| results[].index | integer | Input document index. |
| results[].relevance_score | number | Relevance score. |

Illustrative response; some endpoints show essential fields only. Optional fields may be absent.

```json
{
  "results": [
    {
      "index": 0,
      "relevance_score": 0.95
    }
  ]
}
```

## Errors and retries

Check HTTP status and protocol-specific errors; do not mix error formats across protocols. For 401/403 check credentials and permissions, for 429 back off, and for 5xx check gateway/upstream status. Error bodies may contain error/message/code depending on the protocol.

Use bounded exponential backoff for reads. Do not blindly retry task creation, generation, or key mutations, to avoid duplicate billing or execution.

## Constraints

This page describes the base protocol. Use the selected model quick start for supported fields, enums, limits and asynchronous behavior. Replace YOUR_MODEL. Form initial values are not upstream defaults.

## Documentation source

Definition version: 1

Reviewed: 2026-11-02

Source: https://api.tu-zi.com/en/docs/api/reference-relay-jina-rerank

Related protocol guide: https://api.tu-zi.com/docs/api/retrieval

This export contains documentation and examples only, without real credentials, account data or user requests.

Updated 2026-11-02 · Reviewed 2026-11-02

Endpoint and authentication

POST https://api.tu-zi.com/v1/rerank

Transport: json

Use an inference API key. Examples contain placeholders; read credentials from environment variables.

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Minimal request example

{
  "model": "YOUR_MODEL",
  "query": "API gateway",
  "documents": [
    "An API gateway routes requests.",
    "A tree is green."
  ]
}

Before running

Replace https://api.tu-zi.com with this site origin (do not append /v1 twice), and YOUR_MODEL with the exact marketplace model ID. Install requests for Python; use Node.js 20+ and save JavaScript as .mjs. WebSocket samples list their own dependencies.

Create an inference key on the site and set API_KEY in the environment; replace YOUR_API_KEY in cURL. Prepare local input.png/input.wav files for upload examples.

Start with a minimal request, then read the result using the response fields below. For async APIs, a returned task ID requires polling; acceptance does not mean generation has finished.

Constraints

This page describes the base protocol. Use the selected model quick start for supported fields, enums, limits and asynchronous behavior. Replace YOUR_MODEL. Form initial values are not upstream defaults.

Body parameters

Field	Type	Required	Description / constraints
model	string	Yes	Reranking model identifier. Example: jina-reranker-v2-base-multilingual
query	string	Yes	Search query. Example: 退款多久能到账？
documents	array	Yes	Documents to rank. Example: ["文档 A","文档 B"]
top_n	number	No	Return the N most relevant results. Form initial value (not an upstream default): 2 Range in this definition: 1 ~ 100 Example: 3

Response fields

Field	Type	Description / constraints
results[].index	integer	Input document index.
results[].relevance_score	number	Relevance score.

Illustrative response; some endpoints show essential fields only. Optional fields may be absent.

{
  "results": [
    {
      "index": 0,
      "relevance_score": 0.95
    }
  ]
}

Errors and retries

Check HTTP status and protocol-specific errors; do not mix error formats across protocols. For 401/403 check credentials and permissions, for 429 back off, and for 5xx check gateway/upstream status. Error bodies may contain error/message/code depending on the protocol.

Use bounded exponential backoff for reads. Do not blindly retry task creation, generation, or key mutations, to avoid duplicate billing or execution.

Document information and sources

Documentation source

Definition version: 1

Reviewed: 2026-11-02

Source: https://api.tu-zi.com/en/docs/api/reference-relay-jina-rerank

Related protocol guide: https://api.tu-zi.com/docs/api/retrieval

This export contains documentation and examples only, without real credentials, account data or user requests.

Request examples

curl --request POST 'https://api.tu-zi.com/v1/rerank' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "model": "YOUR_MODEL",
  "query": "API gateway",
  "documents": [
    "An API gateway routes requests.",
    "A tree is green."
  ]
}'

import json
import os
import requests

url = "https://api.tu-zi.com/v1/rerank"
headers = json.loads("{\"Authorization\":\"Bearer YOUR_API_KEY\",\"Content-Type\":\"application/json\"}")
headers["Authorization"] = "Bearer " + os.environ["API_KEY"]
payload = json.loads("{\"model\":\"YOUR_MODEL\",\"query\":\"API gateway\",\"documents\":[\"An API gateway routes requests.\",\"A tree is green.\"]}")
response = requests.request("POST", url, headers=headers, json=payload, timeout=120)
response.raise_for_status()
result = response.json()
if isinstance(result, dict) and (result.get("success") is False or result.get("error")):
    raise RuntimeError(json.dumps(result, ensure_ascii=False))
print(result)  # Also inspect protocol-specific status/code fields.

// Node.js 20+
const url = "https://api.tu-zi.com/v1/rerank";
const headers = {
  "Authorization": "Bearer YOUR_API_KEY",
  "Content-Type": "application/json"
};
headers.Authorization = 'Bearer ' + process.env.API_KEY;
const response = await fetch(url, { method: "POST", headers, body: JSON.stringify({
  "model": "YOUR_MODEL",
  "query": "API gateway",
  "documents": [
    "An API gateway routes requests.",
    "A tree is green."
  ]
}) });
if (!response.ok) throw new Error(await response.text());
const result = await response.json();
if (result?.success === false || result?.error) throw new Error(JSON.stringify(result));
console.log(result); // Also inspect protocol-specific status/code fields.