How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

xmemory API

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

xmemory API is one of 2 APIs that xmemory publishes on the 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.

This API exposes 29 operations across 25 paths, organized into 4 resource areas, and defines 43 schemas. It is described by OpenAPI 3.1.0, at version 2026-10-19.

Requests are made against a single base URL, https://api.xmemory.ai.

29 operations 25 paths 43 schemas 1 DELETE11 GET1 PATCH14 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2026-10-19
Base URL
https://api.xmemory.ai
Authentication
HTTP Bearer
Resource Areas
4

Authentication & Security 1

xmemory API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearer). By default, every request must be authenticated.

Paths & Operations 29

Across 25 paths, the API surfaces 29 operations — 1 DELETE, 11 GET, 1 PATCH, 14 POST, 2 PUT. They span 4 resource areas: Api, Clusters, Healthz, Instances. Each is listed below with its method, path, parameters, and response codes.

Api 1
POST
/
POST /
post body → 201
Clusters 5
GET
/clusters
List all clusters accessible to the authenticated user
get_clusters → 200
GET
/clusters/
List all clusters accessible to the authenticated user
get_clusters → 200
GET
/clusters/{clusterId}
Get a single cluster by ID
get_clusters_clusterId 1 param → 200
POST
/clusters/{clusterId}/instances
Create an instance from a generated schema
post_clusters_clusterId_instances 1 param body → 201
POST
/clusters/{clusterId}/instances/generate_schema
Generate an xmemory schema from a plain‑language description
post_clusters_clusterId_instances_generate_schema 1 param body → 201
Healthz 1
GET
/healthz
Returns 200 if the API is reachable (no authentication required)
get_healthz → 200
Instances 22
GET
/instances
List all instances accessible to the authenticated user
get_instances → 200
POST
/instances
POST /instances
post_instances → 201
GET
/instances/
List all instances accessible to the authenticated user
get_instances → 200
DELETE
/instances/{instanceId}
Delete an instance
delete_instances_instanceId 1 param → 200
GET
/instances/{instanceId}
Get a single instance by ID
get_instances_instanceId 1 param → 200
PATCH
/instances/{instanceId}
Update some instance metadata fields, leaving the rest alone
patch_instances_instanceId 1 param body → 200
PUT
/instances/{instanceId}
Update instance metadata (name and description)
put_instances_instanceId 1 param body → 200
GET
/instances/{instanceId}/agent_setup
How to connect this instance on an agent surface, most likely first
get_instances_instanceId_agent_setup 2 params → 200
GET
/instances/{instanceId}/describe
Return the agent‑facing tool descriptions for an instance, with its live schema in schemasummary
get_instances_instanceId_describe 1 param → 200
POST
/instances/{instanceId}/extract
Extract structured objects from text without storing them — preview what a write would produce
post_instances_instanceId_extract 1 param body → 201
GET
/instances/{instanceId}/migrations
List applied migrations, newest first
get_instances_instanceId_migrations 4 params → 200
POST
/instances/{instanceId}/migrations/dry_run
Preview a migration without applying it
post_instances_instanceId_migrations_dry_run 1 param body → 201
GET
/instances/{instanceId}/migrations/{migrationId}
Get a single migration record
get_instances_instanceId_migrations_migrationId 3 params → 200
POST
/instances/{instanceId}/pending-feedback/discard
Clear the pending schema‑improvement backlog for this instance
post_instances_instanceId_pending_feedback_discard 1 param → 201
POST
/instances/{instanceId}/read
Query the instance in natural language
post_instances_instanceId_read 1 param body → 201
PUT
/instances/{instanceId}/schema
Update the schema of an existing instance
put_instances_instanceId_schema 1 param body → 200
POST
/instances/{instanceId}/suggestions/apply
Commit accepted decisions as one migration
post_instances_instanceId_suggestions_apply 1 param body → 201
POST
/instances/{instanceId}/suggestions/decide
Record an accept / reject / defer per item in one batch
post_instances_instanceId_suggestions_decide 1 param body → 201
POST
/instances/{instanceId}/suggestions/review
Return the consolidated proposal and a proposalversion concurrency token
post_instances_instanceId_suggestions_review 1 param body → 201
POST
/instances/{instanceId}/write
Persist data — extract structured objects from text, or apply explicit structured mutations (blocks until committed)
post_instances_instanceId_write 1 param body → 201
POST
/instances/{instanceId}/write_async
Same write pipeline as write, but returns immediately instead of blocking
post_instances_instanceId_write_async 1 param body → 201
POST
/instances/{instanceId}/write_status
Check whether an async write has finished
post_instances_instanceId_write_status 1 param body → 201

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are PostInstancesInstanceidReadRequest (9 properties), GetInstancesInstanceidMigrationsMigrationidResponse (9 properties), GetInstancesInstanceidAgentSetupResponse (7 properties), PostInstancesInstanceidWriteRequest (7 properties). Each schema is shown below with its type and property counts.

