Skip to content
IxDocs

Expand by entity name

POST
/v1/expand-by-name
curl --request POST \
  --url http://localhost:8090/v1/expand-by-name \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "direction": "both", "predicates": [ "example" ], "kinds": [ "example" ] }'

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
direction
string
default: both
predicates
Array<string>
kinds
Array<string>

Responses

Section titled “ Responses ”

200

Section titled “200”

Neighborhood

Media typeapplication/json
object
nodes
Array<object>
object
id
required
string
kind
required
string
name
required
string
attrs
required
object
key
additional properties
any
provenance
required
object
sourceUri

Workspace-relative path

string
sourceHash
string
extractor
string
sourceType
string
observedAt
string format: date-time
createdRev
required
integer
deletedRev
integer
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
edges
Array<object>
object
id
required
string
src
required
string
dst
required
string
predicate
required

Calls | imports | contains | …

string
attrs
required
object
key
additional properties
any
createdRev
required
integer
deletedRev
integer
Examplegenerated
{
  "nodes": [
    {
      "id": "example",
      "kind": "example",
      "name": "example",
      "attrs": {},
      "provenance": {
        "sourceUri": "example",
        "sourceHash": "example",
        "extractor": "example",
        "sourceType": "example",
        "observedAt": "2026-04-15T12:00:00Z"
      },
      "createdRev": 1,
      "deletedRev": 1,
      "createdAt": "2026-04-15T12:00:00Z",
      "updatedAt": "2026-04-15T12:00:00Z"
    }
  ],
  "edges": [
    {
      "id": "example",
      "src": "example",
      "dst": "example",
      "predicate": "example",
      "attrs": {},
      "createdRev": 1,
      "deletedRev": 1
    }
  ]
}