openapi: 3.1.0 info: version: 2025.4.1-io.12b-fb6fbea074 title: Misskey account API servers: - url: https://misskey.io/api tags: - name: account paths: /blocking/create: post: operationId: post___blocking___create summary: blocking/create description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:blocks*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/blocking/create.ts tags: - account security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: userId: type: string format: misskey:id required: - userId responses: '200': description: OK (with results) content: application/json: schema: type: object $ref: '#/components/schemas/UserDetailedNotMe' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_USER: value: error: message: No such user. code: NO_SUCH_USER id: 7cc4f851-e2f1-4621-9633-ec9e1d00c01e BLOCKEE_IS_YOURSELF: value: error: message: Blockee is yourself. code: BLOCKEE_IS_YOURSELF id: 88b19138-f28d-42c0-8499-6a31bbd0fdc6 ALREADY_BLOCKING: value: error: message: You are already blocking that user. code: ALREADY_BLOCKING id: 787fed64-acb9-464a-82eb-afbd745b9614 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/Error' examples: RATE_LIMIT_EXCEEDED: value: error: message: Rate limit exceeded. Please try again later. code: RATE_LIMIT_EXCEEDED id: d5826d14-3982-4d2e-8011-b9e9f02499ef '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /blocking/delete: post: operationId: post___blocking___delete summary: blocking/delete description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:blocks*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/blocking/delete.ts tags: - account security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: userId: type: string format: misskey:id required: - userId responses: '200': description: OK (with results) content: application/json: schema: type: object $ref: '#/components/schemas/UserDetailedNotMe' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_USER: value: error: message: No such user. code: NO_SUCH_USER id: 8621d8bf-c358-4303-a066-5ea78610eb3f BLOCKEE_IS_YOURSELF: value: error: message: Blockee is yourself. code: BLOCKEE_IS_YOURSELF id: 06f6fac6-524b-473c-a354-e97a40ae6eac NOT_BLOCKING: value: error: message: You are not blocking that user. code: NOT_BLOCKING id: 291b2efa-60c6-45c0-9f6a-045c8f9b02cd INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/Error' examples: RATE_LIMIT_EXCEEDED: value: error: message: Rate limit exceeded. Please try again later. code: RATE_LIMIT_EXCEEDED id: d5826d14-3982-4d2e-8011-b9e9f02499ef '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /blocking/list: post: operationId: post___blocking___list summary: blocking/list description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:blocks*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/blocking/list.ts tags: - account security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 30 sinceId: type: string format: misskey:id untilId: type: string format: misskey:id responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object $ref: '#/components/schemas/Blocking' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /clips/add-note: post: operationId: post___clips___add-note summary: clips/add-note description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:account*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/clips/add-note.ts tags: - account security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: clipId: type: string format: misskey:id noteId: type: string format: misskey:id required: - clipId - noteId responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_CLIP: value: error: message: No such clip. code: NO_SUCH_CLIP id: d6e76cc0-a1b5-4c7c-a287-73fa9c716dcf NO_SUCH_NOTE: value: error: message: No such note. code: NO_SUCH_NOTE id: fc8c0b49-c7a3-4664-a0a6-b418d386bb8b ALREADY_CLIPPED: value: error: message: The note has already been clipped. code: ALREADY_CLIPPED id: 734806c4-542c-463a-9311-15c512803965 TOO_MANY_CLIP_NOTES: value: error: message: You cannot add notes to the clip any more. code: TOO_MANY_CLIP_NOTES id: f0dba960-ff73-4615-8df4-d6ac5d9dc118 CLIP_LIMIT_EXCEEDED: value: error: message: You cannot add a note to the clip because you have exceeded the limit of clips. code: CLIP_LIMIT_EXCEEDED id: 456cd06d-9f5b-4793-8108-dffe6e257d98 CLIP_NOTES_LIMIT_EXCEEDED: value: error: message: You cannot add a note to the clip because you have exceeded the limit of notes in other clips. code: CLIP_NOTES_LIMIT_EXCEEDED id: f3d6de24-ad27-418d-9d13-b50165dbce66 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/Error' examples: RATE_LIMIT_EXCEEDED: value: error: message: Rate limit exceeded. Please try again later. code: RATE_LIMIT_EXCEEDED id: d5826d14-3982-4d2e-8011-b9e9f02499ef '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /clips/my-favorites: post: operationId: post___clips___my-favorites summary: clips/my-favorites description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:clip-favorite*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/clips/my-favorites.ts tags: - account security: - bearerAuth: [] responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object $ref: '#/components/schemas/Clip' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /clips/notes: post: operationId: post___clips___notes summary: clips/notes description: 'No description provided. **Credential required**: *No* / **Permission**: *read:account*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/clips/notes.ts tags: - account requestBody: required: true content: application/json: schema: type: object properties: clipId: type: string format: misskey:id limit: type: integer minimum: 1 maximum: 100 default: 10 sinceId: type: string format: misskey:id untilId: type: string format: misskey:id required: - clipId responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object $ref: '#/components/schemas/Note' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_CLIP: value: error: message: No such clip. code: NO_SUCH_CLIP id: 1d7645e6-2b6d-4635-b0fe-fe22b0e72e00 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /clips/remove-note: post: operationId: post___clips___remove-note summary: clips/remove-note description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:account*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/clips/remove-note.ts tags: - account security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: clipId: type: string format: misskey:id noteId: type: string format: misskey:id required: - clipId - noteId responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_CLIP: value: error: message: No such clip. code: NO_SUCH_CLIP id: b80525c6-97f7-49d7-a42d-ebccd49cfd52 NO_SUCH_NOTE: value: error: message: No such note. code: NO_SUCH_NOTE id: aff017de-190e-434b-893e-33a9ff5049d8 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /flash/my: post: operationId: post___flash___my summary: flash/my description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:flash*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/flash/my.ts tags: - account security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 10 sinceId: type: string format: misskey:id untilId: type: string format: misskey:id responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object $ref: '#/components/schemas/Flash' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /flash/my-likes: post: operationId: post___flash___my-likes summary: flash/my-likes description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:flash-likes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/flash/my-likes.ts tags: - account security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 10 sinceId: type: string format: misskey:id untilId: type: string format: misskey:id responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object properties: id: type: string format: id flash: type: object $ref: '#/components/schemas/Flash' required: - id - flash '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /i: post: operationId: post___i summary: i description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:account*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i.ts tags: - account security: - bearerAuth: [] responses: '200': description: OK (with results) content: application/json: schema: type: object $ref: '#/components/schemas/MeDetailed' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: USER_IS_DELETED: value: error: message: User is deleted. code: USER_IS_DELETED id: e5b3b9f0-2b8f-4b9f-9c1f-8c5c1b2e1b1a kind: permission INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /i/favorites: post: operationId: post___i___favorites summary: i/favorites description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:favorites*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/favorites.ts tags: - account security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 10 sinceId: type: string format: misskey:id untilId: type: string format: misskey:id responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object $ref: '#/components/schemas/NoteFavorite' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /i/gallery/likes: post: operationId: post___i___gallery___likes summary: i/gallery/likes description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:gallery-likes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/gallery/likes.ts tags: - account security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 10 sinceId: type: string format: misskey:id untilId: type: string format: misskey:id responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object properties: id: type: string format: id post: type: object $ref: '#/components/schemas/GalleryPost' required: - id - post '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /i/gallery/posts: post: operationId: post___i___gallery___posts summary: i/gallery/posts description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:gallery*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/gallery/posts.ts tags: - account security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 10 sinceId: type: string format: misskey:id untilId: type: string format: misskey:id responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object $ref: '#/components/schemas/GalleryPost' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /i/notifications: post: operationId: post___i___notifications summary: i/notifications description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:notifications*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/notifications.ts tags: - account security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 10 sinceId: type: string format: misskey:id untilId: type: string format: misskey:id markAsRead: type: boolean default: true includeTypes: type: array items: type: string enum: - note - follow - mention - reply - renote - quote - reaction - pollEnded - receiveFollowRequest - followRequestAccepted - roleAssigned - chatRoomInvitationReceived - achievementEarned - exportCompleted - login - noteScheduled - scheduledNotePosted - scheduledNoteError - sensitiveFlagAssigned - createToken - app - test - pollVote - groupInvited excludeTypes: type: array items: type: string enum: - note - follow - mention - reply - renote - quote - reaction - pollEnded - receiveFollowRequest - followRequestAccepted - roleAssigned - chatRoomInvitationReceived - achievementEarned - exportCompleted - login - noteScheduled - scheduledNotePosted - scheduledNoteError - sensitiveFlagAssigned - createToken - app - test - pollVote - groupInvited responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object $ref: '#/components/schemas/Notification' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/Error' examples: RATE_LIMIT_EXCEEDED: value: error: message: Rate limit exceeded. Please try again later. code: RATE_LIMIT_EXCEEDED id: d5826d14-3982-4d2e-8011-b9e9f02499ef '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /i/notifications-grouped: post: operationId: post___i___notifications-grouped summary: i/notifications-grouped description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:notifications*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/notifications-grouped.ts tags: - account security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 10 sinceId: type: string format: misskey:id untilId: type: string format: misskey:id markAsRead: type: boolean default: true includeTypes: type: array items: type: string enum: - note - follow - mention - reply - renote - quote - reaction - pollEnded - receiveFollowRequest - followRequestAccepted - roleAssigned - chatRoomInvitationReceived - achievementEarned - exportCompleted - login - noteScheduled - scheduledNotePosted - scheduledNoteError - sensitiveFlagAssigned - createToken - app - test - pollVote - groupInvited excludeTypes: type: array items: type: string enum: - note - follow - mention - reply - renote - quote - reaction - pollEnded - receiveFollowRequest - followRequestAccepted - roleAssigned - chatRoomInvitationReceived - achievementEarned - exportCompleted - login - noteScheduled - scheduledNotePosted - scheduledNoteError - sensitiveFlagAssigned - createToken - app - test - pollVote - groupInvited responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object $ref: '#/components/schemas/Notification' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/Error' examples: RATE_LIMIT_EXCEEDED: value: error: message: Rate limit exceeded. Please try again later. code: RATE_LIMIT_EXCEEDED id: d5826d14-3982-4d2e-8011-b9e9f02499ef '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /i/page-likes: post: operationId: post___i___page-likes summary: i/page-likes description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:page-likes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/page-likes.ts tags: - account security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 10 sinceId: type: string format: misskey:id untilId: type: string format: misskey:id responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object properties: id: type: string format: id page: type: object $ref: '#/components/schemas/Page' required: - id - page '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /i/pages: post: operationId: post___i___pages summary: i/pages description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:pages*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/pages.ts tags: - account security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 10 sinceId: type: string format: misskey:id untilId: type: string format: misskey:id responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object $ref: '#/components/schemas/Page' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /i/pin: post: operationId: post___i___pin summary: i/pin description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:account*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/pin.ts tags: - account security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: noteId: type: string format: misskey:id required: - noteId responses: '200': description: OK (with results) content: application/json: schema: type: object $ref: '#/components/schemas/MeDetailed' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_NOTE: value: error: message: No such note. code: NO_SUCH_NOTE id: 56734f8b-3928-431e-bf80-6ff87df40cb3 PIN_LIMIT_EXCEEDED: value: error: message: You can not pin notes any more. code: PIN_LIMIT_EXCEEDED id: 72dab508-c64d-498f-8740-a8eec1ba385a ALREADY_PINNED: value: error: message: That note has already been pinned. code: ALREADY_PINNED id: 8b18c2b7-68fe-4edb-9892-c0cbaeb6c913 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /i/purge-timeline-cache: post: operationId: post___i___purge-timeline-cache summary: i/purge-timeline-cache description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:account*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/purge-timeline-cache.ts tags: - account security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: type: type: string enum: - home - user - list - antenna listId: type: - string - 'null' format: misskey:id antennaId: type: - string - 'null' format: misskey:id required: - type responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_LIST: value: error: message: No such list. code: NO_SUCH_LIST id: 6a40c9e2-5dbd-42f5-91e3-85d5c4da8f3e NO_SUCH_ANTENNA: value: error: message: No such antenna. code: NO_SUCH_ANTENNA id: dc0b9d49-f11a-4680-8ad8-22f032cc91f8 TARGET_ID_REQUIRED: value: error: message: Target id is required. code: TARGET_ID_REQUIRED id: ed670b97-8c0e-42c6-84db-5f5d9fb2a6d6 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /i/read-announcement: post: operationId: post___i___read-announcement summary: i/read-announcement description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:account*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/read-announcement.ts tags: - account security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: announcementId: type: string format: misskey:id required: - announcementId responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /i/unpin: post: operationId: post___i___unpin summary: i/unpin description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:account*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/unpin.ts tags: - account security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: noteId: type: string format: misskey:id required: - noteId responses: '200': description: OK (with results) content: application/json: schema: type: object $ref: '#/components/schemas/MeDetailed' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_NOTE: value: error: message: No such note. code: NO_SUCH_NOTE id: 454170ce-9d63-4a43-9da1-ea10afe81e21 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /i/update: post: operationId: post___i___update summary: i/update description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:account*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/update.ts tags: - account security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: name: type: - string - 'null' minLength: 1 maxLength: 50 description: type: - string - 'null' minLength: 1 maxLength: 1500 followedMessage: type: - string - 'null' minLength: 1 maxLength: 256 location: type: - string - 'null' minLength: 1 maxLength: 50 birthday: type: - string - 'null' pattern: ^([0-9]{4})-([0-9]{2})-([0-9]{2})$ lang: type: - string - 'null' enum: - null - ach - ady - af - af-NA - af-ZA - ak - ar - ar-AR - ar-MA - ar-SA - ay-BO - az - az-AZ - be-BY - bg - bg-BG - bn - bn-IN - bn-BD - br - bs-BA - ca - ca-ES - cak - ck-US - cs - cs-CZ - cy - cy-GB - da - da-DK - de - de-AT - de-DE - de-CH - dsb - el - el-GR - en - en-GB - en-AU - en-CA - en-IE - en-IN - en-PI - en-SG - en-UD - en-US - en-ZA - en@pirate - eo - eo-EO - es - es-AR - es-419 - es-CL - es-CO - es-EC - es-ES - es-LA - es-NI - es-MX - es-US - es-VE - et - et-EE - eu - eu-ES - fa - fa-IR - fb-LT - ff - fi - fi-FI - fo - fo-FO - fr - fr-CA - fr-FR - fr-BE - fr-CH - fy-NL - ga - ga-IE - gd - gl - gl-ES - gn-PY - gu-IN - gv - gx-GR - he - he-IL - hi - hi-IN - hr - hr-HR - hsb - ht - hu - hu-HU - hy - hy-AM - id - id-ID - is - is-IS - it - it-IT - ja - ja-JP - jv-ID - ka-GE - kk-KZ - km - kl - km-KH - kab - kn - kn-IN - ko - ko-KR - ku-TR - kw - la - la-VA - lb - li-NL - lt - lt-LT - lv - lv-LV - mai - mg-MG - mk - mk-MK - ml - ml-IN - mn-MN - mr - mr-IN - ms - ms-MY - mt - mt-MT - my - 'no' - nb - nb-NO - ne - ne-NP - nl - nl-BE - nl-NL - nn-NO - oc - or-IN - pa - pa-IN - pl - pl-PL - ps-AF - pt - pt-BR - pt-PT - qu-PE - rm-CH - ro - ro-RO - ru - ru-RU - sa-IN - se-NO - sh - si-LK - sk - sk-SK - sl - sl-SI - so-SO - sq - sq-AL - sr - sr-RS - su - sv - sv-SE - sw - sw-KE - ta - ta-IN - te - te-IN - tg - tg-TJ - th - th-TH - fil - tlh - tr - tr-TR - tt-RU - uk - uk-UA - ur - ur-PK - uz - uz-UZ - vi - vi-VN - xh-ZA - yi - yi-DE - zh - zh-Hans - zh-Hant - zh-CN - zh-HK - zh-SG - zh-TW - zu-ZA postingLang: type: - string - 'null' enum: - null - ja - ja-JP - ko - ko-KR - other viewingLangs: type: array minItems: 0 uniqueItems: true items: type: string enum: - ja - ja-JP - ko - ko-KR - other - unknown - remote showMediaInAllLanguages: type: boolean showHashtagsInAllLanguages: type: boolean avatarId: type: - string - 'null' format: misskey:id avatarDecorations: type: array maxItems: 16 items: type: object properties: id: type: string format: misskey:id angle: type: - number - 'null' maximum: 0.5 minimum: -0.5 flipH: type: - boolean - 'null' offsetX: type: - number - 'null' maximum: 0.25 minimum: -0.25 offsetY: type: - number - 'null' maximum: 0.25 minimum: -0.25 required: - id bannerId: type: - string - 'null' format: misskey:id fields: type: array minItems: 0 maxItems: 16 items: type: object properties: name: type: string value: type: string required: - name - value isLocked: type: boolean isExplorable: type: boolean hideOnlineStatus: type: boolean publicReactions: type: boolean carefulBot: type: boolean autoAcceptFollowed: type: boolean noCrawle: type: boolean preventAiLearning: type: boolean requireSigninToViewContents: type: boolean makeNotesFollowersOnlyBefore: type: - integer - 'null' makeNotesHiddenBefore: type: - integer - 'null' isBot: type: boolean isCat: type: boolean injectFeaturedNote: type: boolean receiveAnnouncementEmail: type: boolean alwaysMarkNsfw: type: boolean autoSensitive: type: boolean followingVisibility: type: string enum: - public - followers - private followersVisibility: type: string enum: - public - followers - private chatScope: type: string enum: - everyone - followers - following - mutual - none pinnedPageId: type: - string - 'null' format: misskey:id mutedWords: type: array items: oneOf: - type: array items: type: string - type: string mutedInstances: type: array items: type: string notificationRecieveConfig: type: object properties: note: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId follow: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId mention: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId reply: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId renote: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId quote: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId reaction: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId pollEnded: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId receiveFollowRequest: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId followRequestAccepted: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId roleAssigned: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId chatRoomInvitationReceived: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId achievementEarned: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId app: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId test: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId emailNotificationTypes: type: array items: type: string alsoKnownAs: type: array maxItems: 10 uniqueItems: true items: type: string mutualLinkSections: type: array maxItems: 10 items: type: object properties: name: type: - string - 'null' mutualLinks: type: array maxItems: 30 items: type: object properties: url: type: string format: url fileId: type: string format: misskey:id description: type: - string - 'null' required: - url - fileId required: - mutualLinks responses: '200': description: OK (with results) content: application/json: schema: type: object $ref: '#/components/schemas/MeDetailed' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_AVATAR: value: error: message: No such avatar file. code: NO_SUCH_AVATAR id: 539f3a45-f215-4f81-a9a8-31293640207f NO_SUCH_FILE: value: error: message: No such file. code: NO_SUCH_FILE id: e0f0d3c7-e704-4314-a0b5-04286d69a65c NO_SUCH_BANNER: value: error: message: No such banner file. code: NO_SUCH_BANNER id: 0d8f5629-f210-41c2-9433-735831a58595 AVATAR_NOT_AN_IMAGE: value: error: message: The file specified as an avatar is not an image. code: AVATAR_NOT_AN_IMAGE id: f419f9f8-2f4d-46b1-9fb4-49d3a2fd7191 FILE_NOT_AN_IMAGE: value: error: message: The specified file is not an image. code: FILE_NOT_AN_IMAGE id: 2851568b-5ad1-4031-bf0d-5320afebf3a9 BANNER_NOT_AN_IMAGE: value: error: message: The file specified as a banner is not an image. code: BANNER_NOT_AN_IMAGE id: 75aedb19-2afd-4e6d-87fc-67941256fa60 NO_SUCH_PAGE: value: error: message: No such page. code: NO_SUCH_PAGE id: 8e01b590-7eb9-431b-a239-860e086c408e INVALID_REGEXP: value: error: message: Invalid Regular Expression. code: INVALID_REGEXP id: 0d786918-10df-41cd-8f33-8dec7d9a89a5 TOO_MANY_MUTED_WORDS: value: error: message: Too many muted words. code: TOO_MANY_MUTED_WORDS id: 010665b1-a211-42d2-bc64-8f6609d79785 NO_SUCH_USER: value: error: message: No such user. code: NO_SUCH_USER id: fcd2eef9-a9b2-4c4f-8624-038099e90aa5 URI_NULL: value: error: message: User ActivityPup URI is null. code: URI_NULL id: bf326f31-d430-4f97-9933-5d61e4d48a23 INVALID_URL: value: error: message: Invalid URL code: INVALID_URL id: b2452e00-2bd0-4da8-a2d0-972859da7358 FORBIDDEN_TO_SET_YOURSELF: value: error: message: You can't set yourself as your own alias. code: FORBIDDEN_TO_SET_YOURSELF id: 25c90186-4ab0-49c8-9bba-a1fa6c202ba4 RESTRICTED_BY_ROLE: value: error: message: This feature is restricted by your role. code: RESTRICTED_BY_ROLE id: 8feff0ba-5ab5-585b-31f4-4df816663fad YOUR_NAME_CONTAINS_PROHIBITED_WORDS: value: error: message: Your new name contains prohibited words. code: YOUR_NAME_CONTAINS_PROHIBITED_WORDS id: 0b3f9f6a-2f4d-4b1f-9fb4-49d3a2fd7191 httpStatusCode: 422 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/Error' examples: RATE_LIMIT_EXCEEDED: value: error: message: Rate limit exceeded. Please try again later. code: RATE_LIMIT_EXCEEDED id: d5826d14-3982-4d2e-8011-b9e9f02499ef '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /mute/create: post: operationId: post___mute___create summary: mute/create description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:mutes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/mute/create.ts tags: - account security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: userId: type: string format: misskey:id expiresAt: type: - integer - 'null' description: A Unix Epoch timestamp that must lie in the future. `null` means an indefinite mute. required: - userId responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_USER: value: error: message: No such user. code: NO_SUCH_USER id: 6fef56f3-e765-4957-88e5-c6f65329b8a5 MUTEE_IS_YOURSELF: value: error: message: Mutee is yourself. code: MUTEE_IS_YOURSELF id: a4619cb2-5f23-484b-9301-94c903074e10 ALREADY_MUTING: value: error: message: You are already muting that user. code: ALREADY_MUTING id: 7e7359cb-160c-4956-b08f-4d1c653cd007 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/Error' examples: RATE_LIMIT_EXCEEDED: value: error: message: Rate limit exceeded. Please try again later. code: RATE_LIMIT_EXCEEDED id: d5826d14-3982-4d2e-8011-b9e9f02499ef '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /mute/delete: post: operationId: post___mute___delete summary: mute/delete description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:mutes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/mute/delete.ts tags: - account security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: userId: type: string format: misskey:id required: - userId responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_USER: value: error: message: No such user. code: NO_SUCH_USER id: b851d00b-8ab1-4a56-8b1b-e24187cb48ef MUTEE_IS_YOURSELF: value: error: message: Mutee is yourself. code: MUTEE_IS_YOURSELF id: f428b029-6b39-4d48-a1d2-cc1ae6dd5cf9 NOT_MUTING: value: error: message: You are not muting that user. code: NOT_MUTING id: 5467d020-daa9-4553-81e1-135c0c35a96d INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /mute/list: post: operationId: post___mute___list summary: mute/list description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:mutes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/mute/list.ts tags: - account security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 30 sinceId: type: string format: misskey:id untilId: type: string format: misskey:id responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object $ref: '#/components/schemas/Muting' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /my/apps: post: operationId: post___my___apps summary: my/apps description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:account*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/my/apps.ts tags: - account security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 10 offset: type: integer default: 0 responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object $ref: '#/components/schemas/App' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /renote-mute/create: post: operationId: post___renote-mute___create summary: renote-mute/create description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:mutes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/renote-mute/create.ts tags: - account security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: userId: type: string format: misskey:id required: - userId responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_USER: value: error: message: No such user. code: NO_SUCH_USER id: 5e0a5dff-1e94-4202-87ae-4d9c89eb2271 MUTEE_IS_YOURSELF: value: error: message: Mutee is yourself. code: MUTEE_IS_YOURSELF id: 37285718-52f7-4aef-b7de-c38b8e8a8420 ALREADY_MUTING: value: error: message: You are already muting that user. code: ALREADY_MUTING id: ccfecbe4-1f1c-4fc2-8a3d-c3ffee61cb7b INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/Error' examples: RATE_LIMIT_EXCEEDED: value: error: message: Rate limit exceeded. Please try again later. code: RATE_LIMIT_EXCEEDED id: d5826d14-3982-4d2e-8011-b9e9f02499ef '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /renote-mute/delete: post: operationId: post___renote-mute___delete summary: renote-mute/delete description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:mutes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/renote-mute/delete.ts tags: - account security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: userId: type: string format: misskey:id required: - userId responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_USER: value: error: message: No such user. code: NO_SUCH_USER id: 9b6728cf-638c-4aa1-bedb-e07d8101474d MUTEE_IS_YOURSELF: value: error: message: Mutee is yourself. code: MUTEE_IS_YOURSELF id: 619b1314-0850-4597-a242-e245f3da42af NOT_MUTING: value: error: message: You are not muting that user. code: NOT_MUTING id: 2e4ef874-8bf0-4b4b-b069-4598f6d05817 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /renote-mute/list: post: operationId: post___renote-mute___list summary: renote-mute/list description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:mutes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/renote-mute/list.ts tags: - account security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 30 sinceId: type: string format: misskey:id untilId: type: string format: misskey:id responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object $ref: '#/components/schemas/RenoteMuting' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /sw/register: post: operationId: post___sw___register summary: sw/register description: 'Register to receive push notifications. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/sw/register.ts tags: - account security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: endpoint: type: string auth: type: string publickey: type: string sendReadMessage: type: boolean default: false required: - endpoint - auth - publickey responses: '200': description: OK (with results) content: application/json: schema: type: object properties: state: type: string enum: - already-subscribed - subscribed key: type: - string - 'null' userId: type: string endpoint: type: string sendReadMessage: type: boolean required: - key - userId - endpoint - sendReadMessage '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /sw/show-registration: post: operationId: post___sw___show-registration summary: sw/show-registration description: 'Check push notification registration exists. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/sw/show-registration.ts tags: - account security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: endpoint: type: string required: - endpoint responses: '200': description: OK (with results) content: application/json: schema: type: - object - 'null' properties: userId: type: string endpoint: type: string sendReadMessage: type: boolean required: - userId - endpoint - sendReadMessage '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /sw/unregister: post: operationId: post___sw___unregister summary: sw/unregister description: 'Unregister from receiving push notifications. **Credential required**: *No*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/sw/unregister.ts tags: - account requestBody: required: true content: application/json: schema: type: object properties: endpoint: type: string required: - endpoint responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /sw/update-registration: post: operationId: post___sw___update-registration summary: sw/update-registration description: 'Update push notification registration. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/sw/update-registration.ts tags: - account security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: endpoint: type: string sendReadMessage: type: boolean required: - endpoint responses: '200': description: OK (with results) content: application/json: schema: type: object properties: userId: type: string endpoint: type: string sendReadMessage: type: boolean required: - userId - endpoint - sendReadMessage '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_REGISTRATION: value: error: message: No such registration. code: NO_SUCH_REGISTRATION id: ' b09d8066-8064-5613-efb6-0e963b21d012' INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac /users/update-memo: post: operationId: post___users___update-memo summary: users/update-memo description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:account*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/users/update-memo.ts tags: - account security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: userId: type: string format: misskey:id memo: type: - string - 'null' description: A personal memo for the target user. If null or empty, delete the memo. required: - userId - memo responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_USER: value: error: message: No such user. code: NO_SUCH_USER id: 6fef56f3-e765-4957-88e5-c6f65329b8a5 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac components: schemas: RenoteMuting: type: object properties: id: type: string format: id example: xxxxxxxxxx createdAt: type: string format: date-time muteeId: type: string format: id mutee: type: object $ref: '#/components/schemas/UserDetailedNotMe' required: - id - createdAt - muteeId - mutee RolePolicies: type: object properties: gtlAvailable: type: boolean ltlAvailable: type: boolean canPublicNote: type: boolean canScheduleNote: type: boolean scheduleNoteLimit: type: integer scheduleNoteMaxDays: type: integer canInitiateConversation: type: boolean canCreateContent: type: boolean canUpdateContent: type: boolean canDeleteContent: type: boolean canPurgeAccount: type: boolean canUpdateAvatar: type: boolean canUpdateBanner: type: boolean mentionLimit: type: integer canInvite: type: boolean inviteLimit: type: integer inviteLimitCycle: type: integer inviteExpirationTime: type: integer canManageCustomEmojis: type: boolean canManageAvatarDecorations: type: boolean canSearchNotes: type: boolean canUseTranslator: type: boolean canUseDriveFileInSoundSettings: type: boolean canUseReaction: type: boolean canHideAds: type: boolean driveCapacityMb: type: integer maxFileSizeMb: type: integer alwaysMarkNsfw: type: boolean skipNsfwDetection: type: boolean canUpdateBioMedia: type: boolean pinLimit: type: integer antennaLimit: type: integer antennaNotesLimit: type: integer wordMuteLimit: type: integer webhookLimit: type: integer clipLimit: type: integer noteEachClipsLimit: type: integer userListLimit: type: integer userEachUserListsLimit: type: integer rateLimitFactor: type: integer avatarDecorationLimit: type: integer canImportAntennas: type: boolean canImportBlocking: type: boolean canImportFollowing: type: boolean canImportMuting: type: boolean canImportUserLists: type: boolean mutualLinkSectionLimit: type: integer mutualLinkLimit: type: integer chatAvailability: type: string enum: - available - readonly - unavailable required: - gtlAvailable - ltlAvailable - canPublicNote - canScheduleNote - scheduleNoteLimit - scheduleNoteMaxDays - canInitiateConversation - canCreateContent - canUpdateContent - canDeleteContent - canPurgeAccount - canUpdateAvatar - canUpdateBanner - mentionLimit - canInvite - inviteLimit - inviteLimitCycle - inviteExpirationTime - canManageCustomEmojis - canManageAvatarDecorations - canSearchNotes - canUseTranslator - canUseDriveFileInSoundSettings - canUseReaction - canHideAds - driveCapacityMb - maxFileSizeMb - alwaysMarkNsfw - skipNsfwDetection - canUpdateBioMedia - pinLimit - antennaLimit - antennaNotesLimit - wordMuteLimit - webhookLimit - clipLimit - noteEachClipsLimit - userListLimit - userEachUserListsLimit - rateLimitFactor - avatarDecorationLimit - canImportAntennas - canImportBlocking - canImportFollowing - canImportMuting - canImportUserLists - mutualLinkSectionLimit - mutualLinkLimit - chatAvailability RoleCondFormulaValue: type: object oneOf: - $ref: '#/components/schemas/RoleCondFormulaLogics' - $ref: '#/components/schemas/RoleCondFormulaValueNot' - $ref: '#/components/schemas/RoleCondFormulaValueIsLocalOrRemote' - $ref: '#/components/schemas/RoleCondFormulaValueUserSettingBooleanSchema' - $ref: '#/components/schemas/RoleCondFormulaValueAssignedRole' - $ref: '#/components/schemas/RoleCondFormulaValueCreated' - $ref: '#/components/schemas/RoleCondFormulaFollowersOrFollowingOrNotes' DriveFile: type: object properties: id: type: string format: id example: xxxxxxxxxx createdAt: type: string format: date-time name: type: string example: 192.jpg type: type: string example: image/jpeg md5: type: string format: md5 example: 15eca7fba0480996e2245f5185bf39f2 size: type: number example: 51469 isSensitive: type: boolean isSensitiveByModerator: type: - boolean - 'null' blurhash: type: - string - 'null' properties: type: object properties: width: type: number example: 1280 height: type: number example: 720 orientation: type: number example: 8 avgColor: type: string example: rgb(40,65,87) url: type: string format: url thumbnailUrl: type: - string - 'null' format: url comment: type: - string - 'null' folderId: type: - string - 'null' format: id example: xxxxxxxxxx folder: type: - object - 'null' anyOf: - $ref: '#/components/schemas/DriveFolder' - type: 'null' userId: type: - string - 'null' format: id example: xxxxxxxxxx user: type: - object - 'null' anyOf: - $ref: '#/components/schemas/UserLite' - type: 'null' required: - id - createdAt - name - type - md5 - size - isSensitive - blurhash - properties - url - thumbnailUrl - comment - folderId - userId Note: type: object properties: id: type: string format: id example: xxxxxxxxxx createdAt: type: string format: date-time deletedAt: type: - string - 'null' format: date-time text: type: - string - 'null' cw: type: - string - 'null' userId: type: string format: id user: type: object $ref: '#/components/schemas/UserLite' replyId: type: - string - 'null' format: id example: xxxxxxxxxx renoteId: type: - string - 'null' format: id example: xxxxxxxxxx reply: type: - object - 'null' anyOf: - $ref: '#/components/schemas/Note' - type: 'null' renote: type: - object - 'null' anyOf: - $ref: '#/components/schemas/Note' - type: 'null' isHidden: type: boolean visibility: type: string enum: - public - home - followers - specified mentions: type: array items: type: string format: id visibleUserIds: type: array items: type: string format: id fileIds: type: array items: type: string format: id files: type: array items: type: object $ref: '#/components/schemas/DriveFile' tags: type: array items: type: string poll: type: - object - 'null' properties: expiresAt: type: - string - 'null' format: date-time multiple: type: boolean choices: type: array items: type: object properties: isVoted: type: boolean text: type: string votes: type: number required: - isVoted - text - votes required: - multiple - choices emojis: type: object additionalProperties: anyOf: - type: string channelId: type: - string - 'null' format: id example: xxxxxxxxxx channel: type: - object - 'null' properties: id: type: string name: type: string color: type: string isSensitive: type: boolean allowRenoteToExternal: type: boolean userId: type: - string - 'null' required: - id - name - color - isSensitive - allowRenoteToExternal - userId localOnly: type: boolean dimension: type: - integer - 'null' reactionAcceptance: type: - string - 'null' enum: - likeOnly - likeOnlyForRemote - nonSensitiveOnly - nonSensitiveOnlyForLocalLikeOnlyForRemote - null reactionEmojis: type: object additionalProperties: anyOf: - type: string reactions: type: object additionalProperties: anyOf: - type: number reactionCount: type: number renoteCount: type: number repliesCount: type: number uri: type: string url: type: string reactionAndUserPairCache: type: array items: type: string clippedCount: type: number myReaction: type: - string - 'null' required: - id - createdAt - text - userId - user - visibility - reactionAcceptance - reactionEmojis - reactions - reactionCount - renoteCount - repliesCount RoleCondFormulaValueIsLocalOrRemote: type: object properties: id: type: string type: type: string enum: - isLocal - isRemote required: - id - type RoleCondFormulaValueCreated: type: object properties: id: type: string type: type: string enum: - createdLessThan - createdMoreThan sec: type: number required: - id - type - sec Page: type: object properties: id: type: string format: id example: xxxxxxxxxx createdAt: type: string format: date-time updatedAt: type: string format: date-time userId: type: string format: id user: type: object $ref: '#/components/schemas/UserLite' content: type: array items: type: object $ref: '#/components/schemas/PageBlock' variables: type: array items: type: object title: type: string name: type: string summary: type: - string - 'null' hideTitleWhenPinned: type: boolean alignCenter: type: boolean font: type: string script: type: string eyeCatchingImageId: type: - string - 'null' eyeCatchingImage: type: - object - 'null' anyOf: - $ref: '#/components/schemas/DriveFile' - type: 'null' attachedFiles: type: array items: type: object $ref: '#/components/schemas/DriveFile' likedCount: type: number isLiked: type: boolean visibility: type: string enum: - public - private required: - id - createdAt - updatedAt - userId - user - content - variables - title - name - summary - hideTitleWhenPinned - alignCenter - font - script - eyeCatchingImageId - eyeCatchingImage - attachedFiles - likedCount - visibility Notification: type: object oneOf: - type: object properties: id: type: string format: id createdAt: type: string format: date-time type: type: string enum: - note user: type: object $ref: '#/components/schemas/UserLite' userId: type: string format: id note: type: object $ref: '#/components/schemas/Note' required: - id - createdAt - type - user - userId - note - type: object properties: id: type: string format: id createdAt: type: string format: date-time type: type: string enum: - mention user: type: object $ref: '#/components/schemas/UserLite' userId: type: string format: id note: type: object $ref: '#/components/schemas/Note' required: - id - createdAt - type - user - userId - note - type: object properties: id: type: string format: id createdAt: type: string format: date-time type: type: string enum: - reply user: type: object $ref: '#/components/schemas/UserLite' userId: type: string format: id note: type: object $ref: '#/components/schemas/Note' required: - id - createdAt - type - user - userId - note - type: object properties: id: type: string format: id createdAt: type: string format: date-time type: type: string enum: - renote user: type: object $ref: '#/components/schemas/UserLite' userId: type: string format: id note: type: object $ref: '#/components/schemas/Note' required: - id - createdAt - type - user - userId - note - type: object properties: id: type: string format: id createdAt: type: string format: date-time type: type: string enum: - quote user: type: object $ref: '#/components/schemas/UserLite' userId: type: string format: id note: type: object $ref: '#/components/schemas/Note' required: - id - createdAt - type - user - userId - note - type: object properties: id: type: string format: id createdAt: type: string format: date-time type: type: string enum: - reaction user: type: object $ref: '#/components/schemas/UserLite' userId: type: string format: id note: type: object $ref: '#/components/schemas/Note' reaction: type: string required: - id - createdAt - type - user - userId - note - reaction - type: object properties: id: type: string format: id createdAt: type: string format: date-time type: type: string enum: - pollEnded user: type: object $ref: '#/components/schemas/UserLite' userId: type: string format: id note: type: object $ref: '#/components/schemas/Note' required: - id - createdAt - type - user - userId - note - type: object properties: id: type: string format: id createdAt: type: string format: date-time type: type: string enum: - follow user: type: object $ref: '#/components/schemas/UserLite' userId: type: string format: id required: - id - createdAt - type - user - userId - type: object properties: id: type: string format: id createdAt: type: string format: date-time type: type: string enum: - receiveFollowRequest user: type: object $ref: '#/components/schemas/UserLite' userId: type: string format: id required: - id - createdAt - type - user - userId - type: object properties: id: type: string format: id createdAt: type: string format: date-time type: type: string enum: - followRequestAccepted user: type: object $ref: '#/components/schemas/UserLite' userId: type: string format: id message: type: - string - 'null' required: - id - createdAt - type - user - userId - message - type: object properties: id: type: string format: id createdAt: type: string format: date-time type: type: string enum: - roleAssigned role: type: object $ref: '#/components/schemas/Role' required: - id - createdAt - type - role - type: object properties: id: type: string format: id createdAt: type: string format: date-time type: type: string enum: - chatRoomInvitationReceived invitation: type: object $ref: '#/components/schemas/ChatRoomInvitation' required: - id - createdAt - type - invitation - type: object properties: id: type: string format: id createdAt: type: string format: date-time type: type: string enum: - achievementEarned achievement: type: string enum: - notes1 - notes10 - notes100 - notes500 - notes1000 - notes5000 - notes10000 - notes20000 - notes30000 - notes40000 - notes50000 - notes60000 - notes70000 - notes80000 - notes90000 - notes100000 - login3 - login7 - login15 - login30 - login60 - login100 - login200 - login300 - login400 - login500 - login600 - login700 - login800 - login900 - login1000 - passedSinceAccountCreated1 - passedSinceAccountCreated2 - passedSinceAccountCreated3 - loggedInOnBirthday - loggedInOnNewYearsDay - noteClipped1 - noteFavorited1 - myNoteFavorited1 - profileFilled - markedAsCat - following1 - following10 - following50 - following100 - following300 - followers1 - followers10 - followers50 - followers100 - followers300 - followers500 - followers1000 - collectAchievements30 - viewAchievements3min - iLoveMisskey - foundTreasure - client30min - client60min - noteDeletedWithin1min - postedAtLateNight - postedAt0min0sec - selfQuote - htl20npm - viewInstanceChart - outputHelloWorldOnScratchpad - open3windows - driveFolderCircularReference - reactWithoutRead - clickedClickHere - justPlainLucky - setNameToSyuilo - cookieClicked - brainDiver - smashTestNotificationButton - tutorialCompleted - sensitiveContentConsentResponded - postingLanguageConfigured - viewingLanguagesConfigured - dimensionConfigured - bubbleGameExplodingHead - bubbleGameDoubleExplodingHead required: - id - createdAt - type - achievement - type: object properties: id: type: string format: id createdAt: type: string format: date-time type: type: string enum: - exportCompleted exportedEntity: type: string enum: - antenna - blocking - clip - customEmoji - favorite - following - muting - note - userList fileId: type: string format: id required: - id - createdAt - type - exportedEntity - fileId - type: object properties: id: type: string format: id createdAt: type: string format: date-time type: type: string enum: - login required: - id - createdAt - type - type: object properties: id: type: string format: id createdAt: type: string format: date-time type: type: string enum: - noteScheduled draft: type: object $ref: '#/components/schemas/NoteDraft' required: - id - createdAt - type - draft - type: object properties: id: type: string format: id createdAt: type: string format: date-time type: type: string enum: - scheduledNotePosted note: type: object $ref: '#/components/schemas/Note' required: - id - createdAt - type - note - type: object properties: id: type: string format: id createdAt: type: string format: date-time type: type: string enum: - scheduledNoteError draft: type: object $ref: '#/components/schemas/NoteDraft' required: - id - createdAt - type - draft - type: object properties: id: type: string format: id createdAt: type: string format: date-time type: type: string enum: - sensitiveFlagAssigned fileId: {} required: - id - createdAt - type - fileId - type: object properties: id: type: string format: id createdAt: type: string format: date-time type: type: string enum: - createToken required: - id - createdAt - type - type: object properties: id: type: string format: id createdAt: type: string format: date-time type: type: string enum: - app body: type: string header: type: - string - 'null' icon: type: - string - 'null' required: - id - createdAt - type - body - header - icon - type: object properties: id: type: string format: id createdAt: type: string format: date-time type: type: string enum: - reaction:grouped note: type: object $ref: '#/components/schemas/Note' reactions: type: array items: type: object properties: user: type: object $ref: '#/components/schemas/UserLite' reaction: type: string required: - user - reaction required: - id - createdAt - type - note - reactions - type: object properties: id: type: string format: id createdAt: type: string format: date-time type: type: string enum: - renote:grouped note: type: object $ref: '#/components/schemas/Note' users: type: array items: type: object $ref: '#/components/schemas/UserLite' required: - id - createdAt - type - note - users - type: object properties: id: type: string format: id createdAt: type: string format: date-time type: type: string enum: - test required: - id - createdAt - type Role: type: object allOf: - type: object $ref: '#/components/schemas/RoleLite' - type: object properties: createdAt: type: string format: date-time updatedAt: type: string format: date-time target: type: string enum: - manual - conditional condFormula: type: object $ref: '#/components/schemas/RoleCondFormulaValue' isPublic: type: boolean example: false isExplorable: type: boolean example: false asBadge: type: boolean example: false preserveAssignmentOnMoveAccount: type: boolean example: false badgeBehavior: type: - string - 'null' canEditMembersByModerator: type: boolean example: false policies: type: object additionalProperties: anyOf: - type: object properties: value: oneOf: - type: integer - type: boolean priority: type: integer useDefault: type: boolean usersCount: type: integer required: - createdAt - updatedAt - target - condFormula - isPublic - isExplorable - asBadge - preserveAssignmentOnMoveAccount - badgeBehavior - canEditMembersByModerator - policies - usersCount GalleryPost: type: object properties: id: type: string format: id example: xxxxxxxxxx createdAt: type: string format: date-time updatedAt: type: string format: date-time userId: type: string format: id user: type: object $ref: '#/components/schemas/UserLite' title: type: string description: type: - string - 'null' fileIds: type: array items: type: string format: id files: type: array items: type: object $ref: '#/components/schemas/DriveFile' tags: type: array items: type: string isSensitive: type: boolean likedCount: type: number isLiked: type: boolean required: - id - createdAt - updatedAt - userId - user - title - description - isSensitive - likedCount UserDetailedNotMe: type: object allOf: - type: object $ref: '#/components/schemas/UserLite' - type: object $ref: '#/components/schemas/UserDetailedNotMeOnly' UserDetailedNotMeOnly: type: object properties: url: type: - string - 'null' format: url uri: type: - string - 'null' format: uri movedTo: type: - string - 'null' format: uri alsoKnownAs: type: - array - 'null' items: type: string format: id createdAt: type: string format: date-time updatedAt: type: - string - 'null' format: date-time lastFetchedAt: type: - string - 'null' format: date-time bannerUrl: type: - string - 'null' format: url bannerBlurhash: type: - string - 'null' isLocked: type: boolean isSilenced: type: boolean isLimited: type: boolean isSuspended: type: boolean example: false description: type: - string - 'null' example: Hi masters, I am Ai! location: type: - string - 'null' birthday: type: - string - 'null' example: '2018-03-12' lang: type: - string - 'null' example: ja-JP fields: type: array maxItems: 16 items: type: object properties: name: type: string value: type: string required: - name - value verifiedLinks: type: array items: type: string format: url followersCount: type: number followingCount: type: number notesCount: type: number pinnedNoteIds: type: array items: type: string format: id pinnedNotes: type: array items: type: object $ref: '#/components/schemas/Note' pinnedPageId: type: - string - 'null' pinnedPage: type: - object - 'null' anyOf: - $ref: '#/components/schemas/Page' - type: 'null' publicReactions: type: boolean followingVisibility: type: string enum: - public - followers - private followersVisibility: type: string enum: - public - followers - private chatScope: type: string enum: - everyone - following - followers - mutual - none canChat: type: boolean roles: type: array items: type: object $ref: '#/components/schemas/RoleLite' followedMessage: type: - string - 'null' memo: type: - string - 'null' moderationNote: type: string twoFactorEnabled: type: boolean usePasswordLessLogin: type: boolean securityKeys: type: boolean mutualLinkSections: type: array items: type: object properties: name: type: - string - 'null' mutualLinks: type: array items: type: object properties: id: type: string format: misskey:id url: type: string format: url fileId: type: string format: misskey:id description: type: - string - 'null' imgSrc: type: string required: - id - url - fileId - description - imgSrc required: - name - mutualLinks isFollowing: type: boolean isFollowed: type: boolean hasPendingFollowRequestFromYou: type: boolean hasPendingFollowRequestToYou: type: boolean isBlocking: type: boolean isBlocked: type: boolean isMuted: type: boolean isRenoteMuted: type: boolean notify: type: string enum: - normal - none withReplies: type: boolean required: - url - uri - movedTo - alsoKnownAs - createdAt - updatedAt - lastFetchedAt - bannerUrl - bannerBlurhash - isLocked - isSilenced - isLimited - isSuspended - description - location - birthday - lang - fields - verifiedLinks - followersCount - followingCount - notesCount - pinnedNoteIds - pinnedNotes - pinnedPageId - pinnedPage - publicReactions - followingVisibility - followersVisibility - chatScope - canChat - roles - memo - mutualLinkSections RoleCondFormulaFollowersOrFollowingOrNotes: type: object properties: id: type: string type: type: string enum: - followersLessThanOrEq - followersMoreThanOrEq - followingLessThanOrEq - followingMoreThanOrEq - notesLessThanOrEq - notesMoreThanOrEq value: type: number required: - id - type - value Blocking: type: object properties: id: type: string format: id example: xxxxxxxxxx createdAt: type: string format: date-time blockeeId: type: string format: id blockee: type: object $ref: '#/components/schemas/UserDetailedNotMe' required: - id - createdAt - blockeeId - blockee NoteFavorite: type: object properties: id: type: string format: id example: xxxxxxxxxx createdAt: type: string format: date-time note: type: object $ref: '#/components/schemas/Note' noteId: type: string format: id required: - id - createdAt - note - noteId RoleCondFormulaValueAssignedRole: type: object properties: id: type: string type: type: string enum: - roleAssignedTo roleId: type: string format: id example: xxxxxxxxxx required: - id - type - roleId Announcement: type: object properties: id: type: string format: id example: xxxxxxxxxx createdAt: type: string format: date-time updatedAt: type: - string - 'null' format: date-time text: type: string title: type: string imageUrl: type: - string - 'null' icon: type: string enum: - info - warning - error - success display: type: string enum: - dialog - normal - banner needConfirmationToRead: type: boolean needEnrollmentTutorialToRead: type: boolean forYou: type: boolean closeDuration: type: number displayOrder: type: number silence: type: boolean isRead: type: boolean required: - id - createdAt - updatedAt - text - title - imageUrl - icon - display - needConfirmationToRead - needEnrollmentTutorialToRead - forYou - closeDuration - displayOrder - silence RoleCondFormulaLogics: type: object properties: id: type: string type: type: string enum: - and - or values: type: array items: $ref: '#/components/schemas/RoleCondFormulaValue' required: - id - type - values Clip: type: object properties: id: type: string format: id example: xxxxxxxxxx createdAt: type: string format: date-time lastClippedAt: type: - string - 'null' format: date-time userId: type: string format: id user: type: object $ref: '#/components/schemas/UserLite' name: type: string description: type: - string - 'null' isPublic: type: boolean favoritedCount: type: number isFavorited: type: boolean notesCount: type: integer required: - id - createdAt - lastClippedAt - userId - user - name - description - isPublic - favoritedCount DriveFolder: type: object properties: id: type: string format: id example: xxxxxxxxxx createdAt: type: string format: date-time name: type: string parentId: type: - string - 'null' format: id example: xxxxxxxxxx foldersCount: type: number filesCount: type: number parent: type: - object - 'null' anyOf: - $ref: '#/components/schemas/DriveFolder' - type: 'null' required: - id - createdAt - name - parentId UserLite: type: object properties: id: type: string format: id example: xxxxxxxxxx name: type: - string - 'null' example: 藍 username: type: string example: ai host: type: - string - 'null' example: misskey.example.com description: The local host is represented with `null`. avatarUrl: type: - string - 'null' format: url avatarBlurhash: type: - string - 'null' avatarDecorations: type: array items: type: object properties: id: type: string format: id angle: type: number flipH: type: boolean url: type: string format: url offsetX: type: number offsetY: type: number required: - id - url isBot: type: boolean isCat: type: boolean requireSigninToViewContents: type: boolean makeNotesFollowersOnlyBefore: type: - number - 'null' makeNotesHiddenBefore: type: - number - 'null' instance: type: object properties: name: type: - string - 'null' softwareName: type: - string - 'null' softwareVersion: type: - string - 'null' iconUrl: type: - string - 'null' faviconUrl: type: - string - 'null' themeColor: type: - string - 'null' required: - name - softwareName - softwareVersion - iconUrl - faviconUrl - themeColor emojis: type: object additionalProperties: type: string onlineStatus: type: string enum: - unknown - online - active - offline badgeRoles: type: array items: type: object properties: name: type: string iconUrl: type: - string - 'null' displayOrder: type: number behavior: type: string required: - name - iconUrl - displayOrder required: - id - name - username - host - avatarUrl - avatarBlurhash - avatarDecorations - emojis - onlineStatus Error: type: object properties: error: type: object description: An error object. properties: code: type: string description: An error code. Unique within the endpoint. message: type: string description: An error message. id: type: string format: uuid description: An error ID. This ID is static. required: - code - id - message required: - error MeDetailedOnly: type: object properties: avatarId: type: - string - 'null' format: id bannerId: type: - string - 'null' format: id followedMessage: type: - string - 'null' isModerator: type: - boolean - 'null' isAdmin: type: - boolean - 'null' injectFeaturedNote: type: boolean receiveAnnouncementEmail: type: boolean alwaysMarkNsfw: type: boolean autoSensitive: type: boolean carefulBot: type: boolean autoAcceptFollowed: type: boolean noCrawle: type: boolean preventAiLearning: type: boolean isExplorable: type: boolean isDeleted: type: boolean twoFactorBackupCodesStock: type: string enum: - full - partial - none hideOnlineStatus: type: boolean hasUnreadSpecifiedNotes: type: boolean hasUnreadMentions: type: boolean hasUnreadAnnouncement: type: boolean unreadAnnouncements: type: array items: type: object $ref: '#/components/schemas/Announcement' hasUnreadAntenna: type: boolean hasUnreadChannel: type: boolean hasUnreadChatMessages: type: boolean hasUnreadNotification: type: boolean hasPendingReceivedFollowRequest: type: boolean unreadNotificationsCount: type: number mutedWords: type: array items: type: array items: type: string mutedInstances: type: - array - 'null' items: type: string postingLang: type: - string - 'null' example: ja-JP viewingLangs: type: array items: type: string showMediaInAllLanguages: type: boolean showHashtagsInAllLanguages: type: boolean notificationRecieveConfig: type: object properties: note: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId follow: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId mention: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId reply: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId renote: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId quote: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId reaction: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId pollEnded: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId receiveFollowRequest: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId followRequestAccepted: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId roleAssigned: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId chatRoomInvitationReceived: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId achievementEarned: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId app: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId test: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId emailNotificationTypes: type: array items: type: string achievements: type: array items: type: object properties: name: type: string unlockedAt: type: number required: - name - unlockedAt loggedInDays: type: number policies: type: object $ref: '#/components/schemas/RolePolicies' twoFactorEnabled: type: boolean default: false usePasswordLessLogin: type: boolean default: false securityKeys: type: boolean default: false email: type: - string - 'null' emailVerified: type: - boolean - 'null' securityKeysList: type: array items: type: object properties: id: type: string format: id example: xxxxxxxxxx name: type: string lastUsed: type: string format: date-time required: - id - name - lastUsed required: - avatarId - bannerId - followedMessage - isModerator - isAdmin - injectFeaturedNote - receiveAnnouncementEmail - alwaysMarkNsfw - autoSensitive - carefulBot - autoAcceptFollowed - noCrawle - preventAiLearning - isExplorable - isDeleted - twoFactorBackupCodesStock - hideOnlineStatus - hasUnreadSpecifiedNotes - hasUnreadMentions - hasUnreadAnnouncement - unreadAnnouncements - hasUnreadAntenna - hasUnreadChannel - hasUnreadChatMessages - hasUnreadNotification - hasPendingReceivedFollowRequest - unreadNotificationsCount - mutedWords - mutedInstances - postingLang - viewingLangs - showMediaInAllLanguages - showHashtagsInAllLanguages - notificationRecieveConfig - emailNotificationTypes - achievements - loggedInDays - policies - twoFactorEnabled - usePasswordLessLogin - securityKeys MeDetailed: type: object allOf: - type: object $ref: '#/components/schemas/UserLite' - type: object $ref: '#/components/schemas/UserDetailedNotMeOnly' - type: object $ref: '#/components/schemas/MeDetailedOnly' ChatRoomInvitation: type: object properties: id: type: string createdAt: type: string format: date-time userId: type: string user: type: object $ref: '#/components/schemas/UserLite' roomId: type: string room: type: object $ref: '#/components/schemas/ChatRoom' required: - id - createdAt - userId - user - roomId - room ChatRoom: type: object properties: id: type: string createdAt: type: string format: date-time ownerId: type: string owner: type: object $ref: '#/components/schemas/UserLite' name: type: string description: type: string isMuted: type: boolean required: - id - createdAt - ownerId - owner - name - description PageBlock: type: object oneOf: - type: object properties: id: type: string type: type: string enum: - text text: type: string required: - id - type - text - type: object properties: id: type: string type: type: string enum: - section title: type: string children: type: array items: type: object required: - id - type - title - children - type: object properties: id: type: string type: type: string enum: - image fileId: type: - string - 'null' required: - id - type - fileId - type: object properties: id: type: string type: type: string enum: - note detailed: type: boolean note: type: - string - 'null' required: - id - type - detailed - note RoleCondFormulaValueUserSettingBooleanSchema: type: object properties: id: type: string type: type: string enum: - isSuspended - isLocked - isBot - isCat - isExplorable required: - id - type Muting: type: object properties: id: type: string format: id example: xxxxxxxxxx createdAt: type: string format: date-time expiresAt: type: - string - 'null' format: date-time muteeId: type: string format: id mutee: type: object $ref: '#/components/schemas/UserDetailedNotMe' required: - id - createdAt - expiresAt - muteeId - mutee Flash: type: object properties: id: type: string format: id example: xxxxxxxxxx createdAt: type: string format: date-time updatedAt: type: string format: date-time userId: type: string format: id user: type: object $ref: '#/components/schemas/UserLite' title: type: string summary: type: string script: type: string visibility: type: string enum: - private - public likedCount: type: - number - 'null' isLiked: type: boolean required: - id - createdAt - updatedAt - userId - user - title - summary - script - visibility - likedCount NoteDraft: type: object properties: id: type: string format: misskey:id updatedAt: type: string format: date-time scheduledAt: type: - string - 'null' format: date-time reason: type: string channel: type: - object - 'null' properties: id: type: string format: misskey:id name: type: string required: - id - name renote: type: - object - 'null' properties: id: type: string format: misskey:id text: type: - string - 'null' user: type: object properties: id: type: string format: misskey:id username: type: string host: type: - string - 'null' required: - id - username - host required: - id - text - user reply: type: - object - 'null' properties: id: type: string format: misskey:id text: type: - string - 'null' user: type: object properties: id: type: string format: misskey:id username: type: string host: type: - string - 'null' required: - id - username - host required: - id - text - user data: type: object properties: text: type: - string - 'null' useCw: type: boolean cw: type: - string - 'null' visibility: type: string enum: - public - home - followers - specified localOnly: type: boolean lang: type: - string - 'null' dimension: type: - integer - 'null' files: type: array items: type: object $ref: '#/components/schemas/DriveFile' poll: type: - object - 'null' properties: choices: type: array items: type: string multiple: type: boolean expiresAt: type: - integer - 'null' expiredAfter: type: - integer - 'null' minimum: 1 required: - choices - multiple - expiresAt - expiredAfter visibleUserIds: type: array items: type: string format: misskey:id required: - text - useCw - cw - visibility - localOnly - files - poll required: - id - updatedAt - scheduledAt - data RoleCondFormulaValueNot: type: object properties: id: type: string type: type: string enum: - not value: type: object $ref: '#/components/schemas/RoleCondFormulaValue' required: - id - type - value RoleLite: type: object properties: id: type: string format: id example: xxxxxxxxxx name: type: string example: New Role color: type: - string - 'null' example: '#000000' iconUrl: type: - string - 'null' description: type: string isModerator: type: boolean example: false isAdministrator: type: boolean example: false displayOrder: type: integer example: 0 required: - id - name - color - iconUrl - description - isModerator - isAdministrator - displayOrder App: type: object properties: id: type: string name: type: string callbackUrl: type: - string - 'null' permission: type: array items: type: string secret: type: string isAuthorized: type: boolean required: - id - name - callbackUrl - permission securitySchemes: bearerAuth: type: http scheme: bearer externalDocs: description: Repository url: https://github.com/MisskeyIO/misskey