> ## Documentation Index
> Fetch the complete documentation index at: https://docs.evermind.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# EverOS Migration Tool

> Move your EverOS Cloud integration from the v1 API to v2 with a report first and one command after: Python SDK and raw HTTP callers in any language.

<Info>
  **Updated:** September 2026, now covering the v1 to v2 API migration
</Info>

<Warning>
  **The v1 API retires soon.** See [v1 API Retirement](/api-reference/v1-sunset) for what
  happens to your data and how to get help.
</Warning>

## Overview

The `everos-sdk-upgrade` plugin moves an EverOS Cloud integration from the v1 API to v2.
It runs inside your AI coding assistant, reads your code, reports what would change, and
then applies the mechanical parts while marking in place anything that has no v2
equivalent.

* **Plugin name:** `everos-sdk-upgrade`
* **Repository:** [https://github.com/EverMind-AI/everos-tools](https://github.com/EverMind-AI/everos-tools)
* **Covers:** the `everos-cloud` Python SDK (0.4.x to 1.x) and raw HTTP callers in any
  language (TypeScript, Go, shell scripts, `.http` files, Postman collections). The older
  `evermemos` to `everos-cloud` hop is still included.
* **Report first:** `--scan` produces an impact report and edits nothing. The report
  contains no source code and no credentials, so you can send it to us as it is.
* **Cross-platform:** Follows the [Agent Skills open standard](https://agentskills.io).
  Verified on Claude Code, Codex CLI and Cursor.

## Installation

<Tabs>
  <Tab title="Claude Code">
    Inside a Claude Code session, add the EverMind plugin marketplace and install the tool:

    ```bash theme={null}
    /plugin marketplace add EverMind-AI/everos-tools
    /plugin install everos-sdk-upgrade@everos-tools
    ```

    The same two steps from a terminal, if you prefer:

    ```bash theme={null}
    claude plugin marketplace add EverMind-AI/everos-tools
    claude plugin install everos-sdk-upgrade@everos-tools
    ```

    Get the report first. This edits nothing:

    ```bash theme={null}
    /everos-sdk-upgrade --scan
    ```

    Then run the migration. If it finds anything with no v2 equivalent it stops and asks
    before editing; `--yes` proceeds with those places marked:

    ```bash theme={null}
    /everos-sdk-upgrade
    /everos-sdk-upgrade --yes
    ```

    <Note>
      This repository used to be called `everos-plugins`. If you added the marketplace under
      that name, remove it and add it again so that updates keep coming from the right place:

      ```bash theme={null}
      /plugin marketplace remove everos-plugins
      /plugin marketplace add EverMind-AI/everos-tools
      /plugin install everos-sdk-upgrade@everos-tools
      ```
    </Note>
  </Tab>

  <Tab title="Codex, Cursor and others">
    The tool follows the [Agent Skills](https://agentskills.io) standard, so any assistant
    that reads `.agents/skills/` can run it. Verified on Codex CLI and Cursor.

    From your project directory:

    ```bash theme={null}
    npx skills add https://github.com/EverMind-AI/everos-tools
    ```

    This places the skill at `.agents/skills/everos-sdk-upgrade/` and writes
    `skills-lock.json`. Commit both, or add them to `.gitignore`.

    Then ask your assistant, in its own chat:

    ```text theme={null}
    Run the everos-sdk-upgrade skill in --scan mode on this repository.
    ```

    To migrate, ask the same without `--scan`. To proceed past anything that has no v2
    equivalent with those places marked, add "proceed with every blocker flagged".
  </Tab>
</Tabs>

## What the report tells you

It opens with three lines: whether your code can move to v2, how many changes the tool makes
for you, and how many decisions are yours. Then, by file and line:

| Section | What it means for you |
| - | - |
| Blockers | Places with no v2 equivalent (group memory, the sender registry, memory-space settings, the async client, deleting one memory by id). The tool marks them in place and tells you who resolves each: you, us, or a product decision. |
| Needs a decision | Places where two correct answers exist, such as which agent memory type a search wants, or a base URL that must now be passed explicitly. |
| Mechanical | Everything the tool rewrites for you. |
| Before you ship | Data does not carry over between v1 and v2, your API key does not change, and the test run is yours to do. |

## What gets migrated

| Category | What changes |
| - | - |
| Endpoints | `/api/v1/memories/*` becomes `/api/v2/memory/*`; removed endpoints are marked, not rewritten |
| Client construction | `base_url` becomes `host`; the API key must be passed explicitly |
| Write calls | The user id moves onto each message as `sender_id`; `session_id` is required |
| Timestamps | Seconds become milliseconds, in code and in fixtures |
| Read calls | `filters` becomes `user_id` or `agent_id`; `episodic_memory` becomes `episode` |
| Responses | One `.data` level less in the SDK; `raw_messages` becomes `unprocessed_messages` |
| Task polling | The task id now comes from the response envelope |
| Errors | The exception hierarchy collapses to `EverOSAPIError` with a status code |
| Test doubles and fixtures | Fakes, recorded responses and Postman collections move with the code |
| Package dependency | `everos-cloud>=1.1.0`, changed last so a half-finished run is never mistaken for a finished one |

## What the tool does not do

* It does not run your test suite and it does not install the new package. Do both
  yourself, against a non-production key, before you switch traffic.
* It does not move your data. v1 and v2 hold separate stores until we migrate it for you.
* It does not decide for you where v2 has no equivalent. Those places are marked and
  listed; the report says who resolves each.

## Roadmap

When new SDK versions are released, updated migration rules will be published with a new version number. To get the latest rules, run:

```bash theme={null}
/plugin marketplace update
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.