Status

Check transport and state

Read the HTTP status as well as this body. details entries can carry @type and retry information. Connect's error body has a different representation. Not every error is retryable, and a write error does not guarantee rollback after storage cleanup starts. See the common API calling conventions for retry guidance.

Where this schema is used

These links are derived from direct references in the protocol snapshot. Follow the calling operation for authentication, accepted fields and runtime behavior; a reusable resource schema is not by itself a complete write request.

• POSTTranscribe/api/v1/ai:transcribe
• GETList Attachments/api/v1/attachments
• POSTCreate Attachment/api/v1/attachments
• GETGet Attachment/api/v1/attachments/{attachment}
• DELETEDelete Attachment/api/v1/attachments/{attachment}
• PATCHUpdate Attachment/api/v1/attachments/{attachment}
• POSTBatch Delete Attachments/api/v1/attachments:batchDelete
• POSTUpload Attachment/api/v1/attachments:upload
• GETGet Current User/api/v1/auth/me
• POSTRefresh Token/api/v1/auth/refresh
• POSTSign In/api/v1/auth/signin
• POSTSign Out/api/v1/auth/signout
• GETList Identity Providers/api/v1/identity-providers
• POSTCreate Identity Provider/api/v1/identity-providers
• GETGet Identity Provider/api/v1/identity-providers/{identity-provider}
• DELETEDelete Identity Provider/api/v1/identity-providers/{identity-provider}
• PATCHUpdate Identity Provider/api/v1/identity-providers/{identity-provider}
• GETGet Instance Profile/api/v1/instance/profile
• POSTTest Instance Email Setting/api/v1/instance/settings/notification:testEmail
• POSTBatch Get Instance Settings/api/v1/instance/settings:batchGet
• GETGet Instance Stats/api/v1/instance/stats
• GETGet Instance Setting/api/v1/instance/settings/{key}
• PATCHUpdate Instance Setting/api/v1/instance/settings/{key}
• GETList Memos/api/v1/memos
• POSTCreate Memo/api/v1/memos
• GETGet Link Metadata/api/v1/memos/-/linkMetadata
• POSTBatch Get Link Metadata/api/v1/memos/-/linkMetadata:batchGet
• GETGet Memo/api/v1/memos/{memo}
• DELETEDelete Memo/api/v1/memos/{memo}
• PATCHUpdate Memo/api/v1/memos/{memo}
• GETList Memo Attachments/api/v1/memos/{memo}/attachments
• PATCHSet Memo Attachments/api/v1/memos/{memo}/attachments
• GETList Memo Comments/api/v1/memos/{memo}/comments
• POSTCreate Memo Comment/api/v1/memos/{memo}/comments
• GETList Memo Reactions/api/v1/memos/{memo}/reactions
• POSTUpsert Memo Reaction/api/v1/memos/{memo}/reactions
• DELETEDelete Memo Reaction/api/v1/memos/{memo}/reactions/{reaction}
• GETList Memo Relations/api/v1/memos/{memo}/relations
• PATCHSet Memo Relations/api/v1/memos/{memo}/relations
• GETList Memo Shares/api/v1/memos/{memo}/shares
• POSTCreate Memo Share/api/v1/memos/{memo}/shares
• DELETEDelete Memo Share/api/v1/memos/{memo}/shares/{share}
• GETGet Shared Memo/api/v1/shares/{shareToken}/memo
• GETList Spaces/api/v1/spaces
• POSTCreate Space/api/v1/spaces
• GETGet Space/api/v1/spaces/{space}
• DELETEDelete Space/api/v1/spaces/{space}
• PATCHUpdate Space/api/v1/spaces/{space}
• GETList Space Invitations/api/v1/spaces/{space}/invitations
• POSTCreate Space Invitation/api/v1/spaces/{space}/invitations
• GETGet Space Invitation/api/v1/spaces/{space}/invitations/{invitation}
• DELETEDelete Space Invitation/api/v1/spaces/{space}/invitations/{invitation}
• POSTAccept Space Invitation/api/v1/spaces/{space}/invitations/{invitation}:accept
• POSTDecline Space Invitation/api/v1/spaces/{space}/invitations/{invitation}:decline
• GETList Space Members/api/v1/spaces/{space}/members
• GETGet Space Member/api/v1/spaces/{space}/members/{member}
• DELETEDelete Space Member/api/v1/spaces/{space}/members/{member}
• PATCHUpdate Space Member/api/v1/spaces/{space}/members/{member}
• GETList Users/api/v1/users
• POSTCreate User/api/v1/users
• GETGet User/api/v1/users/{user}
• DELETEDelete User/api/v1/users/{user}
• PATCHUpdate User/api/v1/users/{user}
• GETList Linked Identities/api/v1/users/{user}/linkedIdentities
• POSTCreate Linked Identity/api/v1/users/{user}/linkedIdentities
• GETGet Linked Identity/api/v1/users/{user}/linkedIdentities/{linkedIdentity}
• DELETEDelete Linked Identity/api/v1/users/{user}/linkedIdentities/{linkedIdentity}
• GETList User Notifications/api/v1/users/{user}/notifications
• DELETEDelete User Notification/api/v1/users/{user}/notifications/{notification}
• PATCHUpdate User Notification/api/v1/users/{user}/notifications/{notification}
• GETList Personal Access Tokens/api/v1/users/{user}/personalAccessTokens
• POSTCreate Personal Access Token/api/v1/users/{user}/personalAccessTokens
• DELETEDelete Personal Access Token/api/v1/users/{user}/personalAccessTokens/{personalAccessToken}
• GETList User Settings/api/v1/users/{user}/settings
• GETGet User Setting/api/v1/users/{user}/settings/{setting}
• PATCHUpdate User Setting/api/v1/users/{user}/settings/{setting}
• GETList User Space Invitations/api/v1/users/{user}/spaceInvitations
• GETList Memo Views/api/v1/users/{user}/views
• POSTCreate Memo View/api/v1/users/{user}/views
• GETGet Memo View/api/v1/users/{user}/views/{view}
• DELETEDelete Memo View/api/v1/users/{user}/views/{view}
• PATCHUpdate Memo View/api/v1/users/{user}/views/{view}
• GETList User Webhooks/api/v1/users/{user}/webhooks
• POSTCreate User Webhook/api/v1/users/{user}/webhooks
• DELETEDelete User Webhook/api/v1/users/{user}/webhooks/{webhook}
• PATCHUpdate User Webhook/api/v1/users/{user}/webhooks/{webhook}
• GETGet User Webhook Signing Secret/api/v1/users/{user}/webhooks/{webhook}:getSigningSecret
• GETExport Memos/api/v1/users/{user}:exportMemos
• GETGet User Stats/api/v1/users/{user}:getStats
• POSTImport Memos/api/v1/users/{user}:importMemos
• POSTBatch Get Users/api/v1/users:batchGet
• GETList All User Stats/api/v1/users:stats

Shape and fields

object

The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).

Complete schema

Use this complete JSON definition for constraints and nested structure. A field's presence here does not mean it is writable by every caller.

{
  "type": "object",
  "properties": {
    "code": {
      "type": "integer",
      "description": "The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].",
      "format": "int32"
    },
    "message": {
      "type": "string",
      "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client."
    },
    "details": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/GoogleProtobufAny"
      },
      "description": "A list of messages that carry the error details.  There is a common set of message types for APIs to use."
    }
  },
  "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors)."
}