Mirror/brk
1
0
Fork 0
mirror of https://github.com/bitcoinresearchkit/brk.git synced 2026-06-08 14:11:56 -07:00
Code Issues Packages Projects Releases Wiki Activity

server: readme: add index-t-value documentation

Browse Source
This commit is contained in:
nym21
2025-06-08 20:35:26 +02:00
parent be492d5084
commit 130d5057d4
1 changed files with 21 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
crates/brk_server/README.md
+21
View File
@@ -73,6 +73,27 @@ A list of all possible vec ids and their supported vec indexes
A list of all possible vec indexes and their supported vec ids
#### `GET /api/{INDEX}-to-{VALUE}`
This endpoint retrieves data based on the specified vector index and id.
**Parameters:**
| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `from` | `signed int` | No | Inclusive starting index for pagination (default is 0). |
| `to` | `signed int` | No | Exclusive ending index for pagination (default is the total number of results). Overrides `count` |
| `count` | `unsigned int` | No | The number of values requested |
| `format` | `string` | No | The format of the response. Options include `json`, `csv`, `tsv`, or `md` (default is `json`). |
**Examples:**
```
GET /api/date-to-close
GET /date-to-close?from=-100
GET /date-to-close?count=100&format=csv
```
#### `GET /api/query`
This endpoint retrieves data based on the specified vector index and values.