Delete a memory store
Deletes a memory store.
Deletes a memory store. A store an agent names is refused with RESOURCE_IN_USE; a store with memories is refused with INVALID_STATE unless force is set, which deletes them too.
- Path
DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/memory_stores/memory-store - Scope
agents:write - Effect
destructive— a successful call removes data; the CLI asks before it runs. - Collection memory_stores
- Query
etag,allow_missing,validate_only,force
Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the memory store to delete. Required. |
etag | string | Delete only if the current etag matches. |
allow_missing | bool | Succeed when the memory store does not exist. |
validate_only | bool | Validate without deleting anything. |
force | bool | Also delete the store's memories; without it, a store with memories is refused with INVALID_STATE. |
Response
The call answers with an empty object.
Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.INVALID_STATE— The Resource is in a state that forbids the call.ETAG_MISMATCH— The etag sent does not match the Resource's current etag.IDEMPOTENCY_KEY_REUSED— An Idempotency-Key was reused with another body.IDEMPOTENCY_IN_PROGRESS— The first call with this Idempotency-Key is still running.RESOURCE_IN_USE— The Resource is attached to or held by another Resource, for example a volume attached to a running lease.
Every error arrives in the body Errors describes.
Examples
curl -X DELETE "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/memory_stores/memory-store" \
-H "Authorization: Bearer $SYLPHX_API_KEY"