Traverse Entity

GET

/api/v1/knowledge-graph/entities/{entity_id}/traverse

curl --request GET \
  --url 'https://api.ultimateteam.ai/api/v1/knowledge-graph/entities/example/traverse?max_depth=3' \
  --header 'X-API-Key: <X-API-Key>'

• Production
• Local development

BFS traversal of the entity graph starting from the given entity.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

entity_id

required

Entity Id

string

Query Parameters

max_depth

Max Depth

integer

default: 3 >= 1 <= 5

Responses

200

Successful Response

Media typeapplication/json

Response Traverse Entity Api V1 Knowledge Graph Entities Entity Id Traverse Get

Array<object>

object

key

additional properties

any

Example^generated

[
  {}
]

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}