Knowledge Graph Manager API

info

Read this page in wide view mode from here

• Search
  • post/v1/search/full-reindex
  • get/v1/search/query
  • get/v1/search/predicates
  • put/v1/search/predicates
  • get/passthrough/{sourceId}/v1/search/query
• Graph
  • post/passthrough/{sourceId}/v1/graph/sparql
  • post/v1/graph/sparql
• Sources
  • post/v1/sources/{sourceId}/ingestion

API docs by Redocly

KGM API (1.0.0)

Search

Trigger a full reindex of all sources

Responses

https://docs.witboost.com/v1/search/full-reindex

Response samples

• 500

Content type

application/json

{

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

  • "line": 12,
  • "column": 5

  }

}

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

https://docs.witboost.com/v1/search/query

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "results": [

  • "https://example.org/resource/1",
  • "https://example.org/resource/2",
  • "https://example.org/resource/3"

  ],
• "totalResults": 150,
• "offset": 0,
• "limit": 10,
• "hasNextPage": true

}

Get all search predicates

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

Responses

https://docs.witboost.com/v1/search/predicates

Response samples

• 200
• 500

Content type

application/json

[

• {

  • "iri": "https://example.org/ontology#preferredLabel",
  • "locked": true

  }

]

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

https://docs.witboost.com/v1/search/predicates

Request samples

• Payload

Content type

application/json

{

• "predicates": [

  • "https://example.org/ontology#name"

  ]

}

Response samples

• 200
• 400
• 500

Content type

application/json

[

• {

  • "iri": "https://example.org/ontology#preferredLabel",
  • "locked": true

  }

]

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

https://docs.witboost.com/passthrough/{sourceId}/v1/search/query

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "results": [

  • "https://example.org/resource/1",
  • "https://example.org/resource/2",
  • "https://example.org/resource/3"

  ],
• "totalResults": 150,
• "offset": 0,
• "limit": 10,
• "hasNextPage": true

}

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

https://docs.witboost.com/passthrough/{sourceId}/v1/graph/sparql

Response samples

• 200
• 400
• 403
• 500

Content type

application/sparql-results+json

{ }

Query the Knowledge Graph with SPARQL

Request Body schema: application/sparql-query

required

string

Responses

https://docs.witboost.com/v1/graph/sparql

Response samples

• 200
• 400
• 500

Content type

application/sparql-results+json

{

• "head": {

  • "vars": [

    • "s",
    • "p",
    • "o"

    ]

  },
• "results": {

  • "bindings": [

    • {

      • "s": {

        • "type": "uri",
        • "value": "http://example.org/subject1"

        },
      • "p": {

        • "type": "uri",
        • "value": "http://example.org/predicate1"

        },
      • "o": {

        • "type": "literal",
        • "value": "Object 1"

        }

      }

    ]

  }

}

Sources

Trigger scheduled ingestion job for a specific source

path Parameters

sourceId required

string Example: source-1 Source identifier

Responses

https://docs.witboost.com/v1/sources/{sourceId}/ingestion

Response samples

• 400
• 404
• 500

Content type

application/json

{

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

  • "line": 12,
  • "column": 5

  }

}