Documents
Search documents
Searches across the content of documents ingested into Metal, ranked by relevance.
post/v1/documents/search
Request
- Base URLhttps://api.metal.ai
- AuthAPI key in header x-metal-client-id and API key in header x-metal-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Example request
{
"query": "industrial automation suppliers"
}Response
Ranked document results.
Example response
{
"data": [
{
"id": "665f1c2a9b1e4a0012a3b4c5",
"name": "Q4 board deck.pdf"
}
],
"metadata": {
"page": 1,
"limit": 20,
"totalCount": 134,
"totalPages": 7
}
}Changes
No recorded changes to this operation across all 1 revision of this API.