GET
/
v1
/
indexes
/
{indexId}
curl --location --request GET 'https://api.getmetal.io/v1/indexes/{indexId}' \
--header 'Content-Type: application/json' \
--header 'x-metal-api-key: <api-key>' \
--header 'x-metal-client-id: <client-id>' \

{
  "data": {
    "id": "1",
    "createdAt": "2023-07-03T14:25:22.104Z",
    "app": "<APP_ID>",
    "name": "Danzig's Index",
    "model": "clip",
    "datasource": "<DATASOURCE_ID>",
    "dimensions": 512,
    "lastActivityAt": "2023-09-14T13:18:52.547Z",
    "lastSearchAt": "2023-09-14T13:18:52.547Z",
    "filters": [
      {
        "field": "name",
        "type": "string"
      },
      {
        "field": "age",
        "type": "number"
      }
    ],
    "counts": {
      "docs": 42,
      "searches": 666
    },
    "chunkConfig": {
      "size": 999
    },
    "tableChunkConfig": {
      "size": 4000
    },
  }
}

​
Auth Headers

​
x-metal-api-key
string
required

An API key for your org.

​
x-metal-client-id
string
required

A Client ID for your org.

​
Params

​
indexId
string
required

The Index ID

​
Response

​
data
Index Object
curl --location --request GET 'https://api.getmetal.io/v1/indexes/{indexId}' \
--header 'Content-Type: application/json' \
--header 'x-metal-api-key: <api-key>' \
--header 'x-metal-client-id: <client-id>' \

{
  "data": {
    "id": "1",
    "createdAt": "2023-07-03T14:25:22.104Z",
    "app": "<APP_ID>",
    "name": "Danzig's Index",
    "model": "clip",
    "datasource": "<DATASOURCE_ID>",
    "dimensions": 512,
    "lastActivityAt": "2023-09-14T13:18:52.547Z",
    "lastSearchAt": "2023-09-14T13:18:52.547Z",
    "filters": [
      {
        "field": "name",
        "type": "string"
      },
      {
        "field": "age",
        "type": "number"
      }
    ],
    "counts": {
      "docs": 42,
      "searches": 666
    },
    "chunkConfig": {
      "size": 999
    },
    "tableChunkConfig": {
      "size": 4000
    },
  }
}