Skip to content
Console
Menu

Alerts and status pages

App store purchases

Credits

Knowledge

KV

Notifications

Organizations

Storage

Workflows

API reference

Getting Started

Authentication

KV Store

List relations

Lists a space's facts.

Lists a space's facts. The filter is limited to subject, predicate, object and provenance.channel; superseded facts are listed only with show_superseded.

  • Path GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/spaces/space/relations
  • Scope knowledge:read
  • Effect read — nothing is written.
  • Collection relations
  • Query page_size, page_token, filter, valid_time, show_superseded
  • Pagination the answer carries relations and, when there is more, next_page_token

#Request

FieldTypeWhat it is
parentstringThe parent to list in. Required.
page_sizeint32At most this many; default 50, clamped to 1000.
page_tokenstringnext_page_token of the previous page.
filterstringAIP-160 filter, limited to subject, predicate, object and provenance.channel.
valid_timetimestampList facts as they were valid at this time, including facts closed since; default now.
show_supersededboolAlso list facts that a newer record replaced.

#Response

FieldTypeWhat it is
relationsRelation[]The page.
next_page_tokenstringThe token of the next page; empty on the last page.

#Relation

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/spaces/{space}/relations/{relation}.
uidstringkrel_<26 base32>; never reused. Output only.
metaResourceMetaResource metadata.
subjectstringThe entity the fact is about. Required.
predicatestringThe relation type, snake_case, for example works_at or prefers; a core predicate or one of an accepted Knowledge Schema. Required.
objectstringThe other entity, for an edge. A fact has object, value, or both.
valuevalueThe value, for a fact about one entity.
statementstringThe fact as one sentence, used for search and shown with citations.
valid_start_timetimestampWhen the fact starts to hold in the world; default when it was recorded.
valid_end_timetimestampWhen the fact stopped holding in the world; unset while it holds.
episodesstring[]The episodes the fact comes from. A structured write with none records its own episode and cites it; an extracted fact cites the episodes it was read from.
provenanceProvenanceWhere it came from and who wrote it. Output only.
successorstringThe fact that replaced this one, once it is superseded. Output only.
create_timetimestampWhen the fact was recorded. Output only.
supersede_timetimestampWhen the fact was replaced by a newer record; unset while current. Output only.
sourcesClaimSource[]Read-time verification of each supporting source; never persisted as authority. Output only.

#ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only.
create_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

#Provenance

FieldTypeWhat it is
principalstringThe principal the write is attributed to, as a share subject (user:<id>, end_user:<id>): the member or end user an agent or app acts for. Set by the server from the caller's credential. Output only.
actorstringThe caller that made the write when it is not the principal: an agent (agent:<id>), an app key (api_key:<id>) or a connector. Output only.
channelChannelThe path the write took. Output only. One of api, tool, import, extraction.
methodSourceMethodHow the content was produced; default SOURCE_METHOD_STATED. Only the service writes SOURCE_METHOD_EXTRACTED. One of stated, extracted, imported.
referencesSourceRef[]References to where the content came from: a run and step, a work item, a message, a URL. At most 20.
modelstringFor an extracted record, the model id that extracted it. Output only.
confidencedoubleFor an extracted record, the extractor's confidence, 0 to 1. Output only.

#ClaimSource

FieldTypeWhat it is
sourceSourceRefThe source pointer, including the version observed at ingestion. Output only.
current_versionstringThe current version, empty when deleted or not verifiable. Output only.
freshnessClaimFreshnessCurrent only when the pinned and current source versions match. Output only. One of current, stale.
reread_requiredboolThe consumer must open the source again before using the claim as current. Output only.

#SourceRef

FieldTypeWhat it is
uristringA URI: a URL, or a URN of a platform record such as a Workflows run step. Required.
labelstringA short label to show with a citation.
pinned_versionstringImmutable version of the source observed when this claim was recorded.

#Errors

Every error arrives in the body Errors describes.

#Examples

curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/spaces/space/relations" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"