Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Hash get in KV
Reads one field of a hash (HGET); an absent field has no `value`.
Reads one field of a hash (HGET); an absent field has no value.
- Path
POST https://api.data.sylphx.com/v1/kv-hash-gets - Scope
data:read - Effect
read— nothing is written. - Collection kv
- Host
https://api.data.sylphx.com
#Request
| Field | Type | What it is |
|---|---|---|
namespace_id | string | The namespace's id. Required. |
key | string | The hash's key. Required. |
field | string | The field's name. Required. |
#Response
| Field | Type | What it is |
|---|---|---|
value | bytes | The bytes, base64; unset when the field or the hash is absent. |
#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/kv-hash-gets" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"field":"…","key":"…","namespace_id":"…"}'