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 Documents
Reads a document.
Reads a document.
- Path
GET https://api.data.sylphx.com/v1/documents/index-id/document-id - Scope
data:read - Effect
read— nothing is written. - Collection documents
- Host
https://api.data.sylphx.com
#Request
| Field | Type | What it is |
|---|---|---|
index_id | string | The search index's id. Required. |
document_id | string | The document's id. Required. |
#Response
| Field | Type | What it is |
|---|---|---|
document | DocumentRecord | The document. |
#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.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/documents/index-id/document-id" \
-H "Authorization: Bearer $SYLPHX_API_KEY"