Menu
Platform
AI
App store purchases
Credits
Database
Flags
Generated Assets
Monitoring
Notifications
Organizations
Payments
- Payments
- Payments quickstart
- Checkout policies
- Checkout sessions
- Customer subscriptions
- Entitlement grants
- Exchange rates
- Licence keys
- Licence tokens
- Merchant accounts
- Portal sessions
- Price catalogs
- Revenue
- Revenue facts
- Revenue sources
- Tax threshold statuses
- Usage events
- Usage invoices
- Usage meter prices
- Usage meters
- Usage reservations
- Usage settings
- Usage tiers
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Search a memory
Recalls the memories that best match a query, by hybrid full-text and vector search.
Recalls the memories that best match a query, by hybrid full-text and vector search. With a publishable key, only the caller's end user's memories. A read with a request body, like a query.
Not available yet. Sylphx Agents is declared in the registry but no backend serves it: every call answers 501 with the problem code UNIMPLEMENTED.
- Path
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/memory_stores/memory-store/memories:search - Scope
agents:sessions - Effect
read— nothing is written. - Collection memories
#Request
| Field | Type | What it is |
|---|---|---|
parent | string | The memory store to search. Required. |
query | string | What to recall, 1 to 2000 characters. Required. |
end_user | string | Only memories about this end user. |
agent | string | Only memories of this agent. |
page_size | int32 | At most this many; default 10, clamped to 100. |
page_token | string | next_page_token of the previous page. |
#Response
| Field | Type | What it is |
|---|---|---|
matches | MemoryMatch[] | The matches, best first. |
next_page_token | string | The token of the next page; empty on the last page. |
#MemoryMatch
| Field | Type | What it is |
|---|---|---|
memory | Memory | The memory. |
score | double | The relevance, 0 to 1. |
#Memory
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/memory_stores/{memory_store}/memories/{memory}. |
uid | string | mem_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
content | string | The memory, at most 16 KiB of text. Required. |
end_user | string | The end user it is about, for a store scoped to end users. |
agent | string | The agent it belongs to, for a store scoped to agents. |
provenance | MemoryProvenance | Where it came from. Output only. |
create_time | timestamp | When it was written. Output only. |
update_time | timestamp | When it was last changed. Output only. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only. |
create_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
#MemoryProvenance
| Field | Type | What it is |
|---|---|---|
source | MemorySource | Who wrote it. Output only. One of agent, api, import. |
session | string | The session it was learned in, when an agent wrote it. Output only. |
event | string | The event it was learned from, when an agent wrote it. Output only. |
principal | string | The principal that wrote it, when a caller did. Output only. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.INVALID_FIELD— A field failed validation.
Every error arrives in the body Errors describes.
#Examples
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/memory_stores/memory-store/memories:search" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"query":"…"}'