Skip to main content

KGM API (1.0.0)

Search

Trigger a full reindex of all sources

Responses

Response samples

Content type
application/json
{
  • "type": "ERROR_CODE",
  • "title": "Invalid operation.",
  • "status": 400,
  • "detail": "string",
  • "instance": "/v1/graph/sparql",
  • "details": {
    }
}

Search across all sources

query Parameters
term
required
string <= 256 characters
Example: term=knowledge graph

Search term (maximum 256 characters, longer queries will be truncated)

offset
integer
Default: 0

Number of results to skip for pagination

limit
integer <= 100
Default: 10

Maximum number of results to return (capped at 100, larger values will be automatically reduced)

Responses

Response samples

Content type
application/json
{}

Get all search predicates

Returns both locked predicates, managed by the kgm.search.predicates configuration, and unlocked predicates, registered via API.

Responses

Response samples

Content type
application/json

Replace the search predicates registered via API

Replaces the full set of unlocked predicates; locked predicates are unaffected. Any IRI in the request that matches a locked predicate is ignored and left as-is. A full reindex is scheduled asynchronously only if the set of unlocked predicates changes.

Request Body schema: application/json
required
predicates
required
Array of strings

The complete desired list of predicate IRIs registered via API. An empty array removes all of them. IRIs matching predicates managed by configuration are ignored.

Responses

Request samples

Content type
application/json

Response samples

Content type
application/json

Passthrough search to a specific source's native API

path Parameters
sourceId
required
string
Example: source-1

Source identifier

query Parameters
term
required
string <= 256 characters
Example: term=knowledge graph

Search term (maximum 256 characters, longer queries will be truncated)

offset
integer
Default: 0

Number of results to skip for pagination

limit
integer <= 100
Default: 10

Maximum number of results to return (capped at 100, larger values will be automatically reduced)

Responses

Response samples

Content type
application/json
{}

Graph

Passthrough SPARQL query to a specific source's native endpoint

path Parameters
sourceId
required
string
Example: source-1

Source identifier

Request Body schema: application/sparql-query
required
string

Responses

Response samples

Content type
application/sparql-results+json
{ }

Query the Knowledge Graph with SPARQL

Request Body schema: application/sparql-query
required
string

Responses

Response samples

Content type
application/sparql-results+json
{}

Sources

Trigger scheduled ingestion job for a specific source

path Parameters
sourceId
required
string
Example: source-1

Source identifier

Responses

Response samples

Content type
application/json
{
  • "type": "ERROR_CODE",
  • "title": "Invalid operation.",
  • "status": 400,
  • "detail": "string",
  • "instance": "/v1/graph/sparql",
  • "details": {
    }
}