Database endpoints
Weighted shortest path
Returns the lowest total weight of a path between two nodes, using caller-supplied edge weights.
GET /v1/tenants/{tenant}/graph/{schema}/dijkstra
- Supply endpoints and weightsChoose the relation and caller-provided edge costs.
- Minimize the combined costEvaluate weighted routes between the selected nodes.
- Read the lowest costUse a path-returning endpoint if you need the route.
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 |
src | string | Required |
dst | string | Required |
weights_json | string | Required |
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
cost is the lowest total weight found between the selected nodes. This endpoint reports the cost, not an ordered node path. Use a path-returning endpoint when you need the route itself.
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. |