API Integration

Build custom integrations with MemoryPlugin using our OpenAPI specification

Written by asad

Last updated 2 months ago

For developers who want to create custom integrations or use MemoryPlugin on unsupported platforms, we provide a comprehensive OpenAPI specification that you can use to build your own integrations.

OpenAPI Specification

Our API is fully documented using the industry-standard OpenAPI format:

MemoryPlugin OpenAPI Spec

Access the complete OpenAPI specification

The OpenAPI spec includes:

• All API endpoints with detailed documentation
• Request/response schemas and examples
• Authentication requirements
• Machine-readable instructions for automated tools

Supported Integration Tools

The OpenAPI specification can be imported into many platforms and tools:

Automation Platforms

• n8n: Create custom nodes using our OpenAPI spec
• Zapier: Build custom integrations (if they support OpenAPI import)
• Make (formerly Integromat): Custom API connections
• Microsoft Power Automate: Custom connector creation

Development Tools

• Postman: Import for API testing and development
• Insomnia: API client for testing endpoints
• Swagger UI: Interactive API documentation
• Code Generators: Generate client libraries in various languages

AI Platforms

• LibreChat: Import as actions for enhanced AI conversations
• Other AI Clients: Many third-party AI applications support OpenAPI imports

Example: n8n Integration

Here’s how you can use our OpenAPI spec with n8n:

1. Install n8n OpenAPI Node

   Use the community package: n8n-openapi-node

2. Import OpenAPI Spec

   Configure the node to use: https://www.memoryplugin.com/openapi.json

3. Set Authentication

   Configure Bearer token authentication with your MemoryPlugin API key

4. Create Workflows

   Build n8n workflows that interact with your MemoryPlugin memories

Authentication

All API requests require authentication using a Bearer token:

Authorization: Bearer YOUR_API_TOKEN_HERE

Getting Your API Token

1. Access Dashboard

   Go to your MemoryPlugin Dashboard

2. Find API Section

   Look for the API or Auth Token section

3. Copy Token

   Copy your authentication token

4. Keep Secure

   Treat this token like a password - keep it secure and regenerate if compromised

Core API Endpoints

The MemoryPlugin API provides endpoints for:

Memory Management

• GET /api/memory - Retrieve and search memories
• POST /api/memory - Create new memories

Bucket Management

• GET /api/buckets - List memory buckets
• POST /api/buckets - Create new buckets

Combined Operations

• GET /api/v2/memory - Get memories and buckets in a single request

Full API Reference

Complete documentation for all endpoints, parameters, and examples

Implementation

For detailed implementation examples, request/response schemas, and code samples, see our comprehensive API reference documentation.

Use Cases for Custom Integrations

Workflow Automation

Integrate memory creation/retrieval into personal or team automation workflows

Custom AI Applications

Build your own AI applications with persistent memory capabilities

Data Migration

Import existing knowledge bases or personal data into MemoryPlugin

Platform Integration

Add MemoryPlugin to platforms that don’t have native support

Best Practices

Rate Limiting

Respect API rate limits and implement appropriate retry logic in your integrations.

Error Handling

Always implement proper error handling for API calls and network issues.

Token Security

Never expose your API tokens in client-side code or public repositories.

Data Validation

Validate data before sending it to the API to avoid errors and ensure data quality.

Support and Resources

API Documentation

Detailed API reference documentation

OpenAPI Spec

Machine-readable API specification

Example Integrations

Community examples and tools

Developer Support

Get help with your custom integration