Parameters
List of
CreateMemoryRequest objects. Each entry has the same fields as memories.create (document, document_type, user_id, customer_id, mode, metadata, etc.). customer_id is required on B2B and auto-resolved on B2C (B2C vs B2B); mode is the ingestion axis (fast vs long-range) of Retrieval Modes.If
True, the entire batch is rejected as soon as any single document fails validation. If False (default), valid documents are accepted and invalid ones are returned with error_message populated in the per-item result.Returns
BatchCreateResponse with aggregate counts and per-document results.
Unique identifier for the batch submission.
Total number of documents submitted.
Number of documents successfully queued.
Number of documents that failed validation.
Per-document results. Each contains
ingestion_id, document_id, status, queued_at, and an optional error_message if that document was rejected.Example
Raises
SynapAuthError— when the API key is missing or invalid.SynapValidationError— when the batch payload is malformed or exceeds the maximum size.