API reference
Rerank
Order documents by relevance to a query.
On this page
POST/v1/rerank
Scores each document against the query.
Auth: API key, or pay per request under https://api.usdf.fi/x402
| Name | Type | Required | Description |
|---|---|---|---|
model | string | Yes | A rerank model id. |
query | string | Yes | The query. |
documents | array | Yes | The texts to score. |
POST /v1/rerank
curl
curl -X POST https://api.usdf.fi/v1/rerank \
-H "Authorization: Bearer $USDF_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "<rerank model>",
"query": "How is USDF backed?",
"documents": ["The first document", "The second document"]
}'Response, trimmed
{
"results": [{ "index": 0, "relevance_score": … }, … ],
"receipt": { "request_id": "<request_id>", "cost": { … }, … }
}Foundry documentation