Memos API
  1. ResourceService
Memos API
  • AuthService
    • SignIn signs in the user with the given username and password.
      POST
    • SignInWithSSO signs in the user with the given SSO code.
      POST
    • SignOut signs out the user.
      POST
    • SignUp signs up the user with the given username and password.
      POST
    • GetAuthStatus returns the current auth status of the user.
      POST
  • IdentityProviderService
    • ListIdentityProviders lists identity providers.
      GET
    • CreateIdentityProvider creates an identity provider.
      POST
    • UpdateIdentityProvider updates an identity provider.
      PATCH
    • DeleteIdentityProvider deletes an identity provider.
      DELETE
    • GetIdentityProvider gets an identity provider.
      GET
  • InboxService
    • ListInboxes lists inboxes for a user.
      GET
    • UpdateInbox updates an inbox.
      PATCH
    • DeleteInbox deletes an inbox.
      DELETE
  • MarkdownService
    • GetLinkMetadata returns metadata for a given link.
      GET
    • RestoreMarkdownNodes restores the given nodes to markdown content.
      POST
    • StringifyMarkdownNodes stringify the given nodes to plain text content.
      POST
    • ParseMarkdown parses the given markdown content and returns a list of nodes.
      POST
  • MemoService
    • ListMemos lists memos with pagination and filter.
      GET
    • CreateMemo creates a memo.
      POST
    • DeleteMemoReaction deletes a reaction for a memo.
      DELETE
    • UpdateMemo updates a memo.
      PATCH
    • GetMemo gets a memo.
      GET
    • DeleteMemo deletes a memo.
      DELETE
    • ListMemoComments lists comments for a memo.
      GET
    • CreateMemoComment creates a comment for a memo.
      POST
    • ListMemoReactions lists reactions for a memo.
      GET
    • UpsertMemoReaction upserts a reaction for a memo.
      POST
    • ListMemoRelations lists relations for a memo.
      GET
    • SetMemoRelations sets relations for a memo.
      PATCH
    • ListMemoResources lists resources for a memo.
      GET
    • SetMemoResources sets resources for a memo.
      PATCH
    • ListMemos lists memos with pagination and filter.
      GET
    • DeleteMemoTag deletes a tag for a memo.
      DELETE
    • RenameMemoTag renames a tag for a memo.
      PATCH
  • ResourceService
    • ListResources lists all resources.
      GET
    • CreateResource creates a new resource.
      POST
    • GetResource returns a resource by name.
      GET
    • DeleteResource deletes a resource by name.
      DELETE
    • UpdateResource updates a resource.
      PATCH
    • GetResourceBinary returns a resource binary by name.
      GET
  • UserService
    • ListUsers returns a list of users.
    • CreateUser creates a new user.
    • ListAllUserStats returns all user stats.
    • GetUserByUsername gets a user by username.
    • GetUser gets a user by name.
    • DeleteUser deletes a user.
    • ListUserAccessTokens returns a list of access tokens for a user.
    • CreateUserAccessToken creates a new access token for a user.
    • DeleteUserAccessToken deletes an access token for a user.
    • GetUserSetting gets the setting of a user.
    • GetUserStats returns the stats of a user.
    • ListShortcuts returns a list of shortcuts for a user.
    • CreateShortcut creates a new shortcut for a user.
    • DeleteShortcut deletes a shortcut for a user.
    • UpdateShortcut updates a shortcut for a user.
    • UpdateUserSetting updates the setting of a user.
    • UpdateUser updates a user.
    • GetUserAvatarBinary gets the avatar of a user.
  • WebhookService
    • ListWebhooks returns a list of webhooks.
    • CreateWebhook creates a new webhook.
    • GetWebhook returns a webhook by id.
    • DeleteWebhook deletes a webhook by id.
    • UpdateWebhook updates a webhook.
  • WorkspaceService
    • GetWorkspaceProfile returns the workspace profile.
  • WorkspaceSettingService
    • GetWorkspaceSetting returns the setting by name.
    • SetWorkspaceSetting updates the setting.
  • ActivityService
    • GetActivity returns the activity with the given id.
  1. ResourceService

GetResourceBinary returns a resource binary by name.

GET
/file/{name}/{filename}

请求参数

Path 参数
name
string 
必需
The name of the resource.
正则匹配:
resources/[^/]+
filename
string 
必需
The filename of the resource. Mainly used for downloading.
Query 参数
thumbnail
boolean 
可选
A flag indicating if the thumbnail version of the resource should be returned

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET '/file//'

返回响应

🟢200成功
application/json
A successful response.
Body
Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page.
contentType
string 
可选
The HTTP Content-Type header value specifying the content type of the body.
data
string <byte>
可选
The HTTP request/response body as raw binary.
extensions
array[object (protobufAny) {2}] 
可选
Application specific response metadata. Must be set in the first response
for streaming APIs.
@type
string 
可选
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http, https, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
If no scheme is provided, https is assumed.
An HTTP GET on the URL must yield a [google.protobuf.Type][]
value in binary format, or produce an error.
Applications are allowed to cache lookup results based on the
URL, or have them precompiled into a binary to avoid any
lookup. Therefore, binary compatibility needs to be preserved
on changes to types. (Use versioned type names to manage
breaking changes.)
Note: this functionality is not currently available in the official
protobuf release, and it is not used for type URLs beginning with
type.googleapis.com. As of May 2023, there are no widely used type server
implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be
used with implementation specific semantics.
额外字段
integer  | number  | string  | boolean 
可选
示例
{
    "contentType": "string",
    "data": "string",
    "extensions": [
        {
            "@type": "string",
            "property1": null,
            "property2": null
        }
    ]
}
🔴500服务器错误
修改于 2025-03-15 17:43:05
上一页
UpdateResource updates a resource.
下一页
ListUsers returns a list of users.
Built with