API Reference

Changes API

Stream

/{podId}/changes

Request parameters

Responses

{}

Perform mutations on the KG.

/{podId}/changes

Post a change request, containing the requested mutations, to the inbox of the specified pod.

Request parameters

Responses

Get Change Report

/{podId}/changes/{changeId}

Request parameters

Responses

Get Change Records

/{podId}/changes/{changeId}/records

Request parameters

Responses

Perform mutations on a specific slice of the KG.

/{podId}/slices/{sliceId}/changes

Post a change request, containing the requested mutations, to a slice inbox of the specified pod.

Request parameters

Responses

Querying API

Retrieve data from the KG.

/{podId}/query

Query the knowledge graph of the specified pod using GraphQL.

Request parameters

{
  "query": {},
  "operationName": {},
  "variables": {},
  "targetGraphs": {},
  "atTimestamp": {},
  "atChangeRequest": {},
  "@context": {}
}

Responses

{
  "data": {},
  "errors": {},
  "extensions": {}
}

Retrieve data from a specific subset of the KG.

/{podId}/slices/{sliceId}/query

Query a predefined slice of the specified pod's Knowledge Graph using GraphQL.

Request parameters

{
  "query": {},
  "operationName": {},
  "variables": {},
  "targetGraphs": {},
  "atTimestamp": {},
  "atChangeRequest": {}
}

Responses

{
  "data": {},
  "errors": {},
  "extensions": {}
}

Streaming API

Stream

/{podId}/changes

Request parameters

Responses

{}

Stream Slice

/{podId}/slices/{sliceId}/stream

Request parameters

Responses

{}

Low-level Storage API

Download a stored object.

/{podId}/s3/{objectKey}

Get an object from the specified pod's S3 storage.

Request parameters

Responses

Upload an object.

/{podId}/s3/{objectKey}

Put an object to the specified pod's S3 storage.

Request parameters

Responses

Remove a stored object.

/{podId}/s3/{objectKey}

Delete an object from the specified pod's S3 storage.

Request parameters

Responses

Pod Config API

List

Responses

Register

Request parameters

Responses

null

Get

/{podId}

Request parameters

Responses

Update

/{podId}

Request parameters

Responses

null

Delete

/{podId}

Request parameters

Responses

null

Get Profile

/{podId}/.profile

Request parameters

Responses

List slices of the specified pod.

/{podId}/slices

List slices of the specified pod's Knowledge Graph.

Request parameters

Responses

Define a new slice of the KG.

/{podId}/slices

Define a new slice (subset) of the specified pod's Knowledge Graph, based on a GraphQL-LD schema.

Request parameters

Responses

null

Retrieve a specific slice definition..

/{podId}/slices/{sliceId}

Retrieve a specific slice definition details.

Request parameters

Responses

Delete a specific slice.

/{podId}/slices/{sliceId}

Delete a specific slice of the specified pod's Knowledge Graph.

Request parameters

Responses

null

Get SHACL

/{podId}/slices/{sliceId}/shacl

Request parameters

Responses

Last modified: 02 January 2025