Database endpoints
Walk a graph at random
Follow a seeded random walk from a node, optionally using Node2Vec bias.
GET /v1/tenants/{tenant}/graph/{schema}/random-walk
- Choose a start and seedSet the number of steps and optional walk bias.
- Follow sampled linksWalk through the relation one step at a time.
- Read the visited sequenceReuse the seed on unchanged data for reproduction.
Before you start
Use your database bearer token.
Register the schema and relation, then add their rows. The examples use demo.people, its bidirectional follows relation, and linked rows u1, u2 and u3.
Path parameters
| Field | Type | Required |
|---|---|---|
tenant | string | Required |
schema | string | Required |
Query parameters
| Field | Type | Required |
|---|---|---|
rel | string | Required |
start | string | Required |
steps | integer | Required |
seed | integer | Required |
p | number | Optional |
q | number | Optional |
Headers
| Field | Type | Required | Description |
|---|---|---|---|
x-oc-db-user | string | Optional | Acting database user (role, grant and row-policy checks). Send with x-oc-db-key. |
x-oc-db-key | string | Optional | API key of the x-oc-db-user user. |
Read the result
walk is the sequence of visited node keys. Nodes may repeat; it is a sampled walk rather than a shortest or loop-free path. Use the same seed when reproducing a walk on unchanged data.
Response statuses
HTTP status reference
| Status | What to do |
|---|---|
| 200 | OK |
| 400 | Correct the request before retrying. |
| 401 | Check the credential and Authorization header. |
| 402 | Check feature access or available credits. |
| 403 | Check tenant access, roles and permissions. |
| 404 | Check the resource ID and API route. |
| 408 | Reduce query work or adjust the timeout. |
| 429 | Honor Retry-After when present; back off. |
| 499 | The client cancelled the request. |
| 500 | Check the outcome before retrying a write. |
| 503 | Honor Retry-After when present; check write outcomes. |