curl --location --request POST 'https://api.getmetal.io/v1/search' \
--header 'Content-Type: application/json' \
--header 'x-metal-api-key: <api-key>' \
--header 'x-metal-client-id: <client-id>' \
--data-raw '{
"index": "index-id",
"text": "Generals gathered in their masses",
"filters": {
"and": [{
"field": "year",
"value": 1984,
"operator": "lte"
}],
"or": [{
"field": "name",
"value": "Iron Maiden",
"operator": "eq"
}, {
"field": "name",
"value": "Helloween",
"operator": "eq"
}]
}
}'
{
"data": [
{
"dist": "0.666",
"id": "1",
"text": "Eagle Fly Free",
"metadata": {
"name": "Helloween",
"year": 1984
},
"createdAt":"2023-08-22T18:30:11.493Z"
},
{
"id": "2",
"dist": "0.999",
"text": "The Trooper",
"metadata": {
"name": "Iron Maiden",
"year": 1978
},
"createdAt": "2023-08-10T11:44:53.010Z"
}
}
]
}
🧬 Embedding Documents
Search Documents
Semantically search your embedded documents.
POST
/
v1
/
search
curl --location --request POST 'https://api.getmetal.io/v1/search' \
--header 'Content-Type: application/json' \
--header 'x-metal-api-key: <api-key>' \
--header 'x-metal-client-id: <client-id>' \
--data-raw '{
"index": "index-id",
"text": "Generals gathered in their masses",
"filters": {
"and": [{
"field": "year",
"value": 1984,
"operator": "lte"
}],
"or": [{
"field": "name",
"value": "Iron Maiden",
"operator": "eq"
}, {
"field": "name",
"value": "Helloween",
"operator": "eq"
}]
}
}'
{
"data": [
{
"dist": "0.666",
"id": "1",
"text": "Eagle Fly Free",
"metadata": {
"name": "Helloween",
"year": 1984
},
"createdAt":"2023-08-22T18:30:11.493Z"
},
{
"id": "2",
"dist": "0.999",
"text": "The Trooper",
"metadata": {
"name": "Iron Maiden",
"year": 1978
},
"createdAt": "2023-08-10T11:44:53.010Z"
}
}
]
}
Auth Headers
string
required
An API key for your org.
string
required
A Client ID for your org.
Body
string
required
Index ID
string
Text
string
Image URL
number[]
Custom Embeddings
string[]
Subset of documents ids to match
object
Show properties
Show properties
object[]
Query
boolean
default:"false"
Return only a list of ids without any metadata.
number
default:"5"
The limit of possible reponses from your search. Max 100.
Response
Results Array
curl --location --request POST 'https://api.getmetal.io/v1/search' \
--header 'Content-Type: application/json' \
--header 'x-metal-api-key: <api-key>' \
--header 'x-metal-client-id: <client-id>' \
--data-raw '{
"index": "index-id",
"text": "Generals gathered in their masses",
"filters": {
"and": [{
"field": "year",
"value": 1984,
"operator": "lte"
}],
"or": [{
"field": "name",
"value": "Iron Maiden",
"operator": "eq"
}, {
"field": "name",
"value": "Helloween",
"operator": "eq"
}]
}
}'
{
"data": [
{
"dist": "0.666",
"id": "1",
"text": "Eagle Fly Free",
"metadata": {
"name": "Helloween",
"year": 1984
},
"createdAt":"2023-08-22T18:30:11.493Z"
},
{
"id": "2",
"dist": "0.999",
"text": "The Trooper",
"metadata": {
"name": "Iron Maiden",
"year": 1978
},
"createdAt": "2023-08-10T11:44:53.010Z"
}
}
]
}
⌘I