Get Memory V1

Papr Memory API (1.0.0)

API for managing personal memory items with authentication and user-specific data.

Authentication

This API supports three authentication methods:

API Key: Include your API key in the X-API-Key header
```
X-API-Key: <your-api-key>
```
Session Token: Include your session token in the X-Session-Token header
```
X-Session-Token: <your-session-token>
```
Bearer Token: Include your OAuth2 token from Auth0 in the Authorization header
```
Authorization: Bearer <token>
```

All endpoints require one of these authentication methods.

Download OpenAPI description

index.json

index.yaml

Servers

Production server

http://memory.papr.ai/

v1

Operations

Delete Memory V1

Request

Delete a memory item by ID.

Authentication Required: One of the following authentication methods must be used:

Bearer token in Authorization header
API Key in X-API-Key header
Session token in X-Session-Token header

Required Headers:

X-Client-Type: (e.g., 'papr_plugin', 'browser_extension')

Path

memory_idstring(Memory Id)required

Query

skip_parseboolean(Skip Parse)

Skip Parse Server deletion

Default false

curl -i -X DELETE \
  'http://memory.papr.ai/v1/memory/{memory_id}?skip_parse=false' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Memory successfully deleted

Bodyapplication/json

codeinteger(Code)

HTTP status code

Default 200

statusstring(Status)

'success' or 'error'

Default "success"

messageMessage (string) or Message (null)(Message)

Any of:

string(Message)

errorError (string) or Error (null)(Error)

Any of:

string(Error)

memoryIdstring(Memoryid)

Default ""

objectIdstring(Objectid)

Default ""

deletion_statusDeletionStatus (object) or null

Any of:

detailsDetails (any) or Details (null)(Details)

Any of:

any(Details)

Response

application/json

{
  "code": 200,
  "status": "success",
  "message": "string",
  "error": "string",
  "memoryId": "",
  "objectId": "",
  "deletion_status": {
    "pinecone": false,
    "neo4j": false,
    "parse": false,
    "qdrant": false
  },
  "details": {}
}

Get Memory V1

Request

Retrieve a memory item by ID.

Authentication Required: One of the following authentication methods must be used:

Bearer token in Authorization header
API Key in X-API-Key header
Session token in X-Session-Token header

Required Headers:

X-Client-Type: (e.g., 'papr_plugin', 'browser_extension')

Path

memory_idstring(Memory Id)required

Query

require_consentboolean(Require Consent)

If true, return 404 if the memory has consent='none'. Ensures only consented memories are returned.

Default false

exclude_flaggedboolean(Exclude Flagged)

If true, return 404 if the memory has risk='flagged'. Filters out flagged content.

Default false

max_riskMax Risk (string) or Max Risk (null)(Max Risk)

Maximum risk level allowed. Values: 'none', 'sensitive', 'flagged'. If memory exceeds this, return 404.

Any of:

Maximum risk level allowed. Values: 'none', 'sensitive', 'flagged'. If memory exceeds this, return 404.

string(Max Risk)

Maximum risk level allowed. Values: 'none', 'sensitive', 'flagged'. If memory exceeds this, return 404.

curl -i -X GET \
  'http://memory.papr.ai/v1/memory/{memory_id}?exclude_flagged=false&max_risk=string&require_consent=false' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Memory successfully retrieved

Bodyapplication/json

codeinteger(Code)

HTTP status code

Default 200

Example: 200

statusstring(Status)

'success' or 'error'

Default "success"

Example: "success"

dataSearchResult (object) or null

Search results if successful

Example: {"memories":[],"nodes":[]}

Any of:

Search results if successful

errorError (string) or Error (null)(Error)

Error message if failed

Any of:

Error message if failed

string(Error)

Error message if failed

detailsDetails (any) or Details (null)(Details)

Additional error details or context

Any of:

Additional error details or context

any(Details)

Additional error details or context

search_idSearch Id (string) or Search Id (null)(Search Id)

Unique identifier for this search query, maps to QueryLog objectId in Parse Server

Example: "abc123def456"

Any of:

Unique identifier for this search query, maps to QueryLog objectId in Parse Server

string(Search Id)

Unique identifier for this search query, maps to QueryLog objectId in Parse Server

Response

application/json

{
  "code": 200,
  "data": {
    "memories": [],
    "nodes": []
  },
  "search_id": "abc123def456",
  "status": "success"
}

Add Memory Batch V1

Request

