Skip to main content

​
Overview

The session store acts as a persistent key-value storage system that maintains state between different sessions and workflow executions. Access the store up to 7 days after workflow run.

​
Key Features

The session store provides:
  • Persistent Storage: Data persists across workflow runs and sessions.
  • Key-Value Structure: Simple interface for storing and retrieving data
  • Session Isolation: Each workflow session has its own isolated storage space
  • Type Safety: Full TypeScript support for stored data types
  • Real-time Access: Instantly read data during workflow execution

​
How It Works

​
Typescript SDK

import { SimplexClient } from '../src/SimplexClient';

const client = new SimplexClient({ apiKey: 'your-api-key' });
const sessionStore = await client.getSessionStore(workflow.sessionId);
The session store operates at the session level, meaning:
  1. Data is isolated per workflow session
  2. Multiple workflows can have their own independent stores
  3. Data persists until explicitly cleared or the session expires
  4. Stores are accessible throughout the entire workflow lifecycle

​
Let agents modify session store

Use session store agent tools to prompt the agent to store important information. For example, your prompt may include: 
Use store_data to save the extracted file information as follows:
    - 's3_url': <downloaded file path>
    - 'file_name': <extracted file name>
    - 'product_information': <extracted product information>
    - 'download_time': <current time>
The agent can then retrieve this stored data in future steps to remember important information. Message us on Slack to use this session store advanced functionality!

​
Best Practices

  • Use Meaningful Keys: Choose descriptive key names that clearly indicate the stored data
  • Handle Missing Data: Always check if data exists before using it
  • Clean Up: Remove unnecessary data to keep storage efficient
  • Type Your Data: Use TypeScript interfaces for complex stored objects
  • Consider Expiry: Session store data expires 7 days after workflow run. Download relevant files to your database before expiration.

​
API Reference

For detailed API documentation on using the session store, see: