🔗 Indexes
Get Index
🔗 Indexes
Get Index
This endpoint gets a single index.
GET
/
v1
/
indexes
/
{indexId}
x-metal-api-key
string
*
x-metal-api-key
Required
string
An API key for your org.
x-metal-client-id
string
*
x-metal-client-id
Required
string
A Client ID for your org.
indexId
string
*
indexId
Required
string
The Index ID
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
requiredAn API key for your org.
x-metal-client-id
string
requiredA Client ID for your org.
Params
indexId
string
requiredThe Index ID
Response
data
Index Object
id
string
Id of the index
app
string
Id of the app of the index
name
string
Name of the index
model
string
Model used to generate the embeddings
datasource
string
The datasource id, if one is connected.
dimensions
number
Dimensions of the embeddings
chunkConfig
object
size
number
default: 500The token size of each chunk.
overlap
number
default: 20The token amount of overlap between chunks.
tableChunkConfig
object
size
number
default: 4000The token size of each chunk.
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
},
}
}