Add multiple memory items in a batch with size validation and background processing.

Authentication Required: One of the following authentication methods must be used:

Bearer token in Authorization header
API Key in X-API-Key header
Session token in X-Session-Token header

Required Headers:

Content-Type: application/json
X-Client-Type: (e.g., 'papr_plugin', 'browser_extension')

The API validates individual memory content size against MAX_CONTENT_LENGTH environment variable (defaults to 15000 bytes).

Query

skip_background_processingboolean(Skip Background Processing)

If True, skips adding background tasks for processing

Default false

Bodyapplication/jsonrequired

memory_policyMemoryPolicy (object) or null

Unified policy for graph generation and OMO safety. Use mode='auto' (LLM extraction, constraints applied if provided) or 'manual' (exact nodes). Includes consent, risk, and ACL settings. If schema_id is set, schema's memory_policy is used as defaults.

Any of:

link_toLink To (string) or Array of Link To (strings) or Link To (object) or Link To (null)(Link To)

Shorthand DSL for node/edge constraints. Expands to memory_policy.node_constraints and edge_constraints. Formats: - String: 'Task:title' (semantic match on Task.title) - List: ['Task:title', 'Person:email'] (multiple constraints) - Dict: {'Task:title': {'set': {...}}} (with options) Syntax: - Node: 'Type:property', 'Type:prop=value' (exact), 'Type:prop~value' (semantic) - Edge: 'Source->EDGE->Target:property' (arrow syntax) - Via: 'Type.via(EDGE->Target:prop)' (relationship traversal) - Special: '$this', '$previous', '$context:N' Example: 'SecurityBehavior->MITIGATES->TacticDef:name' with {'create': 'never'}

Any of:

string(Link To)

external_user_idExternal User Id (string) or External User Id (null)(External User Id)

Your application's user identifier for all memories in the batch. This is the primary way to identify users. Papr will automatically resolve or create internal users as needed.

Example: "external_user_abcde"

Any of:

Your application's user identifier for all memories in the batch. This is the primary way to identify users. Papr will automatically resolve or create internal users as needed.

string(External User Id)

Your application's user identifier for all memories in the batch. This is the primary way to identify users. Papr will automatically resolve or create internal users as needed.

organization_idOrganization Id (string) or Organization Id (null)(Organization Id)

Optional organization ID for multi-tenant batch memory scoping. When provided, all memories in the batch are associated with this organization.

Any of:

Optional organization ID for multi-tenant batch memory scoping. When provided, all memories in the batch are associated with this organization.

string(Organization Id)

Optional organization ID for multi-tenant batch memory scoping. When provided, all memories in the batch are associated with this organization.

namespace_idNamespace Id (string) or Namespace Id (null)(Namespace Id)

Optional namespace ID for multi-tenant batch memory scoping. When provided, all memories in the batch are associated with this namespace.

Any of:

Optional namespace ID for multi-tenant batch memory scoping. When provided, all memories in the batch are associated with this namespace.

string(Namespace Id)

Optional namespace ID for multi-tenant batch memory scoping. When provided, all memories in the batch are associated with this namespace.

memoriesArray of objects(Memories)[ 1 .. 50 ] itemsrequired

List of memory items to add in batch

Example: [{"content":"Meeting notes from the product planning session","metadata":{"createdAt":"2024-03-21T10:00:00Z","emoji tags":"📊,💡,📝","emotion tags":"focused, productive","hierarchical structures":"Business/Planning/Product","topics":"product, planning"},"type":"text"},{"content":"Follow-up tasks from the planning meeting","metadata":{"createdAt":"2024-03-21T11:00:00Z","emoji tags":"✅,📋","emotion tags":"organized","hierarchical structures":"Business/Tasks/Planning","topics":"tasks, planning"},"type":"text"}]

memories[].memory_policyMemoryPolicy (object) or null

Any of:

memories[].link_toLink To (string) or Array of Link To (strings) or Link To (object) or Link To (null)(Link To)

Any of:

string(Link To)

memories[].contentstring(Content)required

The content of the memory item you want to add to memory

Example: "Meeting with John Smith from Acme Corp about the Q4 project timeline"

memories[].typestring(MemoryType)

Memory item type; defaults to 'text' if omitted

Default "text"

Enum"text""code_snippet""document"

Example: "text"

memories[].organization_idOrganization Id (string) or Organization Id (null)(Organization Id)

