












Beta Rag Search Indexes Endpoints
(beta) RAG API - search indexes.












Examples
Real world code examples
Get Deployment Summaries
GET /v1/rag/deployments#
Fetch all indexes available to a user
200
Successful Response
Playground
Test the endpoints live
curl https://api.mistral.ai/v1/rag/deployments \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'curl https://api.mistral.ai/v1/rag/deployments \
-X GET \
-H 'Authorization: Bearer YOUR_APIKEY_HERE'import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.rag.searchIndexes.getDeploymentSummaries();
console.log(result);
}
run();import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.rag.searchIndexes.getDeploymentSummaries();
console.log(result);
}
run();200
{
"deployments": [
{
"created_at": "2025-12-17T10:25:07.818693Z",
"creator_id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"deployment": {
"indexes": [
{
"document_count": null,
"id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"name": "My resource"
}
]
},
"document_count": 87,
"id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"modified_at": "2025-12-17T10:41:03.469341Z",
"name": "My resource",
"status": "online"
}
]
}{
"deployments": [
{
"created_at": "2025-12-17T10:25:07.818693Z",
"creator_id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"deployment": {
"indexes": [
{
"document_count": null,
"id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"name": "My resource"
}
]
},
"document_count": 87,
"id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
"modified_at": "2025-12-17T10:41:03.469341Z",
"name": "My resource",
"status": "online"
}
]
}Register (or re-register) a search index
PUT /v1/rag/deployments#
Register (or re-register) a search index
200
Successful Response
Playground
Test the endpoints live
curl https://api.mistral.ai/v1/rag/deployments \
-X PUT \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"deployment": {
"indexes": [
{
"fields": [
{
"index_type": "ann",
"multidimensional": false,
"name": "My resource",
"ranking": "count",
"storage": "in_memory",
"type": "int"
}
],
"name": "My resource",
"sd": "reprehenderit ut dolore"
}
],
"query_url": "occaecat dolor sit",
"vespa_version": "nostrud"
},
"name": "My resource"
}'curl https://api.mistral.ai/v1/rag/deployments \
-X PUT \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"deployment": {
"indexes": [
{
"fields": [
{
"index_type": "ann",
"multidimensional": false,
"name": "My resource",
"ranking": "count",
"storage": "in_memory",
"type": "int"
}
],
"name": "My resource",
"sd": "reprehenderit ut dolore"
}
],
"query_url": "occaecat dolor sit",
"vespa_version": "nostrud"
},
"name": "My resource"
}'import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.rag.searchIndexes.registerDeployment({
name: "<value>",
deployment: {
type: "vespa",
vespaVersion: "<value>",
indexes: [],
queryUrl: "https://joyful-granny.info",
},
});
console.log(result);
}
run();import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.rag.searchIndexes.registerDeployment({
name: "<value>",
deployment: {
type: "vespa",
vespaVersion: "<value>",
indexes: [],
queryUrl: "https://joyful-granny.info",
},
});
console.log(result);
}
run();200
{
"id": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}{
"id": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}Unregister Deployment
DELETE /v1/rag/deployments/{deployment_id}#
Delete all information about a deployment
200
Response Type
any
Successful Response
Playground
Test the endpoints live
curl https://api.mistral.ai/v1/rag/deployments/{deployment_id} \
-X DELETE \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json'curl https://api.mistral.ai/v1/rag/deployments/{deployment_id} \
-X DELETE \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json'import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.rag.searchIndexes.unregisterDeployment({
deploymentId: "240a5e63-fd68-4806-8290-04cce22b4c37",
});
console.log(result);
}
run();import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.rag.searchIndexes.unregisterDeployment({
deploymentId: "240a5e63-fd68-4806-8290-04cce22b4c37",
});
console.log(result);
}
run();200
nullnullUpdate Index Metrics
PUT /v1/rag/deployments/{deployment_id}/metrics#
Update the metrics for a given index
200
Response Type
any
Successful Response
Playground
Test the endpoints live
curl https://api.mistral.ai/v1/rag/deployments/{deployment_id}/metrics \
-X PUT \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"document_count": 87,
"index_metrics": [
{
"document_count": 14,
"name": "My resource"
}
],
"status": "consequat do"
}'curl https://api.mistral.ai/v1/rag/deployments/{deployment_id}/metrics \
-X PUT \
-H 'Authorization: Bearer YOUR_APIKEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"document_count": 87,
"index_metrics": [
{
"document_count": 14,
"name": "My resource"
}
],
"status": "consequat do"
}'import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.rag.searchIndexes.updateIndexMetrics({
deploymentId: "b0c2f463-8aef-437d-83ac-d4bfae874584",
requestBody: {
status: "offline",
clearMetrics: false,
},
});
console.log(result);
}
run();import { Mistral } from "@mistralai/mistralai";
const mistral = new Mistral({
apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});
async function run() {
const result = await mistral.beta.rag.searchIndexes.updateIndexMetrics({
deploymentId: "b0c2f463-8aef-437d-83ac-d4bfae874584",
requestBody: {
status: "offline",
clearMetrics: false,
},
});
console.log(result);
}
run();200
nullnull