Document retrieval, search, deletion, and per-document TTL management.
| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/documents/{documentType}/{glob} | List/glob documents |
| GET | /api/v1/documents/{documentType}/{dId} | Retrieve a document by D-Id |
| GET | /api/v1/documents/{documentType}/{dId}?path={fieldPath} | Retrieve a specific field |
| POST | /api/v1/documents/{documentType}/search | Search documents by field value |
| DELETE | /api/v1/documents/{documentType}/{dId} | Soft-delete a document |
| PUT | /api/v1/documents/{documentType}/{dId}/ttl | Set per-document TTL |
Use * for all documents, or glob patterns like GARAGE-* to match subsets. Supports * and ? wildcards.
{
"matches": [...document objects],
"count": 2
}
Retrieve a single document. For composed D-Ids, use : as delimiter in URL.
{
...document fields
}
Retrieve a single field from a document by dot-path.
| Field | Type | Required | Description |
|---|---|---|---|
| path | string | Yes | Dot-path to the field |
{
"_value": 19.1
}
Search documents by field value.
| Field | Type | Required | Description |
|---|---|---|---|
| field | string | Yes | Field name to search on |
| value | any | Yes | Value to match |
{
"matches": [...],
"count": 1
}
Soft-delete a document.
{
"deleted": true
}
Set per-document TTL.
| Field | Type | Required | Description |
|---|---|---|---|
| ttl | number | "infinite" | Yes | TTL in seconds, or "infinite" for no expiry |
{
"dId": "GARAGE-TEMP-01",
"ttl": 1800
}