Optional organization ID for multi-tenant memory scoping. When provided, memory is associated with this organization.

Any of:

Optional organization ID for multi-tenant memory scoping. When provided, memory is associated with this organization.

string(Organization Id)

Optional organization ID for multi-tenant memory scoping. When provided, memory is associated with this organization.

memories[].namespace_idNamespace Id (string) or Namespace Id (null)(Namespace Id)

Optional namespace ID for multi-tenant memory scoping. When provided, memory is associated with this namespace.

Any of:

Optional namespace ID for multi-tenant memory scoping. When provided, memory is associated with this namespace.

string(Namespace Id)

Optional namespace ID for multi-tenant memory scoping. When provided, memory is associated with this namespace.

memories[].external_user_idExternal User Id (string) or External User Id (null)(External User Id)

Your application's user identifier. This is the primary way to identify users. Use this for your app's user IDs (e.g., 'user_alice_123', UUID, email). Papr will automatically resolve or create internal users as needed.

Any of:

string(External User Id)

memories[].metadataMemoryMetadata (object) or null

Metadata used in graph and vector store for a memory item. Include role and category here.

Example: {"conversationId":"conv-123","createdAt":"2024-10-04T10:00:00Z","emoji_tags":"📅,👥,📋","emotion_tags":"focused, productive","external_user_id":"external_user_123","external_user_read_access":["external_user_123","external_user_789"],"external_user_write_access":["external_user_123"],"hierarchical_structures":"Business/Meetings/Project Planning","location":"Conference Room A","sourceUrl":"https://calendar.example.com/meeting/123","topics":["product","planning"]}

Any of:

Metadata used in graph and vector store for a memory item. Include role and category here.

memories[].contextArray of Context (objects) or Context (null)(Context)

Conversation history context for this memory. Use for providing message history when adding a memory. Format: [{role: 'user'|'assistant', content: '...'}]

Example: [{"content":"Let's discuss the Q4 project timeline with John","role":"user"},{"content":"I'll help you prepare for the timeline discussion. What are your key milestones?","role":"assistant"}]

Any of:

Conversation history context for this memory. Use for providing message history when adding a memory. Format: [{role: 'user'|'assistant', content: '...'}]

memories[].graph_generationGraphGeneration (object) or nullDeprecated

DEPRECATED: Use 'memory_policy' instead. Legacy graph generation configuration. If both memory_policy and graph_generation are provided, memory_policy takes precedence.

Any of:

Deprecated

DEPRECATED: Use 'memory_policy' instead. Legacy graph generation configuration. If both memory_policy and graph_generation are provided, memory_policy takes precedence.

memories[].user_idUser Id (string) or User Id (null)(User Id)Deprecated

DEPRECATED: Use 'external_user_id' instead. Internal Papr Parse user ID. Most developers should not use this field directly.

Any of:

Deprecated

DEPRECATED: Use 'external_user_id' instead. Internal Papr Parse user ID. Most developers should not use this field directly.

string(User Id)

DEPRECATED: Use 'external_user_id' instead. Internal Papr Parse user ID. Most developers should not use this field directly.

memories[].relationships_jsonArray of Relationships Json (objects) or Relationships Json (null)(Relationships Json)Deprecated

DEPRECATED: Use 'memory_policy' instead. Migration options: 1. Specific memory: relationships=[{source: '$this', target: 'mem_123', type: 'FOLLOWS'}] 2. Previous memory: link_to_previous_memory=True 3. Related memories: link_to_related_memories=3

Any of:

Deprecated

batch_sizeBatch Size (integer) or Batch Size (null)(Batch Size)

Number of items to process in parallel

Default 10

Example: 10

Any of:

Number of items to process in parallel

[ 1 .. 50 ]

integer(Batch Size)[ 1 .. 50 ]

Number of items to process in parallel

Default 10

webhook_urlWebhook Url (string) or Webhook Url (null)(Webhook Url)

Optional webhook URL to notify when batch processing is complete. The webhook will receive a POST request with batch completion details.

Any of:

Optional webhook URL to notify when batch processing is complete. The webhook will receive a POST request with batch completion details.

string(Webhook Url)

Optional webhook URL to notify when batch processing is complete. The webhook will receive a POST request with batch completion details.

webhook_secretWebhook Secret (string) or Webhook Secret (null)(Webhook Secret)

Optional secret key for webhook authentication. If provided, will be included in the webhook request headers as 'X-Webhook-Secret'.

Any of:

