Skip to main content

Lightweight Python client for the Reflexio API

Project description

Reflexio Python SDK

PyPI Python >= 3.12 License: Apache 2.0 Downloads

The official Python SDK for Reflexio — the adaptive memory layer for AI agents. Reflexio automatically extracts user profiles, generates playbooks, and evaluates agent performance from conversation data. This client provides type-safe, sync-first access to the full Reflexio API. For source code and contributions, see the GitHub repository.

Table of Contents

Installation

pip install reflexio-client

Quick Start

from reflexio import ReflexioClient

# API key from constructor or REFLEXIO_API_KEY env var
client = ReflexioClient(api_key="your-api-key")

# Or connect to a self-hosted instance
client = ReflexioClient(
    api_key="your-api-key",
    url_endpoint="http://localhost:8081",
)

Authentication

The client authenticates via Bearer token. Provide your API key in one of two ways:

  1. Constructor: ReflexioClient(api_key="your-key")
  2. Environment variable: Set REFLEXIO_API_KEY (auto-detected)

The base URL defaults to https://www.reflexio.ai/ and can be overridden with url_endpoint or the REFLEXIO_URL env var.

Publishing Interactions

Publish user interactions to trigger profile extraction, playbook generation, and evaluation:

# Server-async mode: HTTP round-trip blocks, but server returns as soon as
# it has registered the background extraction (~100 ms).
response = client.publish_interaction(
    user_id="user-123",
    interactions=[
        {"role": "user",      "content": "How do I reset my password?"},
        {"role": "assistant", "content": "Go to Settings > Security > Reset Password."},
    ],
    source="support-bot",
    agent_version="v2.1",
    session_id="session-abc",
)

# Wait for the server to finish processing before returning.
response = client.publish_interaction(
    user_id="user-123",
    interactions=[
        {"role": "user",      "content": "Thanks, that worked!"},
        {"role": "assistant", "content": "Glad I could help!"},
    ],
    agent_version="v2.1",
    wait_for_response=True,
)
print(response.success, response.message)

Profiles

# Semantic search for profiles
results = client.search_user_profiles(user_id="user-123", query="password preferences")
for profile in results.profiles:
    print(profile.profile_name, profile.profile_content)

# Get all profiles for a user
profiles = client.get_profiles(user_id="user-123")

# Filter by status
from reflexio import Status
profiles = client.get_profiles(user_id="user-123", status_filter=[Status.CURRENT])

# Get all profiles across all users
all_profiles = client.get_all_profiles(limit=50)

# Delete a specific profile
client.delete_profile(user_id="user-123", profile_id="prof-456", wait_for_response=True)

# Get profile change history
changelog = client.get_profile_change_log()

# Rerun profile generation from existing interactions
response = client.rerun_profile_generation(
    user_id="user-123",
    extractor_names=["preferences"],
    wait_for_response=True,
)
print(f"Generated {response.profiles_generated} profiles")

Interactions

# Semantic search
results = client.search_interactions(user_id="user-123", query="password reset")

# List interactions for a user
interactions = client.get_interactions(user_id="user-123", top_k=50)

# Get all interactions across all users
all_interactions = client.get_all_interactions(limit=100)

# Delete a specific interaction
client.delete_interaction(
    user_id="user-123", interaction_id="int-789", wait_for_response=True
)

Requests & Sessions

# Get requests grouped by session
requests = client.get_requests(user_id="user-123")

# Delete a request and its interactions
client.delete_request(request_id="req-001", wait_for_response=True)

# Delete all requests in a session
client.delete_session(session_id="session-abc", wait_for_response=True)

Playbooks

User Playbooks (extracted from interactions)

from reflexio import UserPlaybook

# Get user playbooks
playbooks = client.get_user_playbooks(playbook_name="usability", limit=50)

# Search user playbooks
results = client.search_user_playbooks(query="slow response", agent_version="v2.1")

# Add a user playbook directly
client.add_user_playbook(user_playbooks=[
    UserPlaybook(
        agent_version="v2.1",
        request_id="req-001",
        content="User found the response helpful",
        playbook_name="satisfaction",
    )
])

# Rerun playbook generation
client.rerun_playbook_generation(
    agent_version="v2.1",
    playbook_name="usability",
    wait_for_response=True,
)

Agent Playbooks (clustered insights)

from reflexio import AgentPlaybook, PlaybookStatus

# Get agent playbooks
agent_playbooks = client.get_agent_playbooks(
    playbook_name="usability",
    playbook_status_filter=PlaybookStatus.APPROVED,
)

# Search agent playbooks
results = client.search_agent_playbooks(query="response quality", agent_version="v2.1")

# Add an agent playbook directly
client.add_agent_playbooks(agent_playbooks=[
    AgentPlaybook(
        agent_version="v2.1",
        content="Users prefer concise answers",
        playbook_status=PlaybookStatus.APPROVED,
        playbook_metadata="Aggregated from 15 user playbooks",
        playbook_name="style",
    )
])

# Run playbook aggregation
client.run_playbook_aggregation(
    agent_version="v2.1",
    playbook_name="usability",
    wait_for_response=True,
)

Unified Search

Search across profiles, agent playbooks, user playbooks, and skills in one call:

from reflexio import ConversationTurn

