Overview
π Account
π Analytics
ποΈ Datasources
𧬠Embedding Documents
π Indexes
Add Index
This endpoint creates an index for an app.
POST
/
v1
/
indexes
Copy
Ask AI
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"
}
]
}'
Copy
Ask AI
{
"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
An API key for your org.
A Client ID for your org.
Body
The Embedding Model to use. Can be either βtext-embedding-ada-002β, βclipβ, or βcustomβ.
Name of the Index
Datasource ID to connect to the index.
Type of the index. FLAT
or HNSW
This is only required if you are using a βcustomβ model.
Show properties
Show properties
The token size of each table chunk.
Response
Show properties
Show properties
Id of the index
Status of the index
Name of the index
Model used to generate the embeddings
Dimensions of the embeddings
Copy
Ask AI
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"
}
]
}'
Copy
Ask AI
{
"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,
}
}
}
Copy
Ask AI
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"
}
]
}'
Copy
Ask AI
{
"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,
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.