Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions content/docs/api/0-27-1/aiservice/Transcribe.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Transcribe
description: Transcribe transcribes an audio file using an instance AI provider.
_openapi:
method: POST
toc: []
structuredData:
headings: []
contents:
- content: Transcribe transcribes an audio file using an instance AI provider.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"./openapi/0-27-1.yaml"} operations={[{"path":"/api/v1/ai:transcribe","method":"post"}]} />
4 changes: 4 additions & 0 deletions content/docs/api/0-27-1/aiservice/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"title": "AI Service",
"pages": ["Transcribe"]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Batch Delete Attachments
description: BatchDeleteAttachments deletes multiple attachments in one request.
_openapi:
method: POST
toc: []
structuredData:
headings: []
contents:
- content: BatchDeleteAttachments deletes multiple attachments in one request.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"./openapi/0-27-1.yaml"} operations={[{"path":"/api/v1/attachments:batchDelete","method":"post"}]} />
15 changes: 15 additions & 0 deletions content/docs/api/0-27-1/attachmentservice/CreateAttachment.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Create Attachment
description: CreateAttachment creates a new attachment.
_openapi:
method: POST
toc: []
structuredData:
headings: []
contents:
- content: CreateAttachment creates a new attachment.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"./openapi/0-27-1.yaml"} operations={[{"path":"/api/v1/attachments","method":"post"}]} />
15 changes: 15 additions & 0 deletions content/docs/api/0-27-1/attachmentservice/DeleteAttachment.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Delete Attachment
description: DeleteAttachment deletes an attachment by name.
_openapi:
method: DELETE
toc: []
structuredData:
headings: []
contents:
- content: DeleteAttachment deletes an attachment by name.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"./openapi/0-27-1.yaml"} operations={[{"path":"/api/v1/attachments/{attachment}","method":"delete"}]} />
15 changes: 15 additions & 0 deletions content/docs/api/0-27-1/attachmentservice/GetAttachment.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Get Attachment
description: GetAttachment returns an attachment by name.
_openapi:
method: GET
toc: []
structuredData:
headings: []
contents:
- content: GetAttachment returns an attachment by name.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"./openapi/0-27-1.yaml"} operations={[{"path":"/api/v1/attachments/{attachment}","method":"get"}]} />
15 changes: 15 additions & 0 deletions content/docs/api/0-27-1/attachmentservice/ListAttachments.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: List Attachments
description: ListAttachments lists all attachments.
_openapi:
method: GET
toc: []
structuredData:
headings: []
contents:
- content: ListAttachments lists all attachments.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"./openapi/0-27-1.yaml"} operations={[{"path":"/api/v1/attachments","method":"get"}]} />
15 changes: 15 additions & 0 deletions content/docs/api/0-27-1/attachmentservice/UpdateAttachment.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Update Attachment
description: UpdateAttachment updates an attachment.
_openapi:
method: PATCH
toc: []
structuredData:
headings: []
contents:
- content: UpdateAttachment updates an attachment.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"./openapi/0-27-1.yaml"} operations={[{"path":"/api/v1/attachments/{attachment}","method":"patch"}]} />
4 changes: 4 additions & 0 deletions content/docs/api/0-27-1/attachmentservice/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"title": "Attachment Service",
"pages": ["BatchDeleteAttachments", "CreateAttachment", "DeleteAttachment", "GetAttachment", "ListAttachments", "UpdateAttachment"]
}
21 changes: 21 additions & 0 deletions content/docs/api/0-27-1/authservice/GetCurrentUser.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Get Current User
description: |-
GetCurrentUser returns the authenticated user's information.
Validates the access token and returns user details.
Similar to OIDC's /userinfo endpoint.
_openapi:
method: GET
toc: []
structuredData:
headings: []
contents:
- content: |-
GetCurrentUser returns the authenticated user's information.
Validates the access token and returns user details.
Similar to OIDC's /userinfo endpoint.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"./openapi/0-27-1.yaml"} operations={[{"path":"/api/v1/auth/me","method":"get"}]} />
21 changes: 21 additions & 0 deletions content/docs/api/0-27-1/authservice/RefreshToken.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Refresh Token
description: |-
RefreshToken exchanges a valid refresh token for a new access token.
The refresh token is read from the HttpOnly cookie.
Returns a new short-lived access token.
_openapi:
method: POST
toc: []
structuredData:
headings: []
contents:
- content: |-
RefreshToken exchanges a valid refresh token for a new access token.
The refresh token is read from the HttpOnly cookie.
Returns a new short-lived access token.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"./openapi/0-27-1.yaml"} operations={[{"path":"/api/v1/auth/refresh","method":"post"}]} />
21 changes: 21 additions & 0 deletions content/docs/api/0-27-1/authservice/SignIn.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Sign In
description: |-
SignIn authenticates a user with credentials and returns tokens.
On success, returns an access token and sets a refresh token cookie.
Supports password-based and SSO authentication methods.
_openapi:
method: POST
toc: []
structuredData:
headings: []
contents:
- content: |-
SignIn authenticates a user with credentials and returns tokens.
On success, returns an access token and sets a refresh token cookie.
Supports password-based and SSO authentication methods.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"./openapi/0-27-1.yaml"} operations={[{"path":"/api/v1/auth/signin","method":"post"}]} />
19 changes: 19 additions & 0 deletions content/docs/api/0-27-1/authservice/SignOut.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: Sign Out
description: |-
SignOut terminates the user's authentication.
Revokes the refresh token and clears the authentication cookie.
_openapi:
method: POST
toc: []
structuredData:
headings: []
contents:
- content: |-
SignOut terminates the user's authentication.
Revokes the refresh token and clears the authentication cookie.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"./openapi/0-27-1.yaml"} operations={[{"path":"/api/v1/auth/signout","method":"post"}]} />
4 changes: 4 additions & 0 deletions content/docs/api/0-27-1/authservice/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"title": "Auth Service",
"pages": ["GetCurrentUser", "RefreshToken", "SignIn", "SignOut"]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Create Identity Provider
description: CreateIdentityProvider creates an identity provider.
_openapi:
method: POST
toc: []
structuredData:
headings: []
contents:
- content: CreateIdentityProvider creates an identity provider.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"./openapi/0-27-1.yaml"} operations={[{"path":"/api/v1/identity-providers","method":"post"}]} />
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Delete Identity Provider
description: DeleteIdentityProvider deletes an identity provider.
_openapi:
method: DELETE
toc: []
structuredData:
headings: []
contents:
- content: DeleteIdentityProvider deletes an identity provider.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"./openapi/0-27-1.yaml"} operations={[{"path":"/api/v1/identity-providers/{identity-provider}","method":"delete"}]} />
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Get Identity Provider
description: GetIdentityProvider gets an identity provider.
_openapi:
method: GET
toc: []
structuredData:
headings: []
contents:
- content: GetIdentityProvider gets an identity provider.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"./openapi/0-27-1.yaml"} operations={[{"path":"/api/v1/identity-providers/{identity-provider}","method":"get"}]} />
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: List Identity Providers
description: ListIdentityProviders lists identity providers.
_openapi:
method: GET
toc: []
structuredData:
headings: []
contents:
- content: ListIdentityProviders lists identity providers.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"./openapi/0-27-1.yaml"} operations={[{"path":"/api/v1/identity-providers","method":"get"}]} />
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Update Identity Provider
description: UpdateIdentityProvider updates an identity provider.
_openapi:
method: PATCH
toc: []
structuredData:
headings: []
contents:
- content: UpdateIdentityProvider updates an identity provider.
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

