Deprecations and Migrations

Use this page to migrate old integrations to the current API contract.

Prerequisites

• Inventory of current payloads used by your app
• Access to SDK wrapper or API client code paths
• API reference available for schema checks

Minimal Setup

1. Replace deprecated fields with current equivalents.
2. Re-run end-to-end tests with baseline retrieval settings.
3. Update templates and SDK wrappers to emit only current fields.

Field Migrations

Graph Configuration

• Deprecated: graph_generation
• Current: memory_policy

Use memory_policy for:

• graph mode (auto, manual)
• extraction constraints
• governance (acl, consent, risk)

User Identity

• Deprecated: user_id (internal)
• Current: external_user_id (application identity)

Recommended: pass your app-level ID as external_user_id.

Search Ranking Toggle

• Deprecated: rank_results
• Current: reranking_config where applicable

For most integrations, prioritize:

• better query quality
• enable_agentic_graph=true
• tuned max_memories / max_nodes

Legacy Relationship Fields

• Deprecated or legacy patterns: relationships_json-first workflows
• Current: model graph behavior via memory_policy and link_to where possible

Migration Checklist

1. Replace deprecated request fields in all write/search calls.
2. Add explicit tenant scope (organization_id, namespace_id) where needed.
3. Add explicit policy controls (memory_policy) for sensitive data.
4. Re-test retrieval with agentic graph enabled.
5. Update examples and SDK wrappers to emit only current fields.

Safe Baseline for New Integrations

{
  "external_user_id": "user_123",
  "memory_policy": {
    "mode": "auto",
    "consent": "implicit",
    "risk": "none"
  }
}

Then add manual mode and ACL specificity as your use case matures.

Validation Checklist

• Deprecated fields are removed from write and search payloads
• Current fields (external_user_id, memory_policy) are consistently used
• Integration tests pass using current schema contracts

Troubleshooting

If migration breaks existing behavior, compare payload diffs against Request Templates and validate with Error Playbook.