# xmemory API

**Canonical:** https://apis.io/apis/xmemory/xmemory-api/  
**Provider:** xmemory — https://apis.io/providers/xmemory/  
**Base URL:** https://api.xmemory.ai  
**Documentation:** https://xmemory.ai/api

xmemory API is one of 2 APIs that [xmemory](https://apis.io/providers/xmemory/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

xmemory API as documented publicly: 29 operations. Contract generated from the documentation by API Evangelist (2026-10-19); not the provider's own document.

## Operations (29)

| Method | Path | Summary |
|---|---|---|
| POST | `/` | POST / |
| GET | `/clusters` | List all clusters accessible to the authenticated user |
| GET | `/clusters/` | List all clusters accessible to the authenticated user |
| GET | `/clusters/{clusterId}` | Get a single cluster by ID |
| POST | `/clusters/{clusterId}/instances` | Create an instance from a generated schema |
| POST | `/clusters/{clusterId}/instances/generate_schema` | Generate an xmemory schema from a plain‑language description |
| GET | `/healthz` | Returns 200 if the API is reachable (no authentication required) |
| GET | `/instances` | List all instances accessible to the authenticated user |
| POST | `/instances` | POST /instances |
| GET | `/instances/` | List all instances accessible to the authenticated user |
| DELETE | `/instances/{instanceId}` | Delete an instance |
| GET | `/instances/{instanceId}` | Get a single instance by ID |
| PATCH | `/instances/{instanceId}` | Update some instance metadata fields, leaving the rest alone |
| PUT | `/instances/{instanceId}` | Update instance metadata (name and description) |
| GET | `/instances/{instanceId}/agent_setup` | How to connect this instance on an agent surface, most likely first |
| GET | `/instances/{instanceId}/describe` | Return the agent‑facing tool descriptions for an instance, with its live schema in schema_summary |
| POST | `/instances/{instanceId}/extract` | Extract structured objects from text without storing them — preview what a write would produce |
| GET | `/instances/{instanceId}/migrations` | List applied migrations, newest first |
| POST | `/instances/{instanceId}/migrations/dry_run` | Preview a migration without applying it |
| GET | `/instances/{instanceId}/migrations/{migrationId}` | Get a single migration record |
| POST | `/instances/{instanceId}/pending-feedback/discard` | Clear the pending schema‑improvement backlog for this instance |
| POST | `/instances/{instanceId}/read` | Query the instance in natural language |
| PUT | `/instances/{instanceId}/schema` | Update the schema of an existing instance |
| POST | `/instances/{instanceId}/suggestions/apply` | Commit accepted decisions as one migration |
| POST | `/instances/{instanceId}/suggestions/decide` | Record an accept / reject / defer per item in one batch |
| POST | `/instances/{instanceId}/suggestions/review` | Return the consolidated proposal and a proposal_version concurrency token |
| POST | `/instances/{instanceId}/write` | Persist data — extract structured objects from text, or apply explicit structured mutations (blocks until committed) |
| POST | `/instances/{instanceId}/write_async` | Same write pipeline as write, but returns immediately instead of blocking |
| POST | `/instances/{instanceId}/write_status` | Check whether an async write has finished |

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/xmemory/refs/heads/main/openapi/_ae-authored/xmemory-openapi-generated.yml
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/xmemory/refs/heads/main/json-schema/xmemory-post-instances-instanceid-write-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/xmemory/refs/heads/main/json-schema/xmemory-post-instances-instanceid-read-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/xmemory/refs/heads/main/json-schema/xmemory-post-instances-instanceid-write-async-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/xmemory/refs/heads/main/json-schema/xmemory-post-instances-instanceid-suggestions-apply-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/xmemory/refs/heads/main/json-schema/xmemory-post-instances-instanceid-read-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/xmemory/refs/heads/main/json-schema/xmemory-post-clusters-clusterid-instances-request-schema.json

## Other xmemory APIs (1)

- [xmemory API](https://apis.io/apis/xmemory/xmemory-api-2/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/xmemory/xmemory-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/xmemory/.