PostRequest
object
2 properties
PostResponse
object
4 properties
GetClustersResponse
object
1 property
GetClustersResponse2
object
1 property
GetClustersClusteridResponse
object
4 properties
PostClustersClusteridInstancesRequest
object
5 properties 2 required
PostClustersClusteridInstancesResponse
object
5 properties
PostClustersClusteridInstancesGenerateSchemaRequest
object
2 properties 1 required
PostClustersClusteridInstancesGenerateSchemaResponse
object
5 properties
GetInstancesResponse
object
1 property
PostInstancesResponse
object
2 properties
GetInstancesResponse2
object
1 property
DeleteInstancesInstanceidResponse
object
1 property
GetInstancesInstanceidResponse
object
7 properties
PatchInstancesInstanceidRequest
object
6 properties
PatchInstancesInstanceidResponse
object
3 properties
PutInstancesInstanceidRequest
object
7 properties
PutInstancesInstanceidResponse
object
3 properties
GetInstancesInstanceidAgentSetupResponse
object
7 properties
GetInstancesInstanceidDescribeResponse
object
7 properties
PostInstancesInstanceidExtractRequest
object
4 properties 1 required
PostInstancesInstanceidExtractResponse
object
2 properties
GetInstancesInstanceidMigrationsResponse
object
3 properties
PostInstancesInstanceidMigrationsDryRunRequest
object
3 properties 1 required
PostInstancesInstanceidMigrationsDryRunResponse
object
7 properties
GetInstancesInstanceidMigrationsMigrationidResponse
object
9 properties
PostInstancesInstanceidPendingFeedbackDiscardResponse
object
3 properties
PostInstancesInstanceidReadRequest
object
9 properties 1 required
PostInstancesInstanceidReadResponse
object
5 properties
PutInstancesInstanceidSchemaRequest
object
3 properties 1 required
PutInstancesInstanceidSchemaResponse
object
4 properties
PostInstancesInstanceidSuggestionsApplyRequest
object
2 properties 1 required
PostInstancesInstanceidSuggestionsApplyResponse
object
6 properties
PostInstancesInstanceidSuggestionsDecideRequest
object
3 properties 2 required
PostInstancesInstanceidSuggestionsDecideResponse
object
2 properties
PostInstancesInstanceidSuggestionsReviewRequest
object
1 property
PostInstancesInstanceidSuggestionsReviewResponse
object
3 properties
PostInstancesInstanceidWriteRequest
object
7 properties
PostInstancesInstanceidWriteResponse
object
4 properties
PostInstancesInstanceidWriteAsyncRequest
object
7 properties
PostInstancesInstanceidWriteAsyncResponse
object
1 property
PostInstancesInstanceidWriteStatusRequest
object
1 property 1 required
PostInstancesInstanceidWriteStatusResponse
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xmemory-openapi-generated.yml Raw ↑

Other APIs xmemory publishes across the network.

xmemory API
Where this information came from

This is an independent, third-party profile of xmemory API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.