Skip to main content
The PiyAPI REST API provides programmatic access to persistent memory and context operations, allowing applications and agents to create, retrieve, search, update, and manage memory through standard HTTP requests. API VERSION: v1 BASE URL: Configure in your deployment
Quick start Get your API key and make your first memory request in a few minutes.

Quick Start Guide

1

Add Memories

Store information and context from your application’s conversations or events.
2

Search Memories

Retrieve relevant memories using semantic or contextual search.
3

Get Memories

Retrieve a specific stored memory when you already know its identifier.

Core Operations

API Categories

Explore the API by functionality.

Memory APIs

Core memory operations including create, search, update, delete, history, and export workflows.

Events APIs

Track and inspect asynchronous memory-related events.

Entities APIs

Manage users, agents, applications, and associated memory data.

Organizations & Projects

Manage organization-level access, projects, and collaboration boundaries.

Webhooks

Receive real-time notifications for supported memory and system events.
Building a multi-tenant application? Learn how Organizations & Projects can be used to separate access, resources, and collaboration boundaries.

Authentication

All requests to the PiyAPI API must include a valid API key passed via the Authorization header using the Bearer scheme. Requests without a valid key will be rejected.
  • API keys should be stored server-side.
  • Requests should be made through secure server-side environments.
  • Do not expose secrets in client-side code.
Your application sends an HTTP request to the PiyAPI API (Memory / Context Layer), which returns a JSON response.
Keep your API key secure. Never expose API credentials in client-side code or public repositories. Use environment variables and server-side requests.

Next Steps

Add your first memory

Start storing persistent context through the API.

Search with filters

Learn advanced search and filtering techniques.

Build with cookbooks

See complete API workflows inside practical projects.