Replaces the snapshot with a client-compacted one and prunes covered updates.
Also used to re-encrypt the note under a rotated content key.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Note id
Request Bodyrequired
Section titled “Request Bodyrequired”Replaces the stored snapshot with a client-compacted one.
object
Base64 encrypted metadata digest that replaces the stored digest. Sent when the snapshot is re-encrypted under a rotated content key.
Base64 encrypted Yjs full-state update.
Highest change version incorporated into the snapshot.
Examplegenerated
{ "metadata": "example", "snapshot": "example", "snapshotVersion": 1}Responses
Section titled “Responses”Snapshot compacted
Server-assigned note coordinates after a mutation.
object
Examplegenerated
{ "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "seq": 1, "version": 1}Invalid request
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}No valid session token
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}Headers
Section titled “Headers”The Bearer challenge (RFC 6750).
Free storage full
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}View-only access
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}Note not found
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}SnapshotVersion out of range
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}Note or account storage full
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}The body is not JSON
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}Headers
Section titled “Headers”The media type the operation takes.
Too many requests
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}Headers
Section titled “Headers”Seconds to wait. Sent when the limit knows when it lifts.
The service failed
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}The service is at capacity
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}