results = client.search(
    query="user prefers dark mode",
    top_k=5,
    agent_version="v2.1",
    user_id="user-123",
    enable_reformulation=True,
    conversation_history=[
        ConversationTurn(role="user", content="What themes are available?"),
        ConversationTurn(role="assistant", content="We support light and dark themes."),
    ],
)

print(results.profiles)
print(results.feedbacks)       # agent playbooks
print(results.raw_feedbacks)   # user playbooks

Evaluation

# Get agent success evaluation results
results = client.get_agent_success_evaluation_results(
    agent_version="v2.1",
    limit=50,
)

Configuration

from reflexio import Config

# Get current config
config = client.get_config()
print(config)

# Update config
client.set_config(Config(
    profile_extractor_config=[...],
    playbook_config=[...],
))

Bulk Delete Operations

# Delete by IDs
client.delete_requests_by_ids(["req-001", "req-002"])
client.delete_profiles_by_ids(["prof-001", "prof-002"])
client.delete_agent_playbooks_by_ids([1, 2, 3])
client.delete_user_playbooks_by_ids([4, 5, 6])

# Delete all
client.delete_all_interactions()
client.delete_all_profiles()
client.delete_all_playbooks()

Fire-and-Forget vs Blocking

Most write/delete methods support wait_for_response:

  • wait_for_response=False (default): Non-blocking fire-and-forget. Returns None. Efficient for high-throughput pipelines.
  • wait_for_response=True: Blocks until the server finishes processing. Returns the full response.

In async contexts (e.g., FastAPI), fire-and-forget uses the existing event loop. In sync contexts, it uses a shared thread pool.

API Reference

Interactions

Method Description
publish_interaction() Publish interactions (triggers profile/playbook/evaluation)
search_interactions() Semantic search for interactions
get_interactions() Get interactions for a user
get_all_interactions() Get all interactions across users
delete_interaction() Delete a specific interaction
delete_all_interactions() Delete all interactions

Profiles

Method Description
search_user_profiles() Semantic search for profiles
get_profiles() Get profiles for a user
get_all_profiles() Get all profiles across users
delete_profile() Delete profiles by ID or search query
delete_profiles_by_ids() Bulk delete profiles by ID
delete_all_profiles() Delete all profiles
get_profile_change_log() Get profile change history
rerun_profile_generation() Regenerate profiles from interactions
manual_profile_generation() Trigger profile generation with window-sized interactions

Agent Playbooks

Method Description
get_agent_playbooks() Get agent playbooks
search_agent_playbooks() Search agent playbooks
add_agent_playbooks() Add agent playbooks directly
run_playbook_aggregation() Cluster user playbooks into agent playbooks
delete_agent_playbooks_by_ids() Bulk delete agent playbooks
delete_all_playbooks() Delete all playbooks

User Playbooks

Method Description
get_user_playbooks() Get user playbooks
search_user_playbooks() Search user playbooks
add_user_playbook() Add user playbook directly
rerun_playbook_generation() Regenerate playbooks for an agent version
manual_playbook_generation() Trigger playbook generation with window-sized interactions
delete_user_playbooks_by_ids() Bulk delete user playbooks

Requests & Sessions

Method Description
get_requests() Get requests grouped by session
delete_request() Delete a request and its interactions
delete_session() Delete all requests in a session
delete_requests_by_ids() Bulk delete requests by ID

Search

Method Description
search() Unified search across all entity types

Evaluation

Method Description
get_agent_success_evaluation_results() Get evaluation results

Configuration

Method Description
get_config() Get current configuration
set_config() Update org configuration

Requirements

  • Python >= 3.12
  • pydantic >= 2.0.0
  • requests >= 2.25.0
  • aiohttp >= 3.12.9
  • python-dateutil >= 2.8.0
  • python-dotenv >= 0.19.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

reflexio_client-0.2.13.tar.gz (174.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

reflexio_client-0.2.13-py3-none-any.whl (220.9 kB view details)

Uploaded Python 3

File details

Details for the file reflexio_client-0.2.13.tar.gz.

File metadata

  • Download URL: reflexio_client-0.2.13.tar.gz
  • Upload date:
  • Size: 174.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.17 {"installer":{"name":"uv","version":"0.11.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for reflexio_client-0.2.13.tar.gz
Algorithm Hash digest
SHA256 923391e96747f71f2108c90f19fa97f8a3aa4ac840ad22428e2328d552fb8b62
MD5 eabf6f8eca613d3889ba51d4b8af49ed
BLAKE2b-256 a671c756a67f8bfe922cd23080fee7f0c891f71b28c93f15e90b529bc1cbef94

See more details on using hashes here.

File details

Details for the file reflexio_client-0.2.13-py3-none-any.whl.

File metadata

  • Download URL: reflexio_client-0.2.13-py3-none-any.whl
  • Upload date:
  • Size: 220.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.17 {"installer":{"name":"uv","version":"0.11.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for reflexio_client-0.2.13-py3-none-any.whl
Algorithm Hash digest
SHA256 806eecdd17ed928dd0222811361c2ec01315e072af2ea15662326b4224a570d0
MD5 c78b05d0a209fbed9b7759046ccaefbb
BLAKE2b-256 65d8e19d3c0ed9034987462b05ff965b33b5c8225fcb39852a3310a9b4cd2e23

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page