knowledge_graph

kg_get_entity

Fetch a KG entity by id or name, with the entities directly connected to it. The response also carries datedFacts: what holds now about the entity by default, what held on a day with asOf, or the whole history with history:true, each fact with its dates, how it ended if it has, and the sources that state it.

post/tools/kg_get_entity

Request

  • Base URL: https://api.stablebaseline.io/functions/v1/cloud-serve/api/v1
  • URL: https://api.stablebaseline.io/functions/v1/cloud-serve/api/v1/tools/kg_get_entity
  • Auth: HTTP bearer

Request body

entityIdstring
namestring
projectIdstring

Scope the lookup to one project. Recommended when resolving by name, since the same entity name can exist in several projects.

asOfstring

Dated facts: return what held on this day (YYYY-MM-DD) instead of what holds now. For example the owner, status or supplier as it was on a past date.

historyboolean

Dated facts: return every fact with its dates, including facts that have ended (and how they ended) and planned ones, oldest first. Use for "how did X change" or "what was X before".

timeZonestring

Dated facts: the IANA time zone to give days in (for example Australia/Sydney, Asia/Kolkata, America/New_York). Defaults to the user's saved time zone, else UTC.

Response

Tool result (shape varies per tool — refer to the tool's docs for the exact return value).

object required

Changes

No recorded changes to this operation across all 1 revision of this API.