Ingestion API reference¶
GENERATED by
scripts/gen_api_docs.pyfromcontract/methods.jsonandcontract/schemas/method.request.json/contract/schemas/result.ingestion.json-- do not hand-edit. Regenerate withpython3 scripts/gen_api_docs.py --write. 15 methods in this namespace. See also the machine-checked policy ledger atcapabilities.generated.mdand the OpenAPI document / Swagger UI.
AddEmbedding¶
| Property | Value |
|---|---|
| Stability | stable |
| Authz action | node:write |
| Mutates | true |
| Durability domain | GraphRedb |
| Idempotent | false |
| Audited | true |
| Emits CDC | false |
| Txn participation | Atomic |
| Replay class | OperationIdentity |
| Consumer profiles | python |
| Error set | ACCESS_DENIED, AUTHENTICATION_REQUIRED, AUTH_AUDIENCE_MISMATCH, AUTH_POLICY_VERSION_MISMATCH, AUTH_TENANT_MISMATCH, BUSY, CANCELLED, CAPACITY_DENIED, CONFLICT, CORRUPT_MUTATION_LEDGER, ENGINE_DEADLINE_EXCEEDED, ENGINE_INTERNAL_METHOD, ENGINE_RESOURCE_EXHAUSTED, ENGINE_UNAVAILABLE, IDEMPOTENCY_CONFLICT, INTERNAL, INVALID_ARGUMENT, METHOD_NOT_YET_SERVED, NODE_MISMATCH, OPERATION_REDIRECTED, READ_ONLY, REDIRECTED, STALE_OUTBOX_LEASE, STALE_ROUTE, TIMEOUT |
| Format identities | STORAGE_KERNEL_SCHEMA_VERSION, GRAPH_SNAPSHOT_SCHEMA_VERSION, GRAPH_META_SCHEMA_VERSION |
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
embedding |
array of number (float) | yes | |
node_id |
string | yes |
Result
| Body | Type | Encoding | Dynamic |
|---|---|---|---|
result |
string | String |
Full machine-checked schema: contract/schemas/method.request.json#/methods/AddEmbedding, contract/schemas/result.ingestion.json#/methods/AddEmbedding.
Asr¶
self-routes before dispatch_graph_op like Quantum/Viz. Direct non-durable whisper-rs transcription, commits no asr.result.v1 (that governed commit is future worker/AU-orchestration work, W03/W06)
| Property | Value |
|---|---|
| Stability | stable |
| Authz action | asr:transcribe |
| Mutates | false |
| Durability domain | None |
| Idempotent | false |
| Audited | false |
| Emits CDC | false |
| Txn participation | None |
| Replay class | NotReplayable |
| Consumer profiles | python |
| Error set | ACCESS_DENIED, AUTHENTICATION_REQUIRED, AUTH_AUDIENCE_MISMATCH, AUTH_POLICY_VERSION_MISMATCH, AUTH_TENANT_MISMATCH, BUSY, CANCELLED, CAPACITY_DENIED, ENGINE_DEADLINE_EXCEEDED, ENGINE_INTERNAL_METHOD, ENGINE_RESOURCE_EXHAUSTED, ENGINE_UNAVAILABLE, INTERNAL, INVALID_ARGUMENT, METHOD_NOT_YET_SERVED, NODE_MISMATCH, OPERATION_REDIRECTED, STALE_OUTBOX_LEASE, STALE_ROUTE, TIMEOUT |
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
op |
AsrOp |
yes |
Result
| Body | Type | Encoding | Dynamic |
|---|---|---|---|
TranscribeFile |
AsrTranscription |
Json |
Multi-body result: the
oprequest field selects which body above is returned.
Full machine-checked schema: contract/schemas/method.request.json#/methods/Asr, contract/schemas/result.ingestion.json#/methods/Asr.
Discover¶
| Property | Value |
|---|---|
| Stability | stable |
| Authz action | compute:semantic |
| Mutates | false |
| Durability domain | None |
| Idempotent | true |
| Audited | false |
| Emits CDC | false |
| Txn participation | Snapshot |
| Replay class | NotReplayable |
| Consumer profiles | python |
| Error set | ACCESS_DENIED, AUTHENTICATION_REQUIRED, AUTH_AUDIENCE_MISMATCH, AUTH_POLICY_VERSION_MISMATCH, AUTH_TENANT_MISMATCH, BUSY, CANCELLED, CAPACITY_DENIED, ENGINE_DEADLINE_EXCEEDED, ENGINE_INTERNAL_METHOD, ENGINE_RESOURCE_EXHAUSTED, ENGINE_UNAVAILABLE, INTERNAL, INVALID_ARGUMENT, METHOD_NOT_YET_SERVED, NODE_MISMATCH, OPERATION_REDIRECTED, STALE_OUTBOX_LEASE, STALE_ROUTE, TIMEOUT |
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
k |
integer (uint) | yes | |
keywords |
array of string | yes | |
query_embedding |
array of number (float) | yes |
Result
| Body | Type | Encoding | Dynamic |
|---|---|---|---|
result |
array of DiscoverHit |
Json |
Full machine-checked schema: contract/schemas/method.request.json#/methods/Discover, contract/schemas/result.ingestion.json#/methods/Discover.
IndexRepository¶
EH-280 runtime-conditional: without scope a stateless parse+resolve of the submitted files. With scope each unique blob is parsed once and the :Blob/:FileVersion/:Branch projection (tombstones remove membership) commits as one content-addressed ChangeEnvelope through ApplyChangeEnvelope, replaying an unchanged batch
| Property | Value |
|---|---|
| Stability | stable |
| Authz action | source:ingest |
| Mutates | true |
| Durability domain | GraphRedb |
| Idempotent | true |
| Audited | true |
| Emits CDC | true |
| Txn participation | Saga |
| Replay class | OperationIdentity |
| Consumer profiles | python |
| Error set | ACCESS_DENIED, AUTHENTICATION_REQUIRED, AUTH_AUDIENCE_MISMATCH, AUTH_POLICY_VERSION_MISMATCH, AUTH_TENANT_MISMATCH, BUSY, CANCELLED, CAPACITY_DENIED, CONFLICT, CORRUPT_MUTATION_LEDGER, ENGINE_DEADLINE_EXCEEDED, ENGINE_INTERNAL_METHOD, ENGINE_RESOURCE_EXHAUSTED, ENGINE_UNAVAILABLE, IDEMPOTENCY_CONFLICT, INTERNAL, INVALID_ARGUMENT, METHOD_NOT_YET_SERVED, NODE_MISMATCH, OPERATION_REDIRECTED, READ_ONLY, REDIRECTED, STALE_OUTBOX_LEASE, STALE_ROUTE, TIMEOUT |
| Format identities | STORAGE_KERNEL_SCHEMA_VERSION, GRAPH_SNAPSHOT_SCHEMA_VERSION, GRAPH_META_SCHEMA_VERSION |
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
files_msgpack |
array of integer (uint8) | yes | |
scope |
one of: IndexRepositoryScope | null |
no |
Result
| Body | Type | Encoding | Dynamic |
|---|---|---|---|
result |
IndexResult |
Json |
Full machine-checked schema: contract/schemas/method.request.json#/methods/IndexRepository, contract/schemas/result.ingestion.json#/methods/IndexRepository.
ObserveScreen¶
| Property | Value |
|---|---|
| Stability | stable |
| Authz action | compute:vision |
| Mutates | false |
| Durability domain | None |
| Idempotent | false |
| Audited | false |
| Emits CDC | false |
| Txn participation | None |
| Replay class | NotReplayable |
| Consumer profiles | python |
| Error set | ACCESS_DENIED, AUTHENTICATION_REQUIRED, AUTH_AUDIENCE_MISMATCH, AUTH_POLICY_VERSION_MISMATCH, AUTH_TENANT_MISMATCH, BUSY, CANCELLED, CAPACITY_DENIED, ENGINE_DEADLINE_EXCEEDED, ENGINE_INTERNAL_METHOD, ENGINE_RESOURCE_EXHAUSTED, ENGINE_UNAVAILABLE, INTERNAL, INVALID_ARGUMENT, METHOD_NOT_YET_SERVED, NODE_MISMATCH, OPERATION_REDIRECTED, STALE_OUTBOX_LEASE, STALE_ROUTE, TIMEOUT |
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
obs_msgpack |
array of integer (uint8) | yes |
Result
| Body | Type | Encoding | Dynamic |
|---|---|---|---|
result |
ScreenObservationResult |
Json |
Full machine-checked schema: contract/schemas/method.request.json#/methods/ObserveScreen, contract/schemas/result.ingestion.json#/methods/ObserveScreen.
ParseFile¶
| Property | Value |
|---|---|
| Stability | stable |
| Authz action | compute:parse |
| Mutates | false |
| Durability domain | None |
| Idempotent | true |
| Audited | false |
| Emits CDC | false |
| Txn participation | None |
| Replay class | NotReplayable |
| Consumer profiles | python |
| Error set | ACCESS_DENIED, AUTHENTICATION_REQUIRED, AUTH_AUDIENCE_MISMATCH, AUTH_POLICY_VERSION_MISMATCH, AUTH_TENANT_MISMATCH, BUSY, CANCELLED, CAPACITY_DENIED, ENGINE_DEADLINE_EXCEEDED, ENGINE_INTERNAL_METHOD, ENGINE_RESOURCE_EXHAUSTED, ENGINE_UNAVAILABLE, INTERNAL, INVALID_ARGUMENT, METHOD_NOT_YET_SERVED, NODE_MISMATCH, OPERATION_REDIRECTED, STALE_OUTBOX_LEASE, STALE_ROUTE, TIMEOUT |
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
file_path |
string | yes | |
source |
array of integer (uint8) | yes |
Result
| Body | Type | Encoding | Dynamic |
|---|---|---|---|
result |
ParseResult |
Json |
Full machine-checked schema: contract/schemas/method.request.json#/methods/ParseFile, contract/schemas/result.ingestion.json#/methods/ParseFile.
ParseFiles¶
| Property | Value |
|---|---|
| Stability | stable |
| Authz action | compute:parse |
| Mutates | false |
| Durability domain | None |
| Idempotent | true |
| Audited | false |
| Emits CDC | false |
| Txn participation | None |
| Replay class | NotReplayable |
| Consumer profiles | python |
| Error set | ACCESS_DENIED, AUTHENTICATION_REQUIRED, AUTH_AUDIENCE_MISMATCH, AUTH_POLICY_VERSION_MISMATCH, AUTH_TENANT_MISMATCH, BUSY, CANCELLED, CAPACITY_DENIED, ENGINE_DEADLINE_EXCEEDED, ENGINE_INTERNAL_METHOD, ENGINE_RESOURCE_EXHAUSTED, ENGINE_UNAVAILABLE, INTERNAL, INVALID_ARGUMENT, METHOD_NOT_YET_SERVED, NODE_MISMATCH, OPERATION_REDIRECTED, STALE_OUTBOX_LEASE, STALE_ROUTE, TIMEOUT |
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
files_msgpack |
array of integer (uint8) | yes |
Result
| Body | Type | Encoding | Dynamic |
|---|---|---|---|
result |
array of ParseResult |
Json |
Full machine-checked schema: contract/schemas/method.request.json#/methods/ParseFiles, contract/schemas/result.ingestion.json#/methods/ParseFiles.
Quantum¶
self-routes before dispatch_graph_op like AnalyticsJob/Statechart, never reaches the graph tamper-evident audit chain. R5 override audit instead rides the response's PlannerDecision.audit trail into the agent-utilities :ToolCall/:QuantumJob provenance
| Property | Value |
|---|---|
| Stability | stable |
| Authz action | quantum:run |
| Mutates | false |
| Durability domain | None |
| Idempotent | true |
| Audited | false |
| Emits CDC | false |
| Txn participation | None |
| Replay class | NotReplayable |
| Consumer profiles | python |
| Error set | ACCESS_DENIED, AUTHENTICATION_REQUIRED, AUTH_AUDIENCE_MISMATCH, AUTH_POLICY_VERSION_MISMATCH, AUTH_TENANT_MISMATCH, BUSY, CANCELLED, CAPACITY_DENIED, ENGINE_DEADLINE_EXCEEDED, ENGINE_INTERNAL_METHOD, ENGINE_RESOURCE_EXHAUSTED, ENGINE_UNAVAILABLE, INTERNAL, INVALID_ARGUMENT, METHOD_NOT_YET_SERVED, NODE_MISMATCH, OPERATION_REDIRECTED, STALE_OUTBOX_LEASE, STALE_ROUTE, TIMEOUT |
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
op |
QuantumOp |
yes |
Result
| Body | Type | Encoding | Dynamic |
|---|---|---|---|
expectation |
QuantumExpectationResult |
Json | |
optimize_qaoa |
QuantumQaoaResult |
Json | |
rank |
QuantumRankResult |
Json |
Multi-body result: the
oprequest field selects which body above is returned.
Full machine-checked schema: contract/schemas/method.request.json#/methods/Quantum, contract/schemas/result.ingestion.json#/methods/Quantum.
SemanticIndex¶
RF-019's S1-S6 tiered ingestion queue. Runtime-conditional like the four agent layers, but over SIX authz actions rather than two: binding lifecycle is semantic:binding-write, S1 admission semantic:source-admit, subscribe/claim/release semantic:stage-claim, stage completion semantic:stage-complete, and the reads semantic:binding-read / semantic:stage-read. The row names the binding-write leg. SemanticIndexOp::authz_action is the authority for each operation
| Property | Value |
|---|---|
| Stability | stable |
| Authz action | semantic:binding-write |
| Mutates | true |
| Durability domain | SemanticIndexRedb |
| Idempotent | true |
| Audited | false |
| Emits CDC | false |
| Txn participation | Atomic |
| Replay class | OperationIdentity |
| Consumer profiles | python |
| Error set | ACCESS_DENIED, AUTHENTICATION_REQUIRED, AUTH_AUDIENCE_MISMATCH, AUTH_POLICY_VERSION_MISMATCH, AUTH_TENANT_MISMATCH, BUSY, CANCELLED, CAPACITY_DENIED, CONFLICT, CORRUPT_MUTATION_LEDGER, ENGINE_DEADLINE_EXCEEDED, ENGINE_INTERNAL_METHOD, ENGINE_RESOURCE_EXHAUSTED, ENGINE_UNAVAILABLE, IDEMPOTENCY_CONFLICT, INTERNAL, INVALID_ARGUMENT, METHOD_NOT_YET_SERVED, NODE_MISMATCH, OPERATION_REDIRECTED, READ_ONLY, REDIRECTED, STALE_OUTBOX_LEASE, STALE_ROUTE, TIMEOUT |
| Format identities | STORAGE_KERNEL_SCHEMA_VERSION |
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
op |
SemanticIndexOp |
yes |
Result
| Body | Type | Encoding | Dynamic |
|---|---|---|---|
admit_binding |
SemanticMutationReceipt |
Raw | |
admit_source_page |
SemanticSqlSourcePageAdmission |
Raw | |
admit_source_reconcile |
SemanticSqlSourceReconciliationAdmission |
Raw | |
admit_source_record |
SemanticMutationReceipt |
Raw | |
admit_source_replacement |
SemanticMutationReceipt |
Raw | |
binding |
one of: SemanticBinding | null |
Raw | |
claim_stage_leases |
SemanticStageLeasePage |
Raw | |
complete_generation_stage |
SemanticMutationReceipt |
Raw | |
complete_sql_source_stage |
SemanticMutationReceipt |
Raw | |
complete_stage |
SemanticMutationReceipt |
Raw | |
drop_binding |
SemanticMutationReceipt |
Raw | |
get_binding_request |
SemanticIndexResponse |
Raw | |
list_bindings |
SemanticBindingPage |
Raw | |
live_generation |
integer | null | Raw | |
refresh_binding |
SemanticMutationReceipt |
Raw | |
release_stage_lease |
boolean | Raw | |
replay_completed_sql_source_stage |
array | null | Raw | |
sql_source_manifest |
one of: SemanticSqlSourceManifest | null |
Raw | |
stage_status |
SemanticOutboxStatus |
Raw | |
subscribe_stage_consumer |
boolean | Raw | |
transition_binding |
SemanticMutationReceipt |
Raw | |
validate_stage_lease |
SemanticStageIntent |
Raw |
Multi-body result: the
oprequest field selects which body above is returned.
Full machine-checked schema: contract/schemas/method.request.json#/methods/SemanticIndex, contract/schemas/result.ingestion.json#/methods/SemanticIndex.
SemanticSearch¶
| Property | Value |
|---|---|
| Stability | stable |
| Authz action | compute:semantic |
| Mutates | false |
| Durability domain | None |
| Idempotent | true |
| Audited | false |
| Emits CDC | false |
| Txn participation | Snapshot |
| Replay class | NotReplayable |
| Consumer profiles | python |
| Error set | ACCESS_DENIED, AUTHENTICATION_REQUIRED, AUTH_AUDIENCE_MISMATCH, AUTH_POLICY_VERSION_MISMATCH, AUTH_TENANT_MISMATCH, BUSY, CANCELLED, CAPACITY_DENIED, ENGINE_DEADLINE_EXCEEDED, ENGINE_INTERNAL_METHOD, ENGINE_RESOURCE_EXHAUSTED, ENGINE_UNAVAILABLE, INTERNAL, INVALID_ARGUMENT, METHOD_NOT_YET_SERVED, NODE_MISMATCH, OPERATION_REDIRECTED, STALE_OUTBOX_LEASE, STALE_ROUTE, TIMEOUT |
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
n_results |
integer (uint) | yes | |
query_embedding |
array of number (float) | yes |
Result
| Body | Type | Encoding | Dynamic |
|---|---|---|---|
result |
array of array of any | Raw |
Full machine-checked schema: contract/schemas/method.request.json#/methods/SemanticSearch, contract/schemas/result.ingestion.json#/methods/SemanticSearch.
ServedModality¶
runtime-conditional: authority/query/events/capabilities are checked read snapshots; ingest/remove/cold/restore commit an encrypted state-backed MutationBatch
| Property | Value |
|---|---|
| Stability | stable |
| Authz action | modality:write |
| Mutates | true |
| Durability domain | GraphRedb |
| Idempotent | false |
| Audited | true |
| Emits CDC | true |
| Txn participation | Atomic |
| Replay class | OperationIdentity |
| Consumer profiles | python |
| Error set | ACCESS_DENIED, AUTHENTICATION_REQUIRED, AUTH_AUDIENCE_MISMATCH, AUTH_POLICY_VERSION_MISMATCH, AUTH_TENANT_MISMATCH, BUSY, CANCELLED, CAPACITY_DENIED, CONFLICT, CORRUPT_MUTATION_LEDGER, ENGINE_DEADLINE_EXCEEDED, ENGINE_INTERNAL_METHOD, ENGINE_RESOURCE_EXHAUSTED, ENGINE_UNAVAILABLE, IDEMPOTENCY_CONFLICT, INTERNAL, INVALID_ARGUMENT, METHOD_NOT_YET_SERVED, NODE_MISMATCH, OPERATION_REDIRECTED, READ_ONLY, REDIRECTED, STALE_OUTBOX_LEASE, STALE_ROUTE, TIMEOUT |
| Format identities | STORAGE_KERNEL_SCHEMA_VERSION, GRAPH_SNAPSHOT_SCHEMA_VERSION, GRAPH_META_SCHEMA_VERSION |
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
op |
ServedModalityOp |
yes |
Result
| Body | Type | Encoding | Dynamic |
|---|---|---|---|
authority |
ServedModalityAuthority |
Raw | |
capabilities |
ServedModalityCapabilities |
Json | |
collect_tombstones |
ServedModalityTombstoneCollection |
Json | |
delete |
ServedModalityApplyOutcome |
Raw | |
events |
array of ServedModalityEvent |
Raw | |
ingest |
ServedModalityApplyOutcome |
Raw | |
ingest_stream |
array of ServedModalityApplyOutcome |
Raw | |
move_to_cold |
ServedModalityApplyOutcome |
Raw | |
native_query |
any | Raw | {'reason': 'requested-modality', 'summary': 'the server-declared served-modality body selected by the request'} |
query |
any | Raw | {'reason': 'requested-modality', 'summary': 'the server-declared served-modality body selected by the request'} |
restore |
ServedModalityApplyOutcome |
Raw | |
stats |
ServedModalityStats |
Raw |
Multi-body result: the
oprequest field selects which body above is returned.
Full machine-checked schema: contract/schemas/method.request.json#/methods/ServedModality, contract/schemas/result.ingestion.json#/methods/ServedModality.
SourceIngest¶
RF-ADR-009 native ingestion authority: tenant-bound typed Connector Manifest mapping resolution and idempotent raw-CAS admission precede one atomic ChangeEnvelope commit for mapped graph material, provenance, cursor and receipt. Unknown mapping, tenant or authority fails closed. Exact MCP catalog generation and digest binding makes the generated consumer contract replay-safe
| Property | Value |
|---|---|
| Stability | stable |
| Authz action | source:ingest |
| Mutates | true |
| Durability domain | GraphRedb |
| Idempotent | true |
| Audited | true |
| Emits CDC | true |
| Txn participation | Saga |
| Replay class | OperationIdentity |
| Consumer profiles | python |
| Error set | ACCESS_DENIED, AUTHENTICATION_REQUIRED, AUTH_AUDIENCE_MISMATCH, AUTH_POLICY_VERSION_MISMATCH, AUTH_TENANT_MISMATCH, BUSY, CANCELLED, CAPACITY_DENIED, CONFLICT, CONNECTOR_SCHEMA_MAPPING_AMBIGUOUS, CONNECTOR_SCHEMA_MAPPING_INVALID, CONNECTOR_SCHEMA_MAPPING_UNAVAILABLE, CORRUPT_MUTATION_LEDGER, ENGINE_DEADLINE_EXCEEDED, ENGINE_INTERNAL_METHOD, ENGINE_RESOURCE_EXHAUSTED, ENGINE_UNAVAILABLE, IDEMPOTENCY_CONFLICT, INTERNAL, INVALID_ARGUMENT, METHOD_NOT_YET_SERVED, NODE_MISMATCH, OPERATION_REDIRECTED, READ_ONLY, REDIRECTED, SOURCE_AUTHORITATIVE_LIVE_ID_INVALID, SOURCE_AUTHORITATIVE_LIVE_ID_UNKNOWN, SOURCE_AUTHORITATIVE_LIVE_ID_WITHDRAWN, SOURCE_INGESTION_REPLAY_CONFLICT, SOURCE_INGESTION_REPLAY_INVALID, SOURCE_INGESTION_STATUS_INVALID, SOURCE_INGESTION_UNAVAILABLE, SOURCE_MAPPING_AUTHORITY_UNAVAILABLE, SOURCE_MAPPING_SELECTOR_INVALID, SOURCE_MAPPING_SELECTOR_MISMATCH, SOURCE_RECONCILIATION_MARKER_INVALID, SOURCE_RELATIONSHIP_ENDPOINT_CONFLICT, SOURCE_RELATIONSHIP_ENDPOINT_INVALID, SOURCE_RELATIONSHIP_ENDPOINT_TYPE_MISMATCH, SOURCE_RELATIONSHIP_ENDPOINT_UNKNOWN, SOURCE_RELATIONSHIP_ENDPOINT_WITHDRAWN, SOURCE_RELATIONSHIP_IDENTITY_CONFLICT, SOURCE_RELATIONSHIP_MARKER_INVALID, SOURCE_RELATIONSHIP_SCHEMA_INVALID, SOURCE_SCHEMA_FIELD_UNKNOWN, SOURCE_SCHEMA_TYPE_MISMATCH, SOURCE_WITHDRAWAL_UNKNOWN, STALE_MAPPING_REFERENCE, STALE_OUTBOX_LEASE, STALE_ROUTE, TIMEOUT, UNKNOWN_MAPPING_REFERENCE, UNKNOWN_RELATIONSHIP_REFERENCE |
| Format identities | STORAGE_KERNEL_SCHEMA_VERSION, GRAPH_SNAPSHOT_SCHEMA_VERSION, GRAPH_META_SCHEMA_VERSION |
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request |
SourceIngestionRequest |
yes |
Result
| Body | Type | Encoding | Dynamic |
|---|---|---|---|
result |
SourceIngestionReceipt |
Raw |
Full machine-checked schema: contract/schemas/method.request.json#/methods/SourceIngest, contract/schemas/result.ingestion.json#/methods/SourceIngest.
SourceIngestStatus¶
read-only authoritative source-partition checkpoint and receipt identity for restart/failover CAS recovery; callers must not substitute local checkpoint authority
| Property | Value |
|---|---|
| Stability | stable |
| Authz action | source:ingest |
| Mutates | false |
| Durability domain | None |
| Idempotent | true |
| Audited | false |
| Emits CDC | false |
| Txn participation | Snapshot |
| Replay class | NotReplayable |
| Consumer profiles | python |
| Error set | ACCESS_DENIED, AUTHENTICATION_REQUIRED, AUTH_AUDIENCE_MISMATCH, AUTH_POLICY_VERSION_MISMATCH, AUTH_TENANT_MISMATCH, BUSY, CANCELLED, CAPACITY_DENIED, CONNECTOR_SCHEMA_MAPPING_AMBIGUOUS, CONNECTOR_SCHEMA_MAPPING_INVALID, CONNECTOR_SCHEMA_MAPPING_UNAVAILABLE, ENGINE_DEADLINE_EXCEEDED, ENGINE_INTERNAL_METHOD, ENGINE_RESOURCE_EXHAUSTED, ENGINE_UNAVAILABLE, INTERNAL, INVALID_ARGUMENT, METHOD_NOT_YET_SERVED, NODE_MISMATCH, OPERATION_REDIRECTED, SOURCE_AUTHORITATIVE_LIVE_ID_INVALID, SOURCE_AUTHORITATIVE_LIVE_ID_UNKNOWN, SOURCE_AUTHORITATIVE_LIVE_ID_WITHDRAWN, SOURCE_INGESTION_REPLAY_CONFLICT, SOURCE_INGESTION_REPLAY_INVALID, SOURCE_INGESTION_STATUS_INVALID, SOURCE_INGESTION_UNAVAILABLE, SOURCE_MAPPING_AUTHORITY_UNAVAILABLE, SOURCE_MAPPING_SELECTOR_INVALID, SOURCE_MAPPING_SELECTOR_MISMATCH, SOURCE_RECONCILIATION_MARKER_INVALID, SOURCE_RELATIONSHIP_ENDPOINT_CONFLICT, SOURCE_RELATIONSHIP_ENDPOINT_INVALID, SOURCE_RELATIONSHIP_ENDPOINT_TYPE_MISMATCH, SOURCE_RELATIONSHIP_ENDPOINT_UNKNOWN, SOURCE_RELATIONSHIP_ENDPOINT_WITHDRAWN, SOURCE_RELATIONSHIP_IDENTITY_CONFLICT, SOURCE_RELATIONSHIP_MARKER_INVALID, SOURCE_RELATIONSHIP_SCHEMA_INVALID, SOURCE_SCHEMA_FIELD_UNKNOWN, SOURCE_SCHEMA_TYPE_MISMATCH, SOURCE_WITHDRAWAL_UNKNOWN, STALE_MAPPING_REFERENCE, STALE_OUTBOX_LEASE, STALE_ROUTE, TIMEOUT, UNKNOWN_MAPPING_REFERENCE, UNKNOWN_RELATIONSHIP_REFERENCE |
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
connector |
string | yes | |
stream |
string | yes |
Result
| Body | Type | Encoding | Dynamic |
|---|---|---|---|
result |
SourceIngestStatus |
Raw |
Full machine-checked schema: contract/schemas/method.request.json#/methods/SourceIngestStatus, contract/schemas/result.ingestion.json#/methods/SourceIngestStatus.
TelemetryDerive¶
EH-408/EH-409: reads the caller's tenant-scoped stored logs/metrics/spans over one window, binds them to the request graph's declared individuals (RLS-filtered reads), derives BehaviourObservation/HealthAnomaly/Incident/ConformanceViolation facts, and self-translates into ONE BatchUpdate (upsert, deterministic fact ids) against the request graph through dispatch_graph_op. A re-derivation is an idempotent upsert
| Property | Value |
|---|---|
| Stability | stable |
| Authz action | telemetry:derive |
| Mutates | true |
| Durability domain | GraphRedb |
| Idempotent | true |
| Audited | true |
| Emits CDC | true |
| Txn participation | Atomic |
| Replay class | OperationIdentity |
| Consumer profiles | python |
| Error set | ACCESS_DENIED, AUTHENTICATION_REQUIRED, AUTH_AUDIENCE_MISMATCH, AUTH_POLICY_VERSION_MISMATCH, AUTH_TENANT_MISMATCH, BUSY, CANCELLED, CAPACITY_DENIED, CONFLICT, CORRUPT_MUTATION_LEDGER, ENGINE_DEADLINE_EXCEEDED, ENGINE_INTERNAL_METHOD, ENGINE_RESOURCE_EXHAUSTED, ENGINE_UNAVAILABLE, GRAPH_NOT_FOUND, IDEMPOTENCY_CONFLICT, INTERNAL, INVALID_ARGUMENT, METHOD_NOT_YET_SERVED, NODE_MISMATCH, OPERATION_REDIRECTED, READ_ONLY, REDIRECTED, SCHEMA_INCONSISTENT, STALE_OUTBOX_LEASE, STALE_ROUTE, TELEMETRY_UNAVAILABLE, TELEMETRY_WINDOW_TOO_LARGE, TIMEOUT |
| Format identities | STORAGE_KERNEL_SCHEMA_VERSION, GRAPH_SNAPSHOT_SCHEMA_VERSION, GRAPH_META_SCHEMA_VERSION |
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
from_ms |
integer (uint64) | yes | |
policy_msgpack |
array of integer (uint8) | yes | |
streams |
array of string | no | |
to_ms |
integer (uint64) | yes |
Result
| Body | Type | Encoding | Dynamic |
|---|---|---|---|
result |
TelemetryDeriveReceipt |
Raw |
Full machine-checked schema: contract/schemas/method.request.json#/methods/TelemetryDerive, contract/schemas/result.ingestion.json#/methods/TelemetryDerive.
Viz¶
pure compute: resolves a fresh per-request ColumnStore and returns rendered bytes, no durable write (D-VZ-1 lanes V4/V6)
| Property | Value |
|---|---|
| Stability | stable |
| Authz action | viz:render |
| Mutates | false |
| Durability domain | None |
| Idempotent | true |
| Audited | false |
| Emits CDC | false |
| Txn participation | None |
| Replay class | NotReplayable |
| Consumer profiles | python |
| Error set | ACCESS_DENIED, AUTHENTICATION_REQUIRED, AUTH_AUDIENCE_MISMATCH, AUTH_POLICY_VERSION_MISMATCH, AUTH_TENANT_MISMATCH, BUSY, CANCELLED, CAPACITY_DENIED, ENGINE_DEADLINE_EXCEEDED, ENGINE_INTERNAL_METHOD, ENGINE_RESOURCE_EXHAUSTED, ENGINE_UNAVAILABLE, INTERNAL, INVALID_ARGUMENT, METHOD_NOT_YET_SERVED, NODE_MISMATCH, OPERATION_REDIRECTED, STALE_OUTBOX_LEASE, STALE_ROUTE, TIMEOUT |
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
op |
VizOp |
yes |
Result
| Body | Type | Encoding | Dynamic |
|---|---|---|---|
CapabilityMatrix |
VizCapabilityMatrix |
Raw | |
Render |
VizRenderResponse |
Raw | |
RenderProvenance |
one of: VizProvenanceRecord | null |
Raw |
Multi-body result: the
oprequest field selects which body above is returned.
Full machine-checked schema: contract/schemas/method.request.json#/methods/Viz, contract/schemas/result.ingestion.json#/methods/Viz.