Interface: RegisterSourceRequest
@kortexya/reasoninglayer / Sources / RegisterSourceRequest
Interface: RegisterSourceRequest
Defined in: src/types/sources.ts:150
Request to register a data source.
Properties
config
config:
Record<string,unknown>
Defined in: src/types/sources.ts:158
Source-specific configuration (varies by source_type).
mode?
optionalmode:SourceWriteMode|null
Defined in: src/types/sources.ts:173
Declared write-path intent — see SourceWriteMode.
Omitted ⇒ ingest, for every source type (#71). Ingest is the only mode that
populates the knowledge base and the one path every adapter can serve; transpile
is an explicit opt-in. The resolved value is always echoed back on
RegisterSourceResponse.mode, so the applied default is never invisible.
transpile is accepted only for a source whose adapter executes transpiled SQL
(Postgres, MySQL, SQLite). Requesting it for any other source is refused with
422 — there would be nothing to run the SQL an OSFQL MATCH compiles to. The
set a type accepts is advertised by SourcesClient.listSourceTypes, so a
caller can avoid the refusal rather than discover it.
sourceId
sourceId:
string
Defined in: src/types/sources.ts:152
Unique source identifier (e.g., “crm_postgres”, “drug_csv”).
sourceName
sourceName:
string
Defined in: src/types/sources.ts:154
Human-readable source name.
sourceType
sourceType:
string
Defined in: src/types/sources.ts:156
Source type: “csv”, “parquet”, “mysql”, “sqlite”, “cassandra”, “neo4j”, “mcp”, “rest”, “graphql”, “postgres”.