Knowledge Graph Manager API
Read this page in wide view mode from here
KGM API (1.0.0)
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
- 200
- 400
- 500
{- "totalResults": 150,
- "offset": 0,
- "limit": 10,
- "hasNextPage": true
}Search across all sources, optionally filtering by predicate values
Text search with optional graph filters. Values within one filter clause are OR alternatives; all clauses must match. The only supported predicate is http://www.w3.org/1999/02/22-rdf-syntax-ns#type and the only supported operator is in. The term is normalized and truncated to 256 characters; limits above 100 are capped at 100. Without filters, the result matches GET for common valid inputs: a nonblank term of at most 256 characters, a nonnegative offset, and a limit from 1 to 100. POST rejects blank terms and invalid paging; longer terms are truncated and positive limits above 100 are capped.
Request Body schema: application/jsonrequired
| term required | string Search term; normalized and truncated to 256 characters. |
| offset | integer or null >= 0 Default: 0 Zero-based page number. Null is equivalent to omission. |
| limit | integer or null >= 1 Default: 10 Page size; values above 100 are capped at 100. Null is equivalent to omission. |
object or null Prefix to absolute-IRI namespace declarations used to expand filter predicates (at most 20 entries). Prefixes must be nonblank, contain no colon, and differ from | |
Array of objects or null (SearchFilterClause) Filter clauses, at most 20. Omission, null, or an empty array means no filtering. |
Responses
Request samples
- Payload
{- "term": "customer",
- "offset": 0,
- "limit": 10,
- "filters": [
]
}Response samples
- 200
- 400
- 500
{- "totalResults": 150,
- "offset": 0,
- "limit": 10,
- "hasNextPage": 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/jsonrequired
| 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
- Payload
{
}Response samples
- 200
- 400
- 500
[
]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
- 200
- 400
- 500
{- "totalResults": 150,
- "offset": 0,
- "limit": 10,
- "hasNextPage": true
}Trigger scheduled ingestion job for a specific source
path Parameters
| sourceId required | string Example: source-1 Source identifier |
Responses
Response samples
- 400
- 404
- 500
{- "type": "ERROR_CODE",
- "title": "Invalid operation.",
- "status": 400,
- "detail": "string",
- "instance": "/v1/graph/sparql",
- "details": {
- "line": 12,
- "column": 5
}
}