Menu
Platform
AI
Alerts and status pages
App store purchases
Credits
Generated Assets
Knowledge
KV
Localization
Notifications
Organizations
Payments
Queues
Realtime
Sandboxes
Storage
Workflows
API reference
- Overview
- Access API keys
- Agent sessions API
- Agent versions API
- Agents API
- AI models API
- Artifact references API
- Artifacts API
- Assets API
- Auth configs API
- Bank receipts API
- Bank transfer accounts API
- Buckets API
- Builds API
- Catalogs API
- Chat profiles API
- Chat reports API
- Chat sticker packs API
- Checkout policies API
- Checkout sessions API
- Config changes API
- Config flags API
- Config segments API
- Connection providers API
- Connections API
- Connectors API
- Credit grants API
- Customer organizations API
- Customer subscriptions API
- Databases API
- Documents API
- Email domains API
- End users API
- Entities API
- Entitlement grants API
- Entries API
- Environments API
- Episodes API
- Error events API
- Error groups API
- Events API
- Exchange rates API
- Generations API
- Glossaries API
- Goals API
- Identities API
- Inbound emails API
- Inbound endpoints API
- Inbound messages API
- Inbound sms API
- Invitations API
- Job runs API
- Jobs API
- Knowledge schemas API
- KV API
- KV namespaces API
- Lease events API
- Leases API
- Licence keys API
- Licence tokens API
- Mail domains API
- Mail routes API
- Mailbox connect links API
- Mailbox OAUTH apps API
- Mailboxes API
- Memberships API
- Memories API
- Memory stores API
- Merchant accounts API
- Message topics API
- Messages API
- OAUTH clients API
- Objects API
- Organization roles API
- Orgs API
- Owner pools API
- Phone numbers API
- Portal sessions API
- Preferences API
- Price catalogs API
- Processor events API
- Projects API
- Queued executions API
- Queues API
- Realtime channels API
- Realtime members API
- Realtime messages API
- Recipients API
- Relations API
- Releases API
- Revenue API
- Revenue facts API
- Revenue sources API
- Runs API
- Sandbox shapes API
- Schedules API
- Scrubbing policies API
- Search API
- Search indexes API
- Secret versions API
- Secrets API
- Service enablements API
- Service observations API
- Services API
- Serving routes API
- Session events API
- Sessions API
- Signing key versions
- Signing keys
- Sms numbers API
- Source maps API
- Spaces API
- Store connections API
- Store purchases API
- Subscriptions API
- Suppressions API
- Tax threshold statuses API
- Templates API
- Test clocks API
- Token exchanges API
- Transfers API
- Trust policies API
- Trusted issuers API
- Uptime checks API
- Uptime manifests API
- Uptime sources API
- Usage events API
- Usage invoices API
- Usage meter prices API
- Usage meters API
- Usage reservations API
- Usage settings API
- Usage tiers API
- Volumes API
- Waits API
- Webhook deliveries API
- Webhook endpoints API
- Workflows API
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Multi in Search
Runs several searches of one index in one request, 1 to 10, and answers each in request order.
Runs several searches of one index in one request, 1 to 10, and answers each in request order.
- Path
POST https://api.data.sylphx.com/v1/multi-search/index-id - Scope
data:read - Effect
read— nothing is written. - Collection search
- Host
https://api.data.sylphx.com
#Request
| Field | Type | What it is |
|---|---|---|
index_id | string | The search index's id. Required. |
searches | SearchRequest[] | The searches, 1 to 10; each one's index_id is this index. Required. |
#SearchRequest
| Field | Type | What it is |
|---|---|---|
index_id | string | The search index's id. Required. |
query | string | Text to match, in web-search syntax: words (all must match), "quoted phrases", or, and -word to exclude. The last word also matches as a word prefix unless prefix is false. |
vector | double[] | An embedding to match by cosine similarity; its length is the index's vector dimensions. |
limit | uint32 | At most this many hits, 1 to 100; unset is 20. |
offset | uint32 | Hits to skip; offset + limit is at most 1000. |
filters | SearchFilter[] | Conditions every hit meets, at most 16. |
vector_weight | double | The vector list's share of a hybrid score, 0 to 1; unset is 0.5. |
prefix | bool | Whether the query's last word also matches as a word prefix; unset is true. |
#SearchFilter
| Field | Type | What it is |
|---|---|---|
field | string | A dot path of object keys, for example price.amount; at most 8 keys. Required. |
op | string | eq, ne, in, gt, gte, lt, lte, or exists. eq and in also match an array field that holds the value; ne matches documents without the field. Required. |
value_json | string | The value as JSON: a string, number, or boolean; for in, an array of 1 to 100 of them; for the ranges, a number or string; for exists, empty. |
#Response
| Field | Type | What it is |
|---|---|---|
results | SearchResponse[] | One result per search, in request order. |
#SearchResponse
| Field | Type | What it is |
|---|---|---|
hits | SearchHit[] | The hits, best first. |
#SearchHit
| Field | Type | What it is |
|---|---|---|
document | DocumentRecord | The document. |
score | double | How well it matched; higher is better. The text rank, the cosine similarity, or the fused rank; 0 when listing. |
text_score | double | The full-text rank, when the document matched the text. |
vector_score | double | The cosine similarity, when the document was in the vector list. |
#DocumentRecord
| Field | Type | What it is |
|---|---|---|
index_id | string | The search index's id in the environment, for example articles. |
document_id | string | The document's id. |
document_json | bytes | The document as JSON, base64. |
vector | double[] | The document's embedding; its length is the index's vector dimensions. |
sha256 | string | sha256:<hex> of the document. |
version | uint64 | The version, increasing per document. |
updated_at_unix_ms | int64 | When this version was written, in Unix milliseconds. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.INVALID_FIELD— A field failed validation.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.
Every error arrives in the body Errors describes.
#Examples
curl -X POST "https://api.data.sylphx.com/v1/multi-search/index-id" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"searches":[{"index_id":"…"}]}'