ErrorResponse
The plain error envelope: a human-readable message for diagnostics, never for program decisions.
Shape
object
1 field
errorstringrequired
Other fields are allowed.
Used by
- GET
/Health check - POST
/auth/challengeRequest an auth challenge - POST
/auth/logoutDestroy the current session - POST
/auth/registerRegister an identity and bootstrap its root state - DELETE
/auth/sessions/{sessionId}Destroy a user session - GET
/auth/sessionsList auth sessions - GET
/auth/user-identity/{userId}Get a complete user identity - POST
/auth/verifyVerify an auth challenge - POST
/auth/ws-ticketMint a one-time WebSocket ticket - POST
/billing/revenuecat/webhookReceive a RevenueCat webhook - POST
/billing/stripe/webhookReceive a Stripe webhook - PUT
/blobs/stages/multipart/{stageId}/parts/{partNumber}/bytesUpload multipart blob part bytes through the API - POST
/blobs/stages/multipart/{stageId}/parts/{partNumber}/uploadAuthorize a direct multipart blob part upload - GET
/blobs/stages/multipart/{stageId}Get multipart blob stage status - POST
/blobs/stages/multipartInitiate a multipart blob stage - POST
/blobs/{blobId}/attachment-bindings/{bindingId}/detachDetach a blob attachment - POST
/blobs/{blobId}/attachment-bindingsBind or replace a blob attachment - GET
/blobs/{blobId}/bytesGet committed blob bytes - GET
/blobs/{blobId}/downloadGet a blob download source - POST
/containers/documents/queryList container documents by lane - POST
/containers/parent-lanes/queryList containers by parent lane - POST
/containers/with-metadata-documentCreate a container with its metadata document - GET
/containers/{containerId}/kek-logPage a container's KEK rotation log - POST
/containers/{containerId}/moveMove a container - POST
/containers/{containerId}/reciteRe-cite a held container's current ancestor path - POST
/containers/{containerId}/rekeyRekey a container - GET
/containers/{containerId}/replacement-authorizations/{replacesOrganizationId}Get a re-shared container's replacement lineage - POST
/containers/{containerId}/revokeRevoke a container grant - POST
/containers/{containerId}/shareShare a container - GET
/containers/{containerId}/writer-projectionGet a container writer projection - DELETE
/containers/{containerId}Delete a container - POST
/containersCreate a container - GET
/documents/{documentId}/attachmentsList active document attachments - GET
/documents/{documentId}/attribution/rangesList document attribution ranges - GET
/documents/{documentId}/attributionGet document edit attribution - POST
/documents/{documentId}/linkLink a document to a container - GET
/documents/{documentId}/purgeGet a document purge proof - POST
/documents/{documentId}/purgePurge a document - POST
/documents/{documentId}/syncSync encrypted Loro updates - POST
/documents/{documentId}/unlinkUnlink a document from a container - GET
/documents/{documentId}/writer-projectionGet a document writer projection - POST
/documentsCreate a document - DELETE
/organization-memberships/{organizationId}/leave-requestWithdraw a request to leave an organization - PUT
/organization-memberships/{organizationId}/leave-requestRequest to leave an organization - PUT
/organization-memberships/{organizationId}Update an organization membership - GET
/organization-membershipsList your organization memberships - GET
/organizations/{organizationId}/billing/historyGet organization billing history - GET
/organizations/{organizationId}/billing/management-urlGet the organization billing management URL - GET
/organizations/{organizationId}/billing/native/eligibilityGet native store purchase eligibility - POST
/organizations/{organizationId}/billing/native/{store}/claimClaim a native store subscription - POST
/organizations/{organizationId}/billing/stripe/cancelCancel the Stripe subscription - POST
/organizations/{organizationId}/billing/stripe/checkout-sessionCreate an embedded Stripe checkout session - POST
/organizations/{organizationId}/billing/stripe/checkoutCreate a Stripe checkout - GET
/organizations/{organizationId}/billing/stripe/optionsGet Stripe checkout options - POST
/organizations/{organizationId}/billing/stripe/portalCreate a Stripe customer portal session - POST
/organizations/{organizationId}/billing/trialStart an organization trial - GET
/organizations/{organizationId}/billingGet organization billing - GET
/organizations/{organizationId}/data-usageGet organization data usage - GET
/organizations/{organizationId}/groups/{groupId}/membersList organization group members - PUT
/organizations/{organizationId}/groups/{groupId}/policy-commitAdvance a group policy and its signed directory head - DELETE
/organizations/{organizationId}/groups/{groupId}Delete an organization group - POST
/organizations/{organizationId}/groupsCreate an organization group and advance its signed directory - GET
/organizations/{organizationId}/policy-historyPage organization policy history - PUT
/organizations/{organizationId}/profileUpdate the organization profile - GET
/organizations/{organizationId}/read-modelReconcile the organization read model - PUT
/organizations/{organizationId}/roster/{userId}Bind an encrypted roster profile document - POST
/organizationsCreate an organization - GET
/principals/historyPage projection policy history - GET
/principals/{principalType}/{principalId}/policyGet a principal policy bundle - PUT
/principals/{principalType}/{principalId}/policyUpdate a principal policy - GET
/root/audit-eventsPage recorded operator actions - GET
/root/identities/{userId}/organizationsList an identity's organizations - DELETE
/root/identities/{userId}/suspensionLift an identity suspension - PUT
/root/identities/{userId}/suspensionSuspend an identity - GET
/root/identities/{userId}Get an identity - GET
/root/identitiesList identities - GET
/root/organizations/{organizationId}/data-usageGet an organization's data usage - GET
/root/organizations/{organizationId}/identitiesList an organization's identities - GET
/root/organizations/{organizationId}/revenuecat-eventsPage an organization's RevenueCat deliveries - GET
/root/organizations/{organizationId}Get an organization - GET
/root/organizationsList organizations - GET
/root/reports/data-usagePage data usage by organization - GET
/root/reports/ops-healthReport billing maintenance trouble - GET
/root/reports/revenuecat-eventsPage unmatched or ignored RevenueCat deliveries