Skip to main content
POST

Auth Headers

x-metal-api-key
string
required
An API key for your org.
x-metal-client-id
string
required
A Client ID for your org.

Body

index
string
required
Index ID
text
string
Text
imageUrl
string
Image URL
embedding
number[]
Custom Embeddings
ids
string[]
Subset of documents ids to match
filters
object

Query

idsOnly
boolean
default:"false"
Return only a list of ids without any metadata.
limit
number
default:"5"
The limit of possible reponses from your search. Max 100.

Response

data
Results Array