KGM Source Adapter API (1.0.0)
Specification for a KGM Source Adapter that interfaces with external data sources.
Search across source data (Required for Passthrough Sources)
Enables real-time search queries against the source's native search capabilities.
This endpoint is called by KGM's passthrough functionality via /passthrough/{sourceId}/v1/search/query.
Required for: Passthrough and sources who have both modes enabled Optional for: Ingestion-only sources
query Parameters
| term required | string Example: term=customer Search term |
| offset | integer Default: 0 Number of results to skip for pagination |
| limit | integer Default: 10 Maximum number of results to return |
Responses
Response samples
- 200
- 400
- 500
{- "totalResults": 150,
- "offset": 0,
- "limit": 10,
- "hasNextPage": true
}Execute SPARQL query against source data (Required for Passthrough Sources)
Enables real-time SPARQL queries against the source's native graph capabilities.
This endpoint is called by KGM's passthrough functionality via /passthrough/{sourceId}/v1/graph/sparql.
Required for: Passthrough and sources who have both modes enabled Optional for: Ingestion-only sources
Request Body schema: application/sparql-queryrequired
Responses
Response samples
- 200
- 400
- 500
{- "head": {
- "vars": [
- "s",
- "p",
- "o"
]
}, - "results": {
- "bindings": [
- {
- "o": {
- "type": "literal",
- "value": "Object 1"
}
}
]
}
}Get raw JSON-LD data for graph ingestion (Required for Ingestion Sources)
Provides JSON-LD data for batch ingestion into the Knowledge Graph.
This endpoint is called during scheduled ingestion jobs when ingestEnabled=true.
Required for: Ingestion and Hybrid sources Optional for: Passthrough-only sources
query Parameters
| sourceId | string Default: "sample-source" Source identifier to filter data |
Responses
Response samples
- 200
- 500
"string"