🔗 Indexes
List Indexes
🔗 Indexes
List Indexes
This endpoint gets a list of indexes for an app.
GET
/
v1
/
indexes
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.
appId
string
*
appId
Required
string
The App ID
curl --location --request GET 'https://api.getmetal.io/v1/indexes' \
--header 'Content-Type: application/json' \
--header 'x-metal-api-key: <api-key>' \
--header 'x-metal-client-id: <client-id>' \
{
"data": [
{
"id": "1",
"createdAt": "2023-08-23T22:13:31.539Z",
"app": "<APP_ID>",
"name": "Bruce's Index",
"model": "text-embedding-ada-002",
"dimensions": 1536,
"datasource": "<DATASOURCE_ID>",
"lastActivityAt": "2023-09-14T13:18:52.547Z",
"lastSearchAt": "2023-09-14T13:18:52.547Z",
"filters": [
{
"field": "name",
"type": "string"
},
{
"field": "age",
"type": "number"
}
],
"chunkConfig": {
"size": 24000
}
},
{
"id": "2",
"createdAt": "2023-08-23T15:35:27.398Z",
"app": "<APP_ID>",
"name": "Dave's Index",
"model": "clip",
"dimensions": 512,
"datasource": "<DATASOURCE_ID>",
"filters": [
{
"field": "name",
"type": "string"
},
{
"field": "age",
"type": "number"
}
],
"chunkConfig": {
"size": 24000
}
}
]
}
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
appId
string
requiredThe App ID
Response
data
Index Array
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
curl --location --request GET 'https://api.getmetal.io/v1/indexes' \
--header 'Content-Type: application/json' \
--header 'x-metal-api-key: <api-key>' \
--header 'x-metal-client-id: <client-id>' \
{
"data": [
{
"id": "1",
"createdAt": "2023-08-23T22:13:31.539Z",
"app": "<APP_ID>",
"name": "Bruce's Index",
"model": "text-embedding-ada-002",
"dimensions": 1536,
"datasource": "<DATASOURCE_ID>",
"lastActivityAt": "2023-09-14T13:18:52.547Z",
"lastSearchAt": "2023-09-14T13:18:52.547Z",
"filters": [
{
"field": "name",
"type": "string"
},
{
"field": "age",
"type": "number"
}
],
"chunkConfig": {
"size": 24000
}
},
{
"id": "2",
"createdAt": "2023-08-23T15:35:27.398Z",
"app": "<APP_ID>",
"name": "Dave's Index",
"model": "clip",
"dimensions": 512,
"datasource": "<DATASOURCE_ID>",
"filters": [
{
"field": "name",
"type": "string"
},
{
"field": "age",
"type": "number"
}
],
"chunkConfig": {
"size": 24000
}
}
]
}