API Reference
/
v1
/
Get User Schema V1

Papr Memory API (1.0.0)

API for managing memory, context, and retrieval for AI agents or apps 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
Languages
Servers
Production server
http://memory.papr.ai/

v1

Operations

List User Schemas V1

Request

List all schemas accessible to the authenticated user.

Returns schemas that the user owns or has read access to, including:

  • Personal schemas created by the user
  • Workspace schemas shared within the user's workspace
  • Organization schemas available to the user's organization

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
Query
workspace_idWorkspace Id (string) or Workspace Id (null)(Workspace Id)

Filter by workspace ID

Any of:

Filter by workspace ID

string(Workspace Id)

Filter by workspace ID

status_filterStatus Filter (string) or Status Filter (null)(Status Filter)

Filter by status (draft, active, deprecated, archived)

Any of:

Filter by status (draft, active, deprecated, archived)

string(Status Filter)

Filter by status (draft, active, deprecated, archived)

curl -i -X GET \
  'http://memory.papr.ai/v1/schemas?status_filter=string&workspace_id=string' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Schemas retrieved successfully

Bodyapplication/json
successboolean(Success)required
dataArray of Data (objects) or Data (null)(Data)
Any of:
errorError (string) or Error (null)(Error)
Any of:
string(Error)
codeinteger(Code)
Default 200
totalinteger(Total)
Default 0
Response
application/json
{
  "success": true,
  "data": [
    { … }
  ],
  "code": 200,
  "total": 1
}

Get User Schema V1

Request

Get a specific schema by ID.

Returns the complete schema definition including node types, relationship types, and metadata. User must have read access to the schema.

Path
schema_idstring(Schema Id)required
curl -i -X GET \
  'http://memory.papr.ai/v1/schemas/{schema_id}' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Schema retrieved successfully

Bodyapplication/json
successboolean(Success)required
dataUserGraphSchema (object) or null
Any of:

Complete user-defined graph schema

errorError (string) or Error (null)(Error)
Any of:
string(Error)
codeinteger(Code)
Default 200
Response
application/json
{
  "success": true,
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "version": "1.0.0",
    "user_id": "string",
    "workspace_id": "string",
    "organization_id": "string",
    "node_types": { … },
    "relationship_types": { … },
    "status": "draft",
    "scope": "personal",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "read_access": [ … ],
    "write_access": [ … ],
    "usage_count": 0,
    "last_used_at": "2019-08-24T14:15:22Z"
  },
  "error": "string",
  "code": 200
}

Update User Schema V1

Request

Update an existing schema.

Allows modification of schema properties, node types, and relationship types. User must have write access to the schema. Updates create a new version while preserving the existing data.

Path
schema_idstring(Schema Id)required
Bodyapplication/jsonrequired
property name*anyadditional property
curl -i -X PUT \
  'http://memory.papr.ai/v1/schemas/{schema_id}' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{}'

Responses

Schema updated successfully

Bodyapplication/json
successboolean(Success)required
dataUserGraphSchema (object) or null
Any of:

Complete user-defined graph schema

errorError (string) or Error (null)(Error)
Any of:
string(Error)
codeinteger(Code)
Default 200
Response
application/json
{
  "success": true,
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "version": "1.0.0",
    "user_id": "string",
    "workspace_id": "string",
    "organization_id": "string",
    "node_types": { … },
    "relationship_types": { … },
    "status": "draft",
    "scope": "personal",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "read_access": [ … ],
    "write_access": [ … ],
    "usage_count": 0,
    "last_used_at": "2019-08-24T14:15:22Z"
  },
  "error": "string",
  "code": 200
}

Memory

Operations

User

Operations

Feedback

Operations

Document

Operations

Schema Management

Operations

GraphQL

Operations