MemorySync
SDKs · Direct HTTP

Use MemorySync with Postman

Use Postman as an interactive HTTP client for the same public requests shown in the API Reference. Keep real credentials in a private local environment and choose the correct authentication family per request.

Recommended workflow

Postman request workflow
  1. 01

    Choose

    Open the exact operation in the MemorySync API Reference.

  2. 02

    Import

    Copy its cURL example and import the raw text into Postman.

  3. 03

    Parameterize

    Replace credentials and scope values with private environment variables.

  4. 04

    Send

    Inspect the status, response headers, and operation-specific body.

  5. 05

    Save safely

    Exclude real secrets and sensitive response data before sharing a collection.

Import a memory request

postman-import.sh
curl --request POST https://api.memorysync.io/memory/query \
--header "X-API-Key: {{MEMORYSYNC_API_KEY}}" \
--header "X-Project-ID: {{MEMORYSYNC_PROJECT_ID}}" \
--header "X-End-User-ID: {{MEMORYSYNC_END_USER_ID}}" \
--header "Content-Type: application/json" \
--data '{"query":"What preference applies?","k":5}'

Create a private environment

VariableExample placeholderRule
MEMORYSYNC_API_KEYyour-api-keyMemory API only; keep private.
MEMORYSYNC_PROJECT_IDyour-project-idResolve from authorized application scope.
MEMORYSYNC_END_USER_IDusr_7f3a9c2eUse a stable opaque ID, not an email address.
MEMORYSYNC_ACCESS_TOKENyour-bearer-tokenProtected control-plane requests only; keep private.

Do not combine authentication families

Which header should this request use?

The path is a memory operation

Examples include Add, Query, Get, Update, Forget, Summarize, Compose, Export, and Relations.

Use: X-API-Key plus the operation’s documented scope headers.

The path is a protected account or organization operation

Examples include billing, sessions, projects, exports, API keys, integrations, and webhooks.

Use: Authorization: Bearer {{MEMORYSYNC_ACCESS_TOKEN}}.

The path is `/auth/login`

Login exchanges credentials and does not use an existing bearer token.

Use: Send only the documented JSON body from a trusted context.

Validate the response

Postman response checks
2xx
Read the exact success shape

A successful mutation can still have operation-specific variants.

400 / 422
Correct the request

Check JSON fields, path values, and scope.

401 / 403
Check the auth family

Verify the credential and required permission without exposing it.

404
Unavailable in scope

Check the authorized project, user, and resource ID together.

429 / 5xx
Keep the action recoverable

Do not blindly repeat an uncertain mutation.

Share collections safely

  • Replace all real credentials with variable placeholders.
  • Remove personal data, memory text, passwords, tokens, and webhook secrets from examples.
  • Review environment exports and request history before attaching them to tickets or repositories.
  • Use synthetic IDs and example domains in reusable collections.

Reference pages

Was this page helpful?