Optional secret key for webhook authentication. If provided, will be included in the webhook request headers as 'X-Webhook-Secret'.

string(Webhook Secret)

Optional secret key for webhook authentication. If provided, will be included in the webhook request headers as 'X-Webhook-Secret'.

property name*anyadditional property

graph_generationGraphGeneration (object) or nullDeprecated

DEPRECATED: Use 'memory_policy' instead. Legacy graph generation configuration. If both memory_policy and graph_generation are provided, memory_policy takes precedence.

Any of:

Deprecated

DEPRECATED: Use 'memory_policy' instead. Legacy graph generation configuration. If both memory_policy and graph_generation are provided, memory_policy takes precedence.

user_idUser Id (string) or User Id (null)(User Id)Deprecated

DEPRECATED: Use 'external_user_id' instead. Internal Papr Parse user ID.

Example: "internal_user_id_12345"

Any of:

Deprecated

DEPRECATED: Use 'external_user_id' instead. Internal Papr Parse user ID.

string(User Id)

DEPRECATED: Use 'external_user_id' instead. Internal Papr Parse user ID.

curl -i -X POST \
  'http://memory.papr.ai/v1/memory/batch?skip_background_processing=false' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "batch_size": 10,
    "external_user_id": "external_user_abcde",
    "memories": [
      {
        "content": "Meeting notes from the product planning session",
        "metadata": {
          "createdAt": "2024-03-21T10:00:00Z",
          "emoji tags": "📊,💡,📝",
          "emotion tags": "focused, productive",
          "hierarchical structures": "Business/Planning/Product",
          "topics": "product, planning"
        },
        "type": "text"
      },
      {
        "content": "Follow-up tasks from the planning meeting",
        "metadata": {
          "createdAt": "2024-03-21T11:00:00Z",
          "emoji tags": "✅,📋",
          "emotion tags": "organized",
          "hierarchical structures": "Business/Tasks/Planning",
          "topics": "tasks, planning"
        },
        "type": "text"
      }
    ],
    "user_id": "internal_user_id_12345"
  }'

Responses

Memories successfully added

Bodyapplication/json

codeinteger(Code)

HTTP status code for the batch operation

Default 200

statusstring(Status)

'success', 'partial', or 'error'

Default "success"

messageMessage (string) or Message (null)(Message)

Human-readable status message

Any of:

Human-readable status message

string(Message)

Human-readable status message

errorError (string) or Error (null)(Error)

Batch-level error message, if any

Any of:

Batch-level error message, if any

string(Error)

Batch-level error message, if any

detailsDetails (any) or Details (null)(Details)

Additional error details or context

Any of:

Additional error details or context

any(Details)

Additional error details or context

successfulArray of objects(Successful)

List of successful add responses

errorsArray of objects(Errors)

List of errors for failed items

total_processedinteger(Total Processed)

Default 0

total_successfulinteger(Total Successful)

Default 0

total_failedinteger(Total Failed)

Default 0

total_content_sizeinteger(Total Content Size)

Default 0

total_storage_sizeinteger(Total Storage Size)

Default 0

Response

application/json

{
  "code": 200,
  "status": "success",
  "message": "string",
  "error": "string",
  "details": {},
  "successful": [
    { … }
  ],
  "errors": [
    { … }
  ],
  "total_processed": 0,
  "total_successful": 0,
  "total_failed": 0,
  "total_content_size": 0,
  "total_storage_size": 0
}

Memory

Operations

User

Operations

Feedback

Operations

Schema Management

Operations

Messages

Operations

omo

Operations

Sync

Operations

Telemetry

Operations

Document

Operations

GraphQL

Operations

Authentication

Operations

Papr Memory API (1.0.0)

Authentication

v1

Delete Memory V1

Request

Responses

Was this helpful?

Get Memory V1

Request

Responses

Was this helpful?

Add Memory Batch V1

Request

Responses

Was this helpful?

Memory

User

Feedback

Schema Management

Messages

omo

Sync

Telemetry

Document

GraphQL

Authentication

Papr Memory API (1.0.0)

Authentication

v1

Delete Memory V1

Request

Responses

Was this helpful?

Get Memory V1

RequestExpand all

Responses

Was this helpful?

Add Memory Batch V1

RequestExpand all

Responses

Was this helpful?

Memory

User

Feedback

Schema Management

Messages

omo

Sync

Telemetry

Document

GraphQL

Authentication

Request

Request