<APIPage document={"./openapi/0-27-1.yaml"} operations={[{"path":"/api/v1/identity-providers/{identity-provider}","method":"patch"}]} />
4 changes: 4 additions & 0 deletions content/docs/api/0-27-1/identityproviderservice/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"title": "Identity Provider Service",
"pages": ["CreateIdentityProvider", "DeleteIdentityProvider", "GetIdentityProvider", "ListIdentityProviders", "UpdateIdentityProvider"]
}
85 changes: 85 additions & 0 deletions content/docs/api/0-27-1/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
---
title: API Reference
description: Memos API Reference (0.27.x)
---

## Overview

This reference matches the Memos `0.27.x` release.

## Base URL

The API is served at the `/api/v1` path of your Memos instance.

```bash
https://your-memos-instance.com/api/v1
```

For example, if your instance is hosted at `https://memos.example.com`, the API base URL would be:

```bash
https://memos.example.com/api/v1
```

## Authentication

The Memos API uses Bearer Token authentication. You can obtain an access token by creating one in your account settings.

Include the token in the `Authorization` header of your requests:

```bash
Authorization: Bearer <YOUR_ACCESS_TOKEN>
```

## Pagination

List operations support pagination using `pageSize` and `pageToken` parameters.

- `pageSize`: The maximum number of resources to return.
- `pageToken`: A token received from a previous list response to retrieve the next page.

## Filtering

Some list operations support filtering via the `filter` parameter. The filter syntax follows the [Google AIP-160](https://google.aip.dev/160) standard.

Example: `row_status == "NORMAL"`

## Field Masks

Update operations often require an `updateMask` parameter to specify which fields to update. This prevents accidental overwrites of other fields.

Example: `updateMask=content,visibility`

## Response Format

All responses are returned in JSON format. Errors are returned with a standard status object:

```json
{
"code": 3,
"message": "Invalid argument",
"details": []
}
```

## Example

Here is an example of how to list memos:

```bash
curl -X GET "https://your-memos-instance.com/api/v1/memos?pageSize=10" \
-H "Authorization: Bearer <YOUR_ACCESS_TOKEN>"
```

## Services

<Cards>
<Card title="AI Service" href="/docs/api/0-27-1/aiservice/Transcribe" />
<Card title="Attachment Service" href="/docs/api/0-27-1/attachmentservice/CreateAttachment" />
<Card title="Auth Service" href="/docs/api/0-27-1/authservice/SignIn" />
<Card title="Identity Provider Service" href="/docs/api/0-27-1/identityproviderservice/CreateIdentityProvider" />
<Card title="Instance Service" href="/docs/api/0-27-1/instanceservice/GetInstanceProfile" />
<Card title="Memo Service" href="/docs/api/0-27-1/memoservice/CreateMemo" />
<Card title="Shortcut Service" href="/docs/api/0-27-1/shortcutservice/CreateShortcut" />
<Card title="User Service" href="/docs/api/0-27-1/userservice/CreateUser" />
</Cards>
Loading
Loading