Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.maximem.ai/llms.txt

Use this file to discover all available pages before exploring further.

await sdk.memories.status(ingestion_id)
Check the progress of an asynchronous ingestion job. Use the ingestion_id returned by memories.create, memories.batch_create, or memories.create_from_file.

​
Parameters

​
ingestion_id
UUID
required
The ingestion job ID returned from a create call.

​
Returns

MemoryStatusResponse with the job’s current state and the IDs of any memories it has produced so far.
​
ingestion_id
UUID
The ingestion job identifier.
​
document_id
string
The document identifier associated with this ingestion.
​
status
string
Current status of the ingestion job.
ValueDescription
queuedDocument is waiting to be processed
processingDocument is currently being processed through the pipeline
completedAll extraction and storage stages completed successfully
failedProcessing failed. Check error_message for details.
partial_successSome extractions succeeded but others failed. Check error_message for details.
​
queued_at
datetime
Timestamp when the job was queued.
​
started_at
datetime
Timestamp when processing started, or None if still queued.
​
completed_at
datetime
Timestamp when processing finished, or None if still in progress.
​
memories_created
integer
Number of memories produced from this ingestion so far.
​
memory_ids
List[UUID]
IDs of memories produced from this ingestion. You can pass these to memories.get.
​
error_message
string
Error description if status is failed or partial_success; otherwise None.

​
Example

from maximem_synap import MaximemSynapSDK

sdk = MaximemSynapSDK(api_key="synap_your_key_here")
await sdk.initialize()

status = await sdk.memories.status(result.ingestion_id)
print(status.status)            # e.g. "completed"
print(status.memories_created)  # e.g. 3
print(status.memory_ids)        # list of UUIDs

​
Raises

  • SynapAuthError — when the API key is missing or invalid.
  • SynapNotFoundError — when the ingestion_id is unknown.

​
See also