KGM Source Adapter API

note

Read this page in wide view mode from here

• Search
  • getSearch across source data (Required for Passthrough Sources)
• Graph
  • postExecute SPARQL query against source data (Required for Passthrough Sources)
  • getGet raw JSON-LD data for graph ingestion (Required for Ingestion Sources)

API docs by Redocly

KGM Source Adapter API (1.0.0)

Specification for a KGM Source Adapter that interfaces with external data sources.

Search

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

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

}

Graph

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-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"

        }

      }

    ]

  }

}

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

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

Response samples

• 200
• 500

Content type

application/ld+json

"string"