Skip to content

docs: add readme cloud api#144

Merged
sairin1202 merged 1 commit intomainfrom
docs/readme_cloud_api
Jan 5, 2026
Merged

docs: add readme cloud api#144
sairin1202 merged 1 commit intomainfrom
docs/readme_cloud_api

Conversation

@sairin1202
Copy link
Contributor

  • add cloud api to the readme
Copilot AI review requested due to automatic review settings January 5, 2026 10:34
@sairin1202 sairin1202 merged commit 42fd5ba into main Jan 5, 2026
7 checks passed
@sairin1202 sairin1202 deleted the docs/readme_cloud_api branch January 5, 2026 10:35
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds Cloud API (v3) documentation to the README, providing developers with quick reference information about the available API endpoints for the MemU cloud service. The version is also bumped from 0.8.0 to 0.9.0.

  • Added comprehensive Cloud API v3 documentation section with base URL, authentication, and endpoint details
  • Version bump from 0.8.0 to 0.9.0 in the lock file

Reviewed changes

Copilot reviewed 1 out of 2 changed files in this pull request and generated 1 comment.

File Description
README.md Added Cloud API (v3) documentation section with base URL, authentication details, and API endpoint reference table
uv.lock Updated package version from 0.8.0 to 0.9.0

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

|--------|----------|-------------|
| `POST` | `/api/v3/memory/memorize` | Register a memorization task |
| `GET` | `/api/v3/memory/memorize/status/{task_id}` | Get task status |
| `POST` | `/api/v3/memory/categories` | List memory categories |
Copy link

Copilot AI Jan 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The /api/v3/memory/categories endpoint is documented as using the POST method with the description "List memory categories". Typically, listing or retrieving resources uses the GET method, while POST is used for creating resources. Please verify that POST is the correct HTTP method for this endpoint, or consider changing it to GET if it's intended for read-only listing operations.

Suggested change
| `POST` | `/api/v3/memory/categories` | List memory categories |
| `GET` | `/api/v3/memory/categories` | List memory categories |
Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

2 participants