Download OpenAPI Spec
Home
Tree BG 1
Tree
Tree
TreeLeaves
TreeLeaves
Cat IdleGrassGrassRockRock

Beta Rag Search Indexes Endpoints

Register (or re-register) a search index

PUT /v1/rag/indexes

200

Successful Response

id
*string

Playground

Test the endpoints live

curl https://api.mistral.ai/v1/rag/indexes \
 -X PUT \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "index": {
    "k8s_cluster": "production-cluster",
    "k8s_namespace": "search",
    "query_url": "reprehenderit ut dolore",
    "schemas": [
      {
        "fields": [
          {
            "index_type": "1",
            "name": "My resource",
            "storage": "1",
            "type": "1"
          }
        ],
        "name": "My resource",
        "sd": "aute aliqua aute commodo"
      }
    ],
    "vespa_instance_name": "mistral-search",
    "vespa_version": "dolor"
  },
  "name": "My resource"
}'

200

{
  "id": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}

Get Index Summaries

GET /v1/rag/indexes/summary

Fetch summary view of all indexes available to a user

200

Response Type
array<GetSearchIndexSummaryResponseIndex>

Successful Response

GetSearchIndexSummaryResponseIndex

{object}

Playground

Test the endpoints live

curl https://api.mistral.ai/v1/rag/indexes/summary \
 -X GET \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE'

200

[
  {
    "created_at": "2025-12-17T10:25:07.818693Z",
    "creator_id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
    "document_count": 87,
    "id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
    "index": {
      "k8s_cluster": "production-cluster",
      "k8s_namespace": "search",
      "schemas": [
        {
          "document_count": null,
          "id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
          "name": "My resource"
        }
      ],
      "vespa_instance_name": "mistral-search"
    },
    "modified_at": "2025-12-17T10:41:03.469341Z",
    "name": "My resource",
    "status": "online"
  }
]

Unregister Search Index

DELETE /v1/rag/indexes/index/{index_id}

Delete all information about an index

200

Response Type
any

Successful Response

Playground

Test the endpoints live

curl https://api.mistral.ai/v1/rag/indexes/index/{index_id} \
 -X DELETE \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json'

200

null

Update Index Metrics

PUT /v1/rag/indexes/index/{index_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/indexes/index/{index_id}/metrics \
 -X PUT \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "document_count": 87,
  "schema_metrics": [
    {
      "document_count": 14,
      "name": "My resource"
    }
  ],
  "status": "consequat do"
}'

200

null

Get Index Details

GET /v1/rag/indexes/index/{index_id}/detail

Get a detailed view of the stored data for a single index

200

Successful Response

name
*string
schemas
*array<GetSearchIndexDetailResponseSchemaModel>
summary
*string|null
vespa_version
*string|null

Playground

Test the endpoints live

curl https://api.mistral.ai/v1/rag/indexes/index/{index_id}/detail \
 -X GET \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE'

200

{
  "name": "My resource",
  "schemas": [
    {
      "document_count": null,
      "id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
      "last_modified": "2025-12-17T10:25:07.818693Z",
      "latency_p95_s_threshold": null,
      "name": "My resource"
    }
  ],
  "summary": null,
  "vespa_version": null
}

Set Index Summary

PUT /v1/rag/indexes/index/{index_id}/summary_field

Update the summary field for an index

200

Response Type
any

Successful Response

Playground

Test the endpoints live

curl https://api.mistral.ai/v1/rag/indexes/index/{index_id}/summary_field \
 -X PUT \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "summary": "ipsum eiusmod"
}'

200

null

Get Index Schema Detail

GET /v1/rag/indexes/index/{index_id}/schemas/schema/{schema_id}/detail

Get a detailed view of the stored information for a schema

200

Successful Response

embedding_dimensions
*integer|null
fields
*array<GetSearchIndexSchemaDetailResponseField>
name
*string
summary
*string|null

Playground

Test the endpoints live

curl https://api.mistral.ai/v1/rag/indexes/index/{index_id}/schemas/schema/{schema_id}/detail \
 -X GET \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE'

200

{
  "embedding_dimensions": null,
  "fields": [
    {
      "index_type": "1",
      "name": "My resource",
      "storage": "1",
      "type": "1"
    }
  ],
  "name": "My resource",
  "summary": null
}

Set Schema Summary

PUT /v1/rag/indexes/index/{index_id}/schemas/schema/{schema_id}/summary_field

Update the summary field for an index

200

Response Type
any

Successful Response

Playground

Test the endpoints live

curl https://api.mistral.ai/v1/rag/indexes/index/{index_id}/schemas/schema/{schema_id}/summary_field \
 -X PUT \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "summary": "ipsum eiusmod"
}'

200

null

Get Index Schema File

GET /v1/rag/indexes/index/{index_id}/schemas/schema/{schema_id}/file

200

Successful Response

content
*string|null

Playground

Test the endpoints live

curl https://api.mistral.ai/v1/rag/indexes/index/{index_id}/schemas/schema/{schema_id}/file \
 -X GET \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE'

200

{
  "content": null
}

Document Lookup

GET /v1/rag/indexes/index/{index_id}/schemas/schema/{schema_id}/retrievables/retrievable/{document_id}

Fetch stored information about a retrievable element stored in an index

200

Successful Response

fields
*map<any>
id
*string

Playground

Test the endpoints live

curl https://api.mistral.ai/v1/rag/indexes/index/{index_id}/schemas/schema/{schema_id}/retrievables/retrievable/{document_id} \
 -X GET \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE'

200

{
  "fields": [
    null
  ],
  "id": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}

Document Fetch

GET /v1/rag/indexes/index/{index_id}/schemas/schema/{schema_id}/retrievables

Fetch a few stored retrievable elements from the index/schema

200

Response Type
array<VespaGetRetrievableResponseRetrievable>

Successful Response

VespaGetRetrievableResponseRetrievable

{object}

Playground

Test the endpoints live

curl https://api.mistral.ai/v1/rag/indexes/index/{index_id}/schemas/schema/{schema_id}/retrievables \
 -X GET \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE'

200

[
  {
    "fields": [
      null
    ],
    "id": "019b2bd7-96e7-7219-8c0b-45a73da50088"
  }
]