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
On this page
Get in Objects
Reads an object and its bytes (`body`, base64).
Reads an object and its bytes (body, base64).
- Path
GET https://api.data.sylphx.com/v1/objects/bucket-id/key - Scope
data:read - Effect
read— nothing is written. - Collection objects
- Query
version - Host
https://api.data.sylphx.com
#Request
| Field | Type | What it is |
|---|---|---|
bucket_id | string | The bucket's id. Required. |
key | string | The object key. Required. |
version | uint64 | Zero reads the current version; a positive value reads that version. |
#Response
| Field | Type | What it is |
|---|---|---|
object | ObjectRecord | The object's metadata. |
body | bytes | The bytes, base64. |
#ObjectRecord
| Field | Type | What it is |
|---|---|---|
bucket_id | string | The bucket's id in the environment, for example uploads. |
key | string | The object key; / separates path segments. |
sha256 | string | sha256:<hex> of the bytes. |
size | uint64 | Size in bytes. |
content_type | string | The media type given at put. |
etag | string | The entity tag of this version. |
version | uint64 | The version, increasing per key. |
updated_at_unix_ms | int64 | When this version was written, in Unix milliseconds. |
delete_marker | bool | Whether this version is a delete marker (exact-version reads only). |
visibility | string | public or private (the default); current version 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.
Every error arrives in the body Errors describes.
#Examples
curl "https://api.data.sylphx.com/v1/objects/bucket-id/key" \
-H "Authorization: Bearer $SYLPHX_API_KEY"