POST
/v1/searchbetaapiKeyworkspace
When to use
Find evidence snippets, records, and text blocks when support for an answer matters.
For agents
Use this for citations and raw support. Reranking is on by default. Add sourceIds only when the search must be limited to specific sources.
Example
import { PermuteClient } from '@permute/sdk';
const orgClient = new PermuteClient({
apiKey: process.env.PERMUTE_API_KEY!,
});
const client = orgClient.withWorkspace(process.env.PERMUTE_WORKSPACE_ID!);
const result = await client.search({
"query": "Find evidence about Q4 revenue growth",
"limit": 5
});Request body
{
"query": "Find evidence about Q4 revenue growth",
"limit": 5
}Response
{
"data": {
"items": [
{
"type": "record",
"sourceId": "conn_hubspot123",
"title": "deals",
"content": "Enterprise renewal deal with $48,000 amount",
"score": 0.91,
"citation": {
"connectorId": "conn_hubspot123",
"blockId": "blok_deals"
},
"metadata": {
"provider": "hubspot",
"tableName": "deals"
}
}
],
"meta": {
"strategy": "semantic",
"reranked": true,
"candidateCount": 12,
"totalMs": 86
}
}
}