API Reference
/
v1
/
Get Namespace Instance Config

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
Languages
Servers
Production server
https://memoryserver-staging-223473570766.us-west1.run.app/

v1

Operations

Set Namespace Instance Config

Request

Set dedicated instance configuration for a namespace.

Path
namespace_idstring(Namespace Id)required
Query
validateboolean(Validate)

Test connection before saving

Default false
Headers
X-API-Keystring(X-Api-Key)required
Bodyapplication/jsonrequired
neo4jNeo4jInstanceConfigInput (object) or null

Neo4j AuraDB instance configuration

Example: {"bolt_url":"neo4j+s://abc12345.databases.neo4j.io","graphql_endpoint":"https://abc12345-graphql.production-orch-0042.neo4j.io/graphql","password":"my-secret-password","username":"neo4j"}
Any of:

Neo4j AuraDB instance configuration

providerstring(Provider)

Cloud provider (only 'gcp' supported today)

Default "gcp"
Example: "gcp"
regionstring(Region)

Cloud region (only 'us-west1' supported today)

Default "us-west1"
Example: "us-west1"
curl -i -X PUT \
  'https://memoryserver-staging-223473570766.us-west1.run.app/v1/namespace/{namespace_id}/instance?validate=false' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: string' \
  -d '{
    "neo4j": {
      "bolt_url": "neo4j+s://abc12345.databases.neo4j.io",
      "graphql_endpoint": "https://abc12345-graphql.production-orch-0042.neo4j.io/graphql",
      "password": "my-secret-password",
      "username": "neo4j"
    },
    "provider": "gcp",
    "region": "us-west1"
  }'

Responses

Successful Response

Bodyapplication/json
codeinteger(Code)

HTTP status code

Default 200
statusstring(Status)

'success' or 'error'

Default "success"
dataInstanceConfigItem (object) or null

Instance config if successful

Any of:

Instance config 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 context

Any of:

Additional context

any(Details)

Additional context

Response
application/json
{
  "code": 200,
  "status": "success",
  "data": {
    "neo4j": { … },
    "provider": "string",
    "region": "string",
    "scope": "string"
  },
  "error": "string",
  "details": {}
}

Get Namespace Instance Config

Request

Get resolved instance configuration for a namespace (namespace > org). Passwords are masked.

Path
namespace_idstring(Namespace Id)required
Headers
X-API-Keystring(X-Api-Key)required
curl -i -X GET \
  'https://memoryserver-staging-223473570766.us-west1.run.app/v1/namespace/{namespace_id}/instance' \
  -H 'X-API-Key: string'

Responses

Successful Response

Bodyapplication/json
codeinteger(Code)

HTTP status code

Default 200
statusstring(Status)

'success' or 'error'

Default "success"
dataInstanceConfigItem (object) or null

Instance config if successful

Any of:

Instance config 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 context

Any of:

Additional context

any(Details)

Additional context

Response
application/json
{
  "code": 200,
  "status": "success",
  "data": {
    "neo4j": { … },
    "provider": "string",
    "region": "string",
    "scope": "string"
  },
  "error": "string",
  "details": {}
}

Delete Namespace Instance Config

Request

Remove dedicated instance configuration from a namespace (reverts to org or shared).

Path
namespace_idstring(Namespace Id)required
Headers
X-API-Keystring(X-Api-Key)required
curl -i -X DELETE \
  'https://memoryserver-staging-223473570766.us-west1.run.app/v1/namespace/{namespace_id}/instance' \
  -H 'X-API-Key: string'

Responses

Successful Response

Bodyapplication/json
codeinteger(Code)

HTTP status code

Default 200
statusstring(Status)

'success' or 'error'

Default "success"
dataInstanceConfigItem (object) or null

Instance config if successful

Any of:

Instance config 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 context

Any of:

Additional context

any(Details)

Additional context

Response
application/json
{
  "code": 200,
  "status": "success",
  "data": {
    "neo4j": { … },
    "provider": "string",
    "region": "string",
    "scope": "string"
  },
  "error": "string",
  "details": {}
}

Memory

Operations

Memory Status

Operations

User

Operations

Feedback

Operations

Schema Management

Operations

Messages

Operations

omo

Operations

Namespace

Operations

Frequency Schemas

Operations

Holographic Transform

Operations

Instance Configuration

Operations

AI Proxy

Operations

Sync

Operations

Telemetry

Operations

Document

Operations

GraphQL

Operations

Authentication

Operations