Find k shortest paths

GET /v1/tenants/{tenant}/graph/{schema}/k-shortest

Compare the best few loop-free routesThe result contains up to k routes, not every possible route.

Set source and targetChoose the relation, path count and optional weight column.
Find low-cost alternativesRank loop-free paths by cost.
Read nodes and costsCompare the ordered routes returned.

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
`source`	`string`	Required
`target`	`string`	Required
`k`	`integer`	Required
`weight_col`	`string`	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

paths contains up to k loop-free routes, each with ordered nodes and a cost. A cost ranks the returned paths; it is not a count of all routes through the graph.

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.

Request example

curl --include --request GET "${OC_BASE_URL}/v1/tenants/${OC_TENANT}/graph/demo.people/k-shortest?rel=follows&source=u1&target=u3&k=3" \
  --header "Authorization: Bearer ${OC_TOKEN}"

Response example

Examples use synthetic values to show the response format.

Response status

{
  "paths": [
    {
      "cost": 2,
      "nodes": [
        "u1",
        "u2",
        "u3"
      ]
    }
  ]
}

Without weight_col, each edge costs 1.

Download the OpenAPI specification for the complete response schemas.

Before you startCopy Anchor Link

Path parametersCopy Anchor Link

Query parametersCopy Anchor Link

HeadersCopy Anchor Link