curl --location --request POST '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-raw '{
"model": "text-embedding-ada-002",
"name": "Ozzy Osbourne",
"filters": [
{
"field": "name",
"type": "string"
},
{
"field": "age",
"type": "number"
}
]
}'
{
"data": {
"id": "1",
"createdAt": "2023-08-23T22:13:31.539Z",
"status": "LIVE",
"name": "Ozzy Osbourne",
"model": "text-embedding-ada-002",
"dimensions": 1536,
"filters": [
{
"field": "name",
"type": "string"
},
{
"field": "age",
"type": "number"
}
],
"chunkConfig": {
"size": 500,
"overlap": 20
},
"tableChunkConfig": {
"size": 4000
},
"counts": {
"docs": 0,
}
}
}
🔗 Indexes
Add Index
This endpoint creates an index for an app.
POST
/
v1
/
indexes
curl --location --request POST '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-raw '{
"model": "text-embedding-ada-002",
"name": "Ozzy Osbourne",
"filters": [
{
"field": "name",
"type": "string"
},
{
"field": "age",
"type": "number"
}
]
}'
{
"data": {
"id": "1",
"createdAt": "2023-08-23T22:13:31.539Z",
"status": "LIVE",
"name": "Ozzy Osbourne",
"model": "text-embedding-ada-002",
"dimensions": 1536,
"filters": [
{
"field": "name",
"type": "string"
},
{
"field": "age",
"type": "number"
}
],
"chunkConfig": {
"size": 500,
"overlap": 20
},
"tableChunkConfig": {
"size": 4000
},
"counts": {
"docs": 0,
}
}
}
Auth Headers
string
required
An API key for your org.
string
required
A Client ID for your org.
Body
string
required
The Embedding Model to use. Can be either “text-embedding-ada-002”, “clip”, or “custom”.
string
required
Name of the Index
string
Datasource ID to connect to the index.
string
default:"HNSW"
Type of the index.
FLAT or HNSWinteger
This is only required if you are using a “custom” model.
object[]
object
Response
Index Object
Show properties
Show properties
string
Id of the index
string
Status of the index
string
Name of the index
string
Model used to generate the embeddings
number
Dimensions of the embeddings
object
curl --location --request POST '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-raw '{
"model": "text-embedding-ada-002",
"name": "Ozzy Osbourne",
"filters": [
{
"field": "name",
"type": "string"
},
{
"field": "age",
"type": "number"
}
]
}'
{
"data": {
"id": "1",
"createdAt": "2023-08-23T22:13:31.539Z",
"status": "LIVE",
"name": "Ozzy Osbourne",
"model": "text-embedding-ada-002",
"dimensions": 1536,
"filters": [
{
"field": "name",
"type": "string"
},
{
"field": "age",
"type": "number"
}
],
"chunkConfig": {
"size": 500,
"overlap": 20
},
"tableChunkConfig": {
"size": 4000
},
"counts": {
"docs": 0,
}
}
}