# 12.119.2 # # Owner https://tkithrta.gitlab.io/ # misskey-api-doc-yml は `curl https://misskey.io/api.json | yq -P > api.yml` で取得した # Misskey API を Vercel に Deploy しただけの Unofficial Documents です。 # Misskey 公式および Misskey.io の承認を受けて提供されたものではありません。 # Misskey https://github.com/misskey-dev/misskey # Misskey.io https://misskey.io/ # # Misskey.io の Misskey Version は @MisskeyStable@misskey.io で確認できます。 # @MisskeyStable | Misskey.io https://misskey.io/@MisskeyStable # # Remove head comment YAML https://misskey-api-doc-yml.vercel.app/api.yml # Documents は「現状のまま」で、明示であるか暗黙であるかを問わず、何らの保証もなく提供されます。ここでいう保証とは、商品性、特定の目的への適合性、および権利非侵害についての保証も含みますが、それに限定されるものではありません。作者または著作権者は、契約行為、不法行為、またはそれ以外であろうと、 Documents に起因または関連し、あるいは Documents の使用またはその他の扱いによって生じる一切の請求、損害、その他の義務について何らの責任も負わないものとします。 openapi: 3.0.0 info: version: v1 title: Misskey API x-logo: url: /static-assets/api-doc.png externalDocs: description: Repository url: https://github.com/misskey-dev/misskey servers: - url: https://misskey.io/api paths: /admin/meta: post: operationId: admin/meta summary: admin/meta description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/meta.ts tags: - meta security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: {} required: [] responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false properties: driveCapacityPerLocalUserMb: type: number optional: false nullable: false driveCapacityPerRemoteUserMb: type: number optional: false nullable: false cacheRemoteFiles: type: boolean optional: false nullable: false emailRequiredForSignup: type: boolean optional: false nullable: false enableHcaptcha: type: boolean optional: false nullable: false hcaptchaSiteKey: type: string optional: false nullable: true enableRecaptcha: type: boolean optional: false nullable: false recaptchaSiteKey: type: string optional: false nullable: true swPublickey: type: string optional: false nullable: true mascotImageUrl: type: string optional: false nullable: false default: /assets/ai.png bannerUrl: type: string optional: false nullable: false errorImageUrl: type: string optional: false nullable: false default: https://xn--931a.moe/aiart/yubitun.png iconUrl: type: string optional: false nullable: true maxNoteTextLength: type: number optional: false nullable: false emojis: type: array optional: false nullable: false items: type: object optional: false nullable: false properties: id: type: string optional: false nullable: false format: id aliases: type: array optional: false nullable: false items: type: string optional: false nullable: false category: type: string optional: false nullable: true host: type: string optional: false nullable: true url: type: string optional: false nullable: false format: url required: - id - aliases - category - host - url ads: type: array optional: false nullable: false items: type: object optional: false nullable: false properties: place: type: string optional: false nullable: false url: type: string optional: false nullable: false format: url imageUrl: type: string optional: false nullable: false format: url required: - place - url - imageUrl enableEmail: type: boolean optional: false nullable: false enableTwitterIntegration: type: boolean optional: false nullable: false enableGithubIntegration: type: boolean optional: false nullable: false enableDiscordIntegration: type: boolean optional: false nullable: false enableServiceWorker: type: boolean optional: false nullable: false translatorAvailable: type: boolean optional: false nullable: false proxyAccountName: type: string optional: false nullable: true userStarForReactionFallback: type: boolean optional: true nullable: false pinnedUsers: type: array optional: true nullable: false items: type: string optional: false nullable: false hiddenTags: type: array optional: true nullable: false items: type: string optional: false nullable: false blockedHosts: type: array optional: true nullable: false items: type: string optional: false nullable: false hcaptchaSecretKey: type: string optional: true nullable: true recaptchaSecretKey: type: string optional: true nullable: true sensitiveMediaDetection: type: string optional: true nullable: false sensitiveMediaDetectionSensitivity: type: string optional: true nullable: false setSensitiveFlagAutomatically: type: boolean optional: true nullable: false enableSensitiveMediaDetectionForVideos: type: boolean optional: true nullable: false proxyAccountId: type: string optional: true nullable: true format: id twitterConsumerKey: type: string optional: true nullable: true twitterConsumerSecret: type: string optional: true nullable: true githubClientId: type: string optional: true nullable: true githubClientSecret: type: string optional: true nullable: true discordClientId: type: string optional: true nullable: true discordClientSecret: type: string optional: true nullable: true summaryProxy: type: string optional: true nullable: true email: type: string optional: true nullable: true smtpSecure: type: boolean optional: true nullable: false smtpHost: type: string optional: true nullable: true smtpPort: type: string optional: true nullable: true smtpUser: type: string optional: true nullable: true smtpPass: type: string optional: true nullable: true swPrivateKey: type: string optional: true nullable: true useObjectStorage: type: boolean optional: true nullable: false objectStorageBaseUrl: type: string optional: true nullable: true objectStorageBucket: type: string optional: true nullable: true objectStoragePrefix: type: string optional: true nullable: true objectStorageEndpoint: type: string optional: true nullable: true objectStorageRegion: type: string optional: true nullable: true objectStoragePort: type: number optional: true nullable: true objectStorageAccessKey: type: string optional: true nullable: true objectStorageSecretKey: type: string optional: true nullable: true objectStorageUseSSL: type: boolean optional: true nullable: false objectStorageUseProxy: type: boolean optional: true nullable: false objectStorageSetPublicRead: type: boolean optional: true nullable: false enableIpLogging: type: boolean optional: true nullable: false enableActiveEmailValidation: type: boolean optional: true nullable: false required: - driveCapacityPerLocalUserMb - driveCapacityPerRemoteUserMb - cacheRemoteFiles - emailRequiredForSignup - enableHcaptcha - hcaptchaSiteKey - enableRecaptcha - recaptchaSiteKey - swPublickey - mascotImageUrl - bannerUrl - errorImageUrl - iconUrl - maxNoteTextLength - emojis - ads - enableEmail - enableTwitterIntegration - enableGithubIntegration - enableDiscordIntegration - enableServiceWorker - translatorAvailable - proxyAccountName "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 /admin/abuse-user-reports: post: operationId: admin/abuse-user-reports summary: admin/abuse-user-reports description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/abuse-user-reports.ts tags: - admin security: - ApiKeyAuth: [] 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 state: type: string nullable: true default: null reporterOrigin: type: string enum: - combined - local - remote default: combined targetUserOrigin: type: string enum: - combined - local - remote default: combined forwarded: type: boolean default: false required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false properties: id: type: string nullable: false optional: false format: id example: xxxxxxxxxx createdAt: type: string nullable: false optional: false format: date-time comment: type: string nullable: false optional: false resolved: type: boolean nullable: false optional: false example: false reporterId: type: string nullable: false optional: false format: id targetUserId: type: string nullable: false optional: false format: id assigneeId: type: string nullable: true optional: false format: id reporter: type: object nullable: false optional: false ref: User $ref: '#/components/schemas/User' targetUser: type: object nullable: false optional: false ref: User $ref: '#/components/schemas/User' assignee: type: object nullable: true optional: true ref: User $ref: '#/components/schemas/User' required: - id - createdAt - comment - resolved - reporterId - targetUserId - assigneeId - reporter - targetUser "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 /admin/accounts/create: post: operationId: admin/accounts/create summary: admin/accounts/create description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/accounts/create.ts tags: - admin requestBody: required: true content: application/json: schema: type: object properties: username: type: string pattern: ^\w{1,20}$ password: type: string minLength: 1 required: - username - password responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false ref: User properties: token: type: string optional: false nullable: false required: - token $ref: '#/components/schemas/User' "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 /admin/accounts/delete: post: operationId: admin/accounts/delete summary: admin/accounts/delete description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/accounts/delete.ts tags: - admin security: - ApiKeyAuth: [] 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: 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 /admin/ad/create: post: operationId: admin/ad/create summary: admin/ad/create description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/ad/create.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: url: type: string minLength: 1 memo: type: string place: type: string priority: type: string ratio: type: integer expiresAt: type: integer imageUrl: type: string minLength: 1 required: - url - memo - place - priority - ratio - expiresAt - imageUrl 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 /admin/ad/delete: post: operationId: admin/ad/delete summary: admin/ad/delete description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/ad/delete.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: id: type: string format: misskey:id required: - id responses: "204": description: OK (without any results) "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_AD: value: error: message: No such ad. code: NO_SUCH_AD id: ccac9863-3a03-416e-b899-8a64041118b1 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 /admin/ad/list: post: operationId: admin/ad/list summary: admin/ad/list description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/ad/list.ts tags: - admin security: - ApiKeyAuth: [] 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 required: [] 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 /admin/ad/update: post: operationId: admin/ad/update summary: admin/ad/update description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/ad/update.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: id: type: string format: misskey:id memo: type: string url: type: string minLength: 1 imageUrl: type: string minLength: 1 place: type: string priority: type: string ratio: type: integer expiresAt: type: integer required: - id - memo - url - imageUrl - place - priority - ratio - expiresAt responses: "204": description: OK (without any results) "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_AD: value: error: message: No such ad. code: NO_SUCH_AD id: b7aa1727-1354-47bc-a182-3a9c3973d300 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 /admin/announcements/create: post: operationId: admin/announcements/create summary: admin/announcements/create description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/announcements/create.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: title: type: string minLength: 1 text: type: string minLength: 1 imageUrl: type: string nullable: true minLength: 1 required: - title - text - imageUrl responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false properties: id: type: string optional: false nullable: false format: id example: xxxxxxxxxx createdAt: type: string optional: false nullable: false format: date-time updatedAt: type: string optional: false nullable: true format: date-time title: type: string optional: false nullable: false text: type: string optional: false nullable: false imageUrl: type: string optional: false nullable: true required: - id - createdAt - updatedAt - title - text - imageUrl "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 /admin/announcements/delete: post: operationId: admin/announcements/delete summary: admin/announcements/delete description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/announcements/delete.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: id: type: string format: misskey:id required: - id responses: "204": description: OK (without any results) "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_ANNOUNCEMENT: value: error: message: No such announcement. code: NO_SUCH_ANNOUNCEMENT id: ecad8040-a276-4e85-bda9-015a708d291e 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 /admin/announcements/list: post: operationId: admin/announcements/list summary: admin/announcements/list description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/announcements/list.ts tags: - admin security: - ApiKeyAuth: [] 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 required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false properties: id: type: string optional: false nullable: false format: id example: xxxxxxxxxx createdAt: type: string optional: false nullable: false format: date-time updatedAt: type: string optional: false nullable: true format: date-time text: type: string optional: false nullable: false title: type: string optional: false nullable: false imageUrl: type: string optional: false nullable: true reads: type: number optional: false nullable: false required: - id - createdAt - updatedAt - text - title - imageUrl - reads "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 /admin/announcements/update: post: operationId: admin/announcements/update summary: admin/announcements/update description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/announcements/update.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: id: type: string format: misskey:id title: type: string minLength: 1 text: type: string minLength: 1 imageUrl: type: string nullable: true minLength: 1 required: - id - title - text - imageUrl responses: "204": description: OK (without any results) "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_ANNOUNCEMENT: value: error: message: No such announcement. code: NO_SUCH_ANNOUNCEMENT id: d3aae5a7-6372-4cb4-b61c-f511ffc2d7cc 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 /admin/delete-all-files-of-a-user: post: operationId: admin/delete-all-files-of-a-user summary: admin/delete-all-files-of-a-user description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/delete-all-files-of-a-user.ts tags: - admin security: - ApiKeyAuth: [] 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: 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 /admin/drive/clean-remote-files: post: operationId: admin/drive/clean-remote-files summary: admin/drive/clean-remote-files description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/drive/clean-remote-files.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: {} required: [] 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 /admin/drive/cleanup: post: operationId: admin/drive/cleanup summary: admin/drive/cleanup description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/drive/cleanup.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: {} required: [] 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 /admin/drive/files: post: operationId: admin/drive/files summary: admin/drive/files description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/drive/files.ts tags: - admin 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 userId: type: string format: misskey:id nullable: true type: type: string nullable: true pattern: ^[a-zA-Z0-9\/\-*]+$ origin: type: string enum: - combined - local - remote default: local hostname: type: string nullable: true default: null description: The local host is represented with `null`. required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: DriveFile $ref: '#/components/schemas/DriveFile' "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 /admin/drive/show-file: post: operationId: admin/drive/show-file summary: admin/drive/show-file description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/drive/show-file.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object anyOf: - properties: fileId: type: string format: misskey:id required: - fileId - properties: url: type: string required: - url responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false properties: id: type: string optional: false nullable: false format: id example: xxxxxxxxxx createdAt: type: string optional: false nullable: false format: date-time userId: type: string optional: false nullable: true format: id example: xxxxxxxxxx userHost: type: string optional: false nullable: true description: The local host is represented with `null`. md5: type: string optional: false nullable: false format: md5 example: 15eca7fba0480996e2245f5185bf39f2 name: type: string optional: false nullable: false example: lenna.jpg type: type: string optional: false nullable: false example: image/jpeg size: type: number optional: false nullable: false example: 51469 comment: type: string optional: false nullable: true blurhash: type: string optional: false nullable: true properties: type: object optional: false nullable: false properties: width: type: number optional: false nullable: false example: 1280 height: type: number optional: false nullable: false example: 720 avgColor: type: string optional: true nullable: false example: rgb(40,65,87) required: - width - height storedInternal: type: boolean optional: false nullable: true example: true url: type: string optional: false nullable: true format: url thumbnailUrl: type: string optional: false nullable: true format: url webpublicUrl: type: string optional: false nullable: true format: url accessKey: type: string optional: false nullable: false thumbnailAccessKey: type: string optional: false nullable: false webpublicAccessKey: type: string optional: false nullable: false uri: type: string optional: false nullable: true src: type: string optional: false nullable: true folderId: type: string optional: false nullable: true format: id example: xxxxxxxxxx isSensitive: type: boolean optional: false nullable: false isLink: type: boolean optional: false nullable: false required: - id - createdAt - userId - userHost - md5 - name - type - size - comment - blurhash - properties - storedInternal - url - thumbnailUrl - webpublicUrl - accessKey - thumbnailAccessKey - webpublicAccessKey - uri - src - folderId - isSensitive - isLink "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_FILE: value: error: message: No such file. code: NO_SUCH_FILE id: caf3ca38-c6e5-472e-a30c-b05377dcc240 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 /admin/emoji/add-aliases-bulk: post: operationId: admin/emoji/add-aliases-bulk summary: admin/emoji/add-aliases-bulk description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/add-aliases-bulk.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: ids: type: array items: type: string format: misskey:id aliases: type: array items: type: string required: - ids - aliases 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 /admin/emoji/add: post: operationId: admin/emoji/add summary: admin/emoji/add description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/add.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: fileId: type: string format: misskey:id required: - fileId responses: "204": description: OK (without any results) "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: MO_SUCH_FILE: value: error: message: No such file. code: MO_SUCH_FILE id: fc46b5a4-6b92-4c33-ac66-b806659bb5cf 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 /admin/emoji/copy: post: operationId: admin/emoji/copy summary: admin/emoji/copy description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/copy.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: emojiId: type: string format: misskey:id required: - emojiId responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false properties: id: type: string optional: false nullable: false format: id required: - id "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_EMOJI: value: error: message: No such emoji. code: NO_SUCH_EMOJI id: e2785b66-dca3-4087-9cac-b93c541cc425 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 /admin/emoji/delete-bulk: post: operationId: admin/emoji/delete-bulk summary: admin/emoji/delete-bulk description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/delete-bulk.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: ids: type: array items: type: string format: misskey:id required: - ids 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 /admin/emoji/delete: post: operationId: admin/emoji/delete summary: admin/emoji/delete description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/delete.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: id: type: string format: misskey:id required: - id responses: "204": description: OK (without any results) "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_EMOJI: value: error: message: No such emoji. code: NO_SUCH_EMOJI id: be83669b-773a-44b7-b1f8-e5e5170ac3c2 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 /admin/emoji/list-remote: post: operationId: admin/emoji/list-remote summary: admin/emoji/list-remote description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/list-remote.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: query: type: string nullable: true default: null host: type: string nullable: true default: null description: Use `null` to represent the local host. limit: type: integer minimum: 1 maximum: 100 default: 10 sinceId: type: string format: misskey:id untilId: type: string format: misskey:id required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false properties: id: type: string optional: false nullable: false format: id aliases: type: array optional: false nullable: false items: type: string optional: false nullable: false name: type: string optional: false nullable: false category: type: string optional: false nullable: true host: type: string optional: false nullable: true description: The local host is represented with `null`. url: type: string optional: false nullable: false required: - id - aliases - name - category - host - url "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 /admin/emoji/list: post: operationId: admin/emoji/list summary: admin/emoji/list description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/list.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: query: type: string nullable: true default: null limit: type: integer minimum: 1 maximum: 100 default: 10 sinceId: type: string format: misskey:id untilId: type: string format: misskey:id required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false properties: id: type: string optional: false nullable: false format: id aliases: type: array optional: false nullable: false items: type: string optional: false nullable: false name: type: string optional: false nullable: false category: type: string optional: false nullable: true host: type: "null" optional: false description: The local host is represented with `null`. The field exists for compatibility with other API endpoints that return files. url: type: string optional: false nullable: false required: - id - aliases - name - category - host - url "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 /admin/emoji/remove-aliases-bulk: post: operationId: admin/emoji/remove-aliases-bulk summary: admin/emoji/remove-aliases-bulk description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/remove-aliases-bulk.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: ids: type: array items: type: string format: misskey:id aliases: type: array items: type: string required: - ids - aliases 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 /admin/emoji/set-aliases-bulk: post: operationId: admin/emoji/set-aliases-bulk summary: admin/emoji/set-aliases-bulk description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/set-aliases-bulk.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: ids: type: array items: type: string format: misskey:id aliases: type: array items: type: string required: - ids - aliases 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 /admin/emoji/set-category-bulk: post: operationId: admin/emoji/set-category-bulk summary: admin/emoji/set-category-bulk description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/set-category-bulk.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: ids: type: array items: type: string format: misskey:id category: type: string nullable: true description: Use `null` to reset the category. required: - ids 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 /admin/emoji/update: post: operationId: admin/emoji/update summary: admin/emoji/update description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/emoji/update.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: id: type: string format: misskey:id name: type: string category: type: string nullable: true description: Use `null` to reset the category. aliases: type: array items: type: string required: - id - name - aliases responses: "204": description: OK (without any results) "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_EMOJI: value: error: message: No such emoji. code: NO_SUCH_EMOJI id: 684dec9d-a8c2-4364-9aa8-456c49cb1dc8 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 /admin/federation/delete-all-files: post: operationId: admin/federation/delete-all-files summary: admin/federation/delete-all-files description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/federation/delete-all-files.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: host: type: string required: - host 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 /admin/federation/refresh-remote-instance-metadata: post: operationId: admin/federation/refresh-remote-instance-metadata summary: admin/federation/refresh-remote-instance-metadata description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/federation/refresh-remote-instance-metadata.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: host: type: string required: - host 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 /admin/federation/remove-all-following: post: operationId: admin/federation/remove-all-following summary: admin/federation/remove-all-following description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/federation/remove-all-following.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: host: type: string required: - host 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 /admin/federation/update-instance: post: operationId: admin/federation/update-instance summary: admin/federation/update-instance description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/federation/update-instance.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: host: type: string isSuspended: type: boolean required: - host - isSuspended 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 /admin/get-index-stats: post: operationId: admin/get-index-stats summary: admin/get-index-stats description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/get-index-stats.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: {} required: [] 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 /admin/get-table-stats: post: operationId: admin/get-table-stats summary: admin/get-table-stats description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/get-table-stats.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: {} required: [] responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false example: migrations: count: 66 size: 32768 "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 /admin/get-user-ips: post: operationId: admin/get-user-ips summary: admin/get-user-ips description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/get-user-ips.ts tags: - admin security: - ApiKeyAuth: [] 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: 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 /admin/invite: post: operationId: admin/invite summary: admin/invite description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/invite.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: {} required: [] responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false properties: code: type: string optional: false nullable: false example: 2ERUA5VR maxLength: 8 minLength: 8 required: - code "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 /admin/moderators/add: post: operationId: admin/moderators/add summary: admin/moderators/add description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/moderators/add.ts tags: - admin security: - ApiKeyAuth: [] 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: 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 /admin/moderators/remove: post: operationId: admin/moderators/remove summary: admin/moderators/remove description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/moderators/remove.ts tags: - admin security: - ApiKeyAuth: [] 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: 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 /admin/promo/create: post: operationId: admin/promo/create summary: admin/promo/create description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/promo/create.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: noteId: type: string format: misskey:id expiresAt: type: integer required: - noteId - expiresAt responses: "204": description: OK (without any results) "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: ee449fbe-af2a-453b-9cae-cf2fe7c895fc ALREADY_PROMOTED: value: error: message: The note has already promoted. code: ALREADY_PROMOTED id: ae427aa2-7a41-484f-a18c-2c1104051604 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 /admin/queue/clear: post: operationId: admin/queue/clear summary: admin/queue/clear description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/queue/clear.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: {} required: [] 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 /admin/queue/deliver-delayed: post: operationId: admin/queue/deliver-delayed summary: admin/queue/deliver-delayed description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/queue/deliver-delayed.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: {} required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: array optional: false nullable: false items: anyOf: - type: string - type: number example: - - example.com - 12 "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 /admin/queue/inbox-delayed: post: operationId: admin/queue/inbox-delayed summary: admin/queue/inbox-delayed description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/queue/inbox-delayed.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: {} required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: array optional: false nullable: false items: anyOf: - type: string - type: number example: - - example.com - 12 "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 /admin/queue/stats: post: operationId: admin/queue/stats summary: admin/queue/stats description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/queue/stats.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: {} required: [] responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false properties: deliver: optional: false nullable: false ref: QueueCount $ref: '#/components/schemas/QueueCount' inbox: optional: false nullable: false ref: QueueCount $ref: '#/components/schemas/QueueCount' db: optional: false nullable: false ref: QueueCount $ref: '#/components/schemas/QueueCount' objectStorage: optional: false nullable: false ref: QueueCount $ref: '#/components/schemas/QueueCount' required: - deliver - inbox - db - objectStorage "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 /admin/relays/add: post: operationId: admin/relays/add summary: admin/relays/add description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/relays/add.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: inbox: type: string required: - inbox responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false properties: id: type: string optional: false nullable: false format: id inbox: type: string optional: false nullable: false format: url status: type: string optional: false nullable: false default: requesting enum: - requesting - accepted - rejected required: - id - inbox - status "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_URL: value: error: message: Invalid URL code: INVALID_URL id: fb8c92d3-d4e5-44e7-b3d4-800d5cef8b2c 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 /admin/relays/list: post: operationId: admin/relays/list summary: admin/relays/list description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/relays/list.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: {} required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false properties: id: type: string optional: false nullable: false format: id inbox: type: string optional: false nullable: false format: url status: type: string optional: false nullable: false default: requesting enum: - requesting - accepted - rejected required: - id - inbox - status "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 /admin/relays/remove: post: operationId: admin/relays/remove summary: admin/relays/remove description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/relays/remove.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: inbox: type: string required: - inbox 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 /admin/reset-password: post: operationId: admin/reset-password summary: admin/reset-password description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/reset-password.ts tags: - admin security: - ApiKeyAuth: [] 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 optional: false nullable: false properties: password: type: string optional: false nullable: false minLength: 8 maxLength: 8 required: - password "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 /admin/resolve-abuse-user-report: post: operationId: admin/resolve-abuse-user-report summary: admin/resolve-abuse-user-report description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/resolve-abuse-user-report.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: reportId: type: string format: misskey:id forward: type: boolean default: false required: - reportId 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 /admin/send-email: post: operationId: admin/send-email summary: admin/send-email description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/send-email.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: to: type: string subject: type: string text: type: string required: - to - subject - text 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 /admin/server-info: post: operationId: admin/server-info summary: admin/server-info description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/server-info.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: {} required: [] responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false properties: machine: type: string optional: false nullable: false os: type: string optional: false nullable: false example: linux node: type: string optional: false nullable: false psql: type: string optional: false nullable: false cpu: type: object optional: false nullable: false properties: model: type: string optional: false nullable: false cores: type: number optional: false nullable: false required: - model - cores mem: type: object optional: false nullable: false properties: total: type: number optional: false nullable: false format: bytes required: - total fs: type: object optional: false nullable: false properties: total: type: number optional: false nullable: false format: bytes used: type: number optional: false nullable: false format: bytes required: - total - used net: type: object optional: false nullable: false properties: interface: type: string optional: false nullable: false example: eth0 required: - interface required: - machine - os - node - psql - cpu - mem - fs - net "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 /admin/show-moderation-logs: post: operationId: admin/show-moderation-logs summary: admin/show-moderation-logs description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/show-moderation-logs.ts tags: - admin security: - ApiKeyAuth: [] 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 required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false properties: id: type: string optional: false nullable: false format: id createdAt: type: string optional: false nullable: false format: date-time type: type: string optional: false nullable: false info: type: object optional: false nullable: false userId: type: string optional: false nullable: false format: id user: type: object optional: false nullable: false ref: UserDetailed $ref: '#/components/schemas/UserDetailed' required: - id - createdAt - type - info - userId - user "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 /admin/show-user: post: operationId: admin/show-user summary: admin/show-user description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/show-user.ts tags: - admin security: - ApiKeyAuth: [] 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 nullable: false optional: false "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 /admin/show-users: post: operationId: admin/show-users summary: admin/show-users description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/show-users.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 10 offset: type: integer default: 0 sort: type: string enum: - +follower - -follower - +createdAt - -createdAt - +updatedAt - -updatedAt state: type: string enum: - all - alive - available - admin - moderator - adminOrModerator - silenced - suspended default: all origin: type: string enum: - combined - local - remote default: combined username: type: string nullable: true default: null hostname: type: string nullable: true default: null description: The local host is represented with `null`. required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array nullable: false optional: false items: type: object nullable: false optional: false ref: UserDetailed $ref: '#/components/schemas/UserDetailed' "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 /admin/silence-user: post: operationId: admin/silence-user summary: admin/silence-user description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/silence-user.ts tags: - admin security: - ApiKeyAuth: [] 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: 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 /admin/suspend-user: post: operationId: admin/suspend-user summary: admin/suspend-user description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/suspend-user.ts tags: - admin security: - ApiKeyAuth: [] 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: 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 /admin/unsilence-user: post: operationId: admin/unsilence-user summary: admin/unsilence-user description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/unsilence-user.ts tags: - admin security: - ApiKeyAuth: [] 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: 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 /admin/unsuspend-user: post: operationId: admin/unsuspend-user summary: admin/unsuspend-user description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/unsuspend-user.ts tags: - admin security: - ApiKeyAuth: [] 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: 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 /admin/update-meta: post: operationId: admin/update-meta summary: admin/update-meta description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/update-meta.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: disableRegistration: type: boolean nullable: true disableLocalTimeline: type: boolean nullable: true disableGlobalTimeline: type: boolean nullable: true useStarForReactionFallback: type: boolean nullable: true pinnedUsers: type: array nullable: true items: type: string hiddenTags: type: array nullable: true items: type: string blockedHosts: type: array nullable: true items: type: string themeColor: type: string nullable: true pattern: ^#[0-9a-fA-F]{6}$ mascotImageUrl: type: string nullable: true bannerUrl: type: string nullable: true errorImageUrl: type: string nullable: true iconUrl: type: string nullable: true backgroundImageUrl: type: string nullable: true logoImageUrl: type: string nullable: true name: type: string nullable: true description: type: string nullable: true defaultLightTheme: type: string nullable: true defaultDarkTheme: type: string nullable: true localDriveCapacityMb: type: integer remoteDriveCapacityMb: type: integer cacheRemoteFiles: type: boolean emailRequiredForSignup: type: boolean enableHcaptcha: type: boolean hcaptchaSiteKey: type: string nullable: true hcaptchaSecretKey: type: string nullable: true enableRecaptcha: type: boolean recaptchaSiteKey: type: string nullable: true recaptchaSecretKey: type: string nullable: true sensitiveMediaDetection: type: string enum: - none - all - local - remote sensitiveMediaDetectionSensitivity: type: string enum: - medium - low - high - veryLow - veryHigh setSensitiveFlagAutomatically: type: boolean enableSensitiveMediaDetectionForVideos: type: boolean proxyAccountId: type: string format: misskey:id nullable: true maintainerName: type: string nullable: true maintainerEmail: type: string nullable: true pinnedPages: type: array items: type: string pinnedClipId: type: string format: misskey:id nullable: true langs: type: array items: type: string summalyProxy: type: string nullable: true deeplAuthKey: type: string nullable: true deeplIsPro: type: boolean enableTwitterIntegration: type: boolean twitterConsumerKey: type: string nullable: true twitterConsumerSecret: type: string nullable: true enableGithubIntegration: type: boolean githubClientId: type: string nullable: true githubClientSecret: type: string nullable: true enableDiscordIntegration: type: boolean discordClientId: type: string nullable: true discordClientSecret: type: string nullable: true enableEmail: type: boolean email: type: string nullable: true smtpSecure: type: boolean smtpHost: type: string nullable: true smtpPort: type: integer nullable: true smtpUser: type: string nullable: true smtpPass: type: string nullable: true enableServiceWorker: type: boolean swPublicKey: type: string nullable: true swPrivateKey: type: string nullable: true tosUrl: type: string nullable: true repositoryUrl: type: string feedbackUrl: type: string useObjectStorage: type: boolean objectStorageBaseUrl: type: string nullable: true objectStorageBucket: type: string nullable: true objectStoragePrefix: type: string nullable: true objectStorageEndpoint: type: string nullable: true objectStorageRegion: type: string nullable: true objectStoragePort: type: integer nullable: true objectStorageAccessKey: type: string nullable: true objectStorageSecretKey: type: string nullable: true objectStorageUseSSL: type: boolean objectStorageUseProxy: type: boolean objectStorageSetPublicRead: type: boolean objectStorageS3ForcePathStyle: type: boolean enableIpLogging: type: boolean enableActiveEmailValidation: type: boolean required: [] 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 /admin/vacuum: post: operationId: admin/vacuum summary: admin/vacuum description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/vacuum.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: full: type: boolean analyze: type: boolean required: - full - analyze 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 /admin/delete-account: post: operationId: admin/delete-account summary: admin/delete-account description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/delete-account.ts tags: - admin security: - ApiKeyAuth: [] 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: {} "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 /admin/update-user-note: post: operationId: admin/update-user-note summary: admin/update-user-note description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/update-user-note.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: userId: type: string format: misskey:id text: type: string required: - userId - text 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 /announcements: post: operationId: announcements summary: announcements description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/announcements.ts tags: - meta requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 10 withUnreads: type: boolean default: false sinceId: type: string format: misskey:id untilId: type: string format: misskey:id required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false properties: id: type: string optional: false nullable: false format: id example: xxxxxxxxxx createdAt: type: string optional: false nullable: false format: date-time updatedAt: type: string optional: false nullable: true format: date-time text: type: string optional: false nullable: false title: type: string optional: false nullable: false imageUrl: type: string optional: false nullable: true isRead: type: boolean optional: true nullable: false required: - id - createdAt - updatedAt - text - title - imageUrl "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 /antennas/create: post: operationId: antennas/create summary: antennas/create description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/antennas/create.ts tags: - antennas security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 100 src: type: string enum: - home - all - users - list - group userListId: type: string format: misskey:id nullable: true userGroupId: type: string format: misskey:id nullable: true keywords: type: array items: type: array items: type: string excludeKeywords: type: array items: type: array items: type: string users: type: array items: type: string caseSensitive: type: boolean withReplies: type: boolean withFile: type: boolean notify: type: boolean required: - name - src - keywords - excludeKeywords - users - caseSensitive - withReplies - withFile - notify responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false ref: Antenna $ref: '#/components/schemas/Antenna' "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_USER_LIST: value: error: message: No such user list. code: NO_SUCH_USER_LIST id: 95063e93-a283-4b8b-9aa5-bcdb8df69a7f NO_SUCH_USER_GROUP: value: error: message: No such user group. code: NO_SUCH_USER_GROUP id: aa3c0b9a-8cae-47c0-92ac-202ce5906682 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 /antennas/delete: post: operationId: antennas/delete summary: antennas/delete description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/antennas/delete.ts tags: - antennas security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: antennaId: type: string format: misskey:id required: - antennaId responses: "204": description: OK (without any results) "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_ANTENNA: value: error: message: No such antenna. code: NO_SUCH_ANTENNA id: b34dcf9d-348f-44bb-99d0-6c9314cfe2df 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 /antennas/list: post: operationId: antennas/list summary: antennas/list description: |- No description provided. **Credential required**: *Yes* / **Permission**: *read:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/antennas/list.ts tags: - antennas security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: {} required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Antenna $ref: '#/components/schemas/Antenna' "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 /antennas/notes: post: operationId: antennas/notes summary: antennas/notes description: |- No description provided. **Credential required**: *Yes* / **Permission**: *read:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/antennas/notes.ts tags: - antennas security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: antennaId: 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 sinceDate: type: integer untilDate: type: integer required: - antennaId responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Note $ref: '#/components/schemas/Note' "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_ANTENNA: value: error: message: No such antenna. code: NO_SUCH_ANTENNA id: 850926e0-fd3b-49b6-b69a-b28a5dbd82fe 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 /antennas/show: post: operationId: antennas/show summary: antennas/show description: |- No description provided. **Credential required**: *Yes* / **Permission**: *read:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/antennas/show.ts tags: - antennas security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: antennaId: type: string format: misskey:id required: - antennaId responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false ref: Antenna $ref: '#/components/schemas/Antenna' "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_ANTENNA: value: error: message: No such antenna. code: NO_SUCH_ANTENNA id: c06569fb-b025-4f23-b22d-1fcd20d2816b 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 /antennas/update: post: operationId: antennas/update summary: antennas/update description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/antennas/update.ts tags: - antennas security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: antennaId: type: string format: misskey:id name: type: string minLength: 1 maxLength: 100 src: type: string enum: - home - all - users - list - group userListId: type: string format: misskey:id nullable: true userGroupId: type: string format: misskey:id nullable: true keywords: type: array items: type: array items: type: string excludeKeywords: type: array items: type: array items: type: string users: type: array items: type: string caseSensitive: type: boolean withReplies: type: boolean withFile: type: boolean notify: type: boolean required: - antennaId - name - src - keywords - excludeKeywords - users - caseSensitive - withReplies - withFile - notify responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false ref: Antenna $ref: '#/components/schemas/Antenna' "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_ANTENNA: value: error: message: No such antenna. code: NO_SUCH_ANTENNA id: 10c673ac-8852-48eb-aa1f-f5b67f069290 NO_SUCH_USER_LIST: value: error: message: No such user list. code: NO_SUCH_USER_LIST id: 1c6b35c9-943e-48c2-81e4-2844989407f7 NO_SUCH_USER_GROUP: value: error: message: No such user group. code: NO_SUCH_USER_GROUP id: 109ed789-b6eb-456e-b8a9-6059d567d385 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 /ap/get: post: operationId: ap/get summary: ap/get description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/ap/get.ts tags: - federation security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: uri: type: string required: - uri responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false "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: To 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 /ap/show: post: operationId: ap/show summary: ap/show description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/ap/show.ts tags: - federation security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: uri: type: string required: - uri responses: "200": description: OK (with results) content: application/json: schema: optional: false nullable: false oneOf: - type: object properties: type: type: string optional: false nullable: false enum: - User object: type: object optional: false nullable: false ref: UserDetailedNotMe $ref: '#/components/schemas/UserDetailedNotMe' required: - type - object - type: object properties: type: type: string optional: false nullable: false enum: - Note object: type: object optional: false nullable: false ref: Note $ref: '#/components/schemas/Note' required: - type - object "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_OBJECT: value: error: message: No such object. code: NO_SUCH_OBJECT id: dc94d745-1262-4e63-a17d-fecaa57efc82 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: To 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 /app/create: post: operationId: app/create summary: app/create description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/app/create.ts tags: - app requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: type: string permission: type: array uniqueItems: true items: type: string callbackUrl: type: string nullable: true required: - name - description - permission responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false ref: App $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 /app/show: post: operationId: app/show summary: app/show description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/app/show.ts tags: - app requestBody: required: true content: application/json: schema: type: object properties: appId: type: string format: misskey:id required: - appId responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false ref: App $ref: '#/components/schemas/App' "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_APP: value: error: message: No such app. code: NO_SUCH_APP id: dce83913-2dc6-4093-8a7b-71dbb11718a3 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 /auth/session/generate: post: operationId: auth/session/generate summary: auth/session/generate description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/auth/session/generate.ts tags: - auth requestBody: required: true content: application/json: schema: type: object properties: appSecret: type: string required: - appSecret responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false properties: token: type: string optional: false nullable: false url: type: string optional: false nullable: false format: url required: - token - url "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_APP: value: error: message: No such app. code: NO_SUCH_APP id: 92f93e63-428e-4f2f-a5a4-39e1407fe998 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 /auth/session/show: post: operationId: auth/session/show summary: auth/session/show description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/auth/session/show.ts tags: - auth requestBody: required: true content: application/json: schema: type: object properties: token: type: string required: - token responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false properties: id: type: string optional: false nullable: false format: id app: type: object optional: false nullable: false ref: App $ref: '#/components/schemas/App' token: type: string optional: false nullable: false required: - id - app - token "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_SESSION: value: error: message: No such session. code: NO_SUCH_SESSION id: bd72c97d-eba7-4adb-a467-f171b8847250 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 /auth/session/userkey: post: operationId: auth/session/userkey summary: auth/session/userkey description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/auth/session/userkey.ts tags: - auth requestBody: required: true content: application/json: schema: type: object properties: appSecret: type: string token: type: string required: - appSecret - token responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false properties: accessToken: type: string optional: false nullable: false user: type: object optional: false nullable: false ref: UserDetailedNotMe $ref: '#/components/schemas/UserDetailedNotMe' required: - accessToken - user "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_APP: value: error: message: No such app. code: NO_SUCH_APP id: fcab192a-2c5a-43b7-8ad8-9b7054d8d40d NO_SUCH_SESSION: value: error: message: No such session. code: NO_SUCH_SESSION id: 5b5a1503-8bc8-4bd0-8054-dc189e8cdcb3 PENDING_SESSION: value: error: message: This session is not completed yet. code: PENDING_SESSION id: 8c8a4145-02cc-4cca-8e66-29ba60445a8e 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 /blocking/create: post: operationId: blocking/create summary: blocking/create description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:blocks* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/blocking/create.ts tags: - account security: - ApiKeyAuth: [] 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 optional: false nullable: false ref: UserDetailedNotMe $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: To 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: blocking/delete summary: blocking/delete description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:blocks* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/blocking/delete.ts tags: - account security: - ApiKeyAuth: [] 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 optional: false nullable: false ref: UserDetailedNotMe $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: To 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: blocking/list summary: blocking/list description: |- No description provided. **Credential required**: *Yes* / **Permission**: *read:blocks* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/blocking/list.ts tags: - account security: - ApiKeyAuth: [] 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 required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Blocking $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 /channels/create: post: operationId: channels/create summary: channels/create description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:channels* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/channels/create.ts tags: - channels security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 128 description: type: string nullable: true minLength: 1 maxLength: 2048 bannerId: type: string format: misskey:id nullable: true required: - name responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false ref: Channel $ref: '#/components/schemas/Channel' "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_FILE: value: error: message: No such file. code: NO_SUCH_FILE id: cd1e9f3e-5a12-4ab4-96f6-5d0a2cc32050 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 /channels/featured: post: operationId: channels/featured summary: channels/featured description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/channels/featured.ts tags: - channels requestBody: required: true content: application/json: schema: type: object properties: {} required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Channel $ref: '#/components/schemas/Channel' "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 /channels/follow: post: operationId: channels/follow summary: channels/follow description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:channels* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/channels/follow.ts tags: - channels security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: channelId: type: string format: misskey:id required: - channelId responses: "204": description: OK (without any results) "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_CHANNEL: value: error: message: No such channel. code: NO_SUCH_CHANNEL id: c0031718-d573-4e85-928e-10039f1fbb68 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 /channels/followed: post: operationId: channels/followed summary: channels/followed description: |- No description provided. **Credential required**: *Yes* / **Permission**: *read:channels* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/channels/followed.ts tags: - channels security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: sinceId: type: string format: misskey:id untilId: type: string format: misskey:id limit: type: integer minimum: 1 maximum: 100 default: 5 required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Channel $ref: '#/components/schemas/Channel' "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 /channels/owned: post: operationId: channels/owned summary: channels/owned description: |- No description provided. **Credential required**: *Yes* / **Permission**: *read:channels* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/channels/owned.ts tags: - channels security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: sinceId: type: string format: misskey:id untilId: type: string format: misskey:id limit: type: integer minimum: 1 maximum: 100 default: 5 required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Channel $ref: '#/components/schemas/Channel' "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 /channels/show: post: operationId: channels/show summary: channels/show description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/channels/show.ts tags: - channels requestBody: required: true content: application/json: schema: type: object properties: channelId: type: string format: misskey:id required: - channelId responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false ref: Channel $ref: '#/components/schemas/Channel' "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_CHANNEL: value: error: message: No such channel. code: NO_SUCH_CHANNEL id: 6f6c314b-7486-4897-8966-c04a66a02923 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 /channels/timeline: post: operationId: channels/timeline summary: channels/timeline description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/channels/timeline.ts tags: - notes requestBody: required: true content: application/json: schema: type: object properties: channelId: 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 sinceDate: type: integer untilDate: type: integer required: - channelId responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Note $ref: '#/components/schemas/Note' "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_CHANNEL: value: error: message: No such channel. code: NO_SUCH_CHANNEL id: 4d0eeeba-a02c-4c3c-9966-ef60d38d2e7f 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 /channels/unfollow: post: operationId: channels/unfollow summary: channels/unfollow description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:channels* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/channels/unfollow.ts tags: - channels security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: channelId: type: string format: misskey:id required: - channelId responses: "204": description: OK (without any results) "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_CHANNEL: value: error: message: No such channel. code: NO_SUCH_CHANNEL id: 19959ee9-0153-4c51-bbd9-a98c49dc59d6 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 /channels/update: post: operationId: channels/update summary: channels/update description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:channels* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/channels/update.ts tags: - channels security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: channelId: type: string format: misskey:id name: type: string minLength: 1 maxLength: 128 description: type: string nullable: true minLength: 1 maxLength: 2048 bannerId: type: string format: misskey:id nullable: true required: - channelId responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false ref: Channel $ref: '#/components/schemas/Channel' "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_CHANNEL: value: error: message: No such channel. code: NO_SUCH_CHANNEL id: f9c5467f-d492-4c3c-9a8d-a70dacc86512 ACCESS_DENIED: value: error: message: You do not have edit privilege of the channel. code: ACCESS_DENIED id: 1fb7cb09-d46a-4fdf-b8df-057788cce513 NO_SUCH_FILE: value: error: message: No such file. code: NO_SUCH_FILE id: e86c14a4-0da2-4032-8df3-e737a04c7f3b 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 /charts/active-users: post: operationId: charts/active-users summary: charts/active-users description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/charts/active-users.ts tags: - charts requestBody: required: true content: application/json: schema: type: object properties: span: type: string enum: - day - hour limit: type: integer minimum: 1 maximum: 500 default: 30 offset: type: integer nullable: true default: null required: - span responses: "200": description: OK (with results) content: application/json: schema: type: object properties: readWrite: type: array items: type: number read: type: array items: type: number write: type: array items: type: number registeredWithinWeek: type: array items: type: number registeredWithinMonth: type: array items: type: number registeredWithinYear: type: array items: type: number registeredOutsideWeek: type: array items: type: number registeredOutsideMonth: type: array items: type: number registeredOutsideYear: type: array items: type: number required: - readWrite - read - write - registeredWithinWeek - registeredWithinMonth - registeredWithinYear - registeredOutsideWeek - registeredOutsideMonth - registeredOutsideYear "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 /charts/ap-request: post: operationId: charts/ap-request summary: charts/ap-request description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/charts/ap-request.ts tags: - charts requestBody: required: true content: application/json: schema: type: object properties: span: type: string enum: - day - hour limit: type: integer minimum: 1 maximum: 500 default: 30 offset: type: integer nullable: true default: null required: - span responses: "200": description: OK (with results) content: application/json: schema: type: object properties: deliverFailed: type: array items: type: number deliverSucceeded: type: array items: type: number inboxReceived: type: array items: type: number required: - deliverFailed - deliverSucceeded - inboxReceived "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 /charts/drive: post: operationId: charts/drive summary: charts/drive description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/charts/drive.ts tags: - charts requestBody: required: true content: application/json: schema: type: object properties: span: type: string enum: - day - hour limit: type: integer minimum: 1 maximum: 500 default: 30 offset: type: integer nullable: true default: null required: - span responses: "200": description: OK (with results) content: application/json: schema: type: object properties: local.incCount: type: array items: type: number local.incSize: type: array items: type: number local.decCount: type: array items: type: number local.decSize: type: array items: type: number remote.incCount: type: array items: type: number remote.incSize: type: array items: type: number remote.decCount: type: array items: type: number remote.decSize: type: array items: type: number required: - local.incCount - local.incSize - local.decCount - local.decSize - remote.incCount - remote.incSize - remote.decCount - remote.decSize "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 /charts/federation: post: operationId: charts/federation summary: charts/federation description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/charts/federation.ts tags: - charts requestBody: required: true content: application/json: schema: type: object properties: span: type: string enum: - day - hour limit: type: integer minimum: 1 maximum: 500 default: 30 offset: type: integer nullable: true default: null required: - span responses: "200": description: OK (with results) content: application/json: schema: type: object properties: deliveredInstances: type: array items: type: number inboxInstances: type: array items: type: number stalled: type: array items: type: number sub: type: array items: type: number pub: type: array items: type: number pubsub: type: array items: type: number subActive: type: array items: type: number pubActive: type: array items: type: number required: - deliveredInstances - inboxInstances - stalled - sub - pub - pubsub - subActive - pubActive "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 /charts/hashtag: post: operationId: charts/hashtag summary: charts/hashtag description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/charts/hashtag.ts tags: - charts requestBody: required: true content: application/json: schema: type: object properties: span: type: string enum: - day - hour limit: type: integer minimum: 1 maximum: 500 default: 30 offset: type: integer nullable: true default: null tag: type: string required: - span - tag responses: "200": description: OK (with results) content: application/json: schema: type: object properties: local.users: type: array items: type: number remote.users: type: array items: type: number required: - local.users - remote.users "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 /charts/instance: post: operationId: charts/instance summary: charts/instance description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/charts/instance.ts tags: - charts requestBody: required: true content: application/json: schema: type: object properties: span: type: string enum: - day - hour limit: type: integer minimum: 1 maximum: 500 default: 30 offset: type: integer nullable: true default: null host: type: string required: - span - host responses: "200": description: OK (with results) content: application/json: schema: type: object properties: requests.failed: type: array items: type: number requests.succeeded: type: array items: type: number requests.received: type: array items: type: number notes.total: type: array items: type: number notes.inc: type: array items: type: number notes.dec: type: array items: type: number notes.diffs.normal: type: array items: type: number notes.diffs.reply: type: array items: type: number notes.diffs.renote: type: array items: type: number notes.diffs.withFile: type: array items: type: number users.total: type: array items: type: number users.inc: type: array items: type: number users.dec: type: array items: type: number following.total: type: array items: type: number following.inc: type: array items: type: number following.dec: type: array items: type: number followers.total: type: array items: type: number followers.inc: type: array items: type: number followers.dec: type: array items: type: number drive.totalFiles: type: array items: type: number drive.incFiles: type: array items: type: number drive.decFiles: type: array items: type: number drive.incUsage: type: array items: type: number drive.decUsage: type: array items: type: number required: - requests.failed - requests.succeeded - requests.received - notes.total - notes.inc - notes.dec - notes.diffs.normal - notes.diffs.reply - notes.diffs.renote - notes.diffs.withFile - users.total - users.inc - users.dec - following.total - following.inc - following.dec - followers.total - followers.inc - followers.dec - drive.totalFiles - drive.incFiles - drive.decFiles - drive.incUsage - drive.decUsage "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 /charts/notes: post: operationId: charts/notes summary: charts/notes description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/charts/notes.ts tags: - charts requestBody: required: true content: application/json: schema: type: object properties: span: type: string enum: - day - hour limit: type: integer minimum: 1 maximum: 500 default: 30 offset: type: integer nullable: true default: null required: - span responses: "200": description: OK (with results) content: application/json: schema: type: object properties: local.total: type: array items: type: number local.inc: type: array items: type: number local.dec: type: array items: type: number local.diffs.normal: type: array items: type: number local.diffs.reply: type: array items: type: number local.diffs.renote: type: array items: type: number local.diffs.withFile: type: array items: type: number remote.total: type: array items: type: number remote.inc: type: array items: type: number remote.dec: type: array items: type: number remote.diffs.normal: type: array items: type: number remote.diffs.reply: type: array items: type: number remote.diffs.renote: type: array items: type: number remote.diffs.withFile: type: array items: type: number required: - local.total - local.inc - local.dec - local.diffs.normal - local.diffs.reply - local.diffs.renote - local.diffs.withFile - remote.total - remote.inc - remote.dec - remote.diffs.normal - remote.diffs.reply - remote.diffs.renote - remote.diffs.withFile "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 /charts/user/drive: post: operationId: charts/user/drive summary: charts/user/drive description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/charts/user/drive.ts tags: - charts requestBody: required: true content: application/json: schema: type: object properties: span: type: string enum: - day - hour limit: type: integer minimum: 1 maximum: 500 default: 30 offset: type: integer nullable: true default: null userId: type: string format: misskey:id required: - span - userId responses: "200": description: OK (with results) content: application/json: schema: type: object properties: totalCount: type: array items: type: number totalSize: type: array items: type: number incCount: type: array items: type: number incSize: type: array items: type: number decCount: type: array items: type: number decSize: type: array items: type: number required: - totalCount - totalSize - incCount - incSize - decCount - decSize "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 /charts/user/following: post: operationId: charts/user/following summary: charts/user/following description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/charts/user/following.ts tags: - charts requestBody: required: true content: application/json: schema: type: object properties: span: type: string enum: - day - hour limit: type: integer minimum: 1 maximum: 500 default: 30 offset: type: integer nullable: true default: null userId: type: string format: misskey:id required: - span - userId responses: "200": description: OK (with results) content: application/json: schema: type: object properties: local.followings.total: type: array items: type: number local.followings.inc: type: array items: type: number local.followings.dec: type: array items: type: number local.followers.total: type: array items: type: number local.followers.inc: type: array items: type: number local.followers.dec: type: array items: type: number remote.followings.total: type: array items: type: number remote.followings.inc: type: array items: type: number remote.followings.dec: type: array items: type: number remote.followers.total: type: array items: type: number remote.followers.inc: type: array items: type: number remote.followers.dec: type: array items: type: number required: - local.followings.total - local.followings.inc - local.followings.dec - local.followers.total - local.followers.inc - local.followers.dec - remote.followings.total - remote.followings.inc - remote.followings.dec - remote.followers.total - remote.followers.inc - remote.followers.dec "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 /charts/user/notes: post: operationId: charts/user/notes summary: charts/user/notes description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/charts/user/notes.ts tags: - charts requestBody: required: true content: application/json: schema: type: object properties: span: type: string enum: - day - hour limit: type: integer minimum: 1 maximum: 500 default: 30 offset: type: integer nullable: true default: null userId: type: string format: misskey:id required: - span - userId responses: "200": description: OK (with results) content: application/json: schema: type: object properties: total: type: array items: type: number inc: type: array items: type: number dec: type: array items: type: number diffs.normal: type: array items: type: number diffs.reply: type: array items: type: number diffs.renote: type: array items: type: number diffs.withFile: type: array items: type: number required: - total - inc - dec - diffs.normal - diffs.reply - diffs.renote - diffs.withFile "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 /charts/user/reactions: post: operationId: charts/user/reactions summary: charts/user/reactions description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/charts/user/reactions.ts tags: - charts requestBody: required: true content: application/json: schema: type: object properties: span: type: string enum: - day - hour limit: type: integer minimum: 1 maximum: 500 default: 30 offset: type: integer nullable: true default: null userId: type: string format: misskey:id required: - span - userId responses: "200": description: OK (with results) content: application/json: schema: type: object properties: local.count: type: array items: type: number remote.count: type: array items: type: number required: - local.count - remote.count "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 /charts/users: post: operationId: charts/users summary: charts/users description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/charts/users.ts tags: - charts requestBody: required: true content: application/json: schema: type: object properties: span: type: string enum: - day - hour limit: type: integer minimum: 1 maximum: 500 default: 30 offset: type: integer nullable: true default: null required: - span responses: "200": description: OK (with results) content: application/json: schema: type: object properties: local.total: type: array items: type: number local.inc: type: array items: type: number local.dec: type: array items: type: number remote.total: type: array items: type: number remote.inc: type: array items: type: number remote.dec: type: array items: type: number required: - local.total - local.inc - local.dec - remote.total - remote.inc - remote.dec "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: 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/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/clips/add-note.ts tags: - account security: - ApiKeyAuth: [] 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 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: 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/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/clips/remove-note.ts tags: - account security: - ApiKeyAuth: [] 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 /clips/create: post: operationId: clips/create summary: clips/create description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/clips/create.ts tags: - clips security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 100 isPublic: type: boolean default: false description: type: string nullable: true minLength: 1 maxLength: 2048 required: - name responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false ref: Clip $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/delete: post: operationId: clips/delete summary: clips/delete description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/clips/delete.ts tags: - clips security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: clipId: type: string format: misskey:id required: - clipId 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: 70ca08ba-6865-4630-b6fb-8494759aa754 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/list: post: operationId: clips/list summary: clips/list description: |- No description provided. **Credential required**: *Yes* / **Permission**: *read:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/clips/list.ts tags: - clips security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: {} required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Clip $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: clips/notes summary: clips/notes description: |- No description provided. **Credential required**: *No* / **Permission**: *read:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/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 optional: false nullable: false items: type: object optional: false nullable: false ref: Note $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/show: post: operationId: clips/show summary: clips/show description: |- No description provided. **Credential required**: *No* / **Permission**: *read:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/clips/show.ts tags: - clips requestBody: required: true content: application/json: schema: type: object properties: clipId: type: string format: misskey:id required: - clipId responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false ref: Clip $ref: '#/components/schemas/Clip' "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: c3c5fe33-d62c-44d2-9ea5-d997703f5c20 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/update: post: operationId: clips/update summary: clips/update description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/clips/update.ts tags: - clips security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: clipId: type: string format: misskey:id name: type: string minLength: 1 maxLength: 100 isPublic: type: boolean description: type: string nullable: true minLength: 1 maxLength: 2048 required: - clipId - name responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false ref: Clip $ref: '#/components/schemas/Clip' "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: b4d92d70-b216-46fa-9a3f-a8c811699257 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 /drive: post: operationId: drive summary: drive description: |- No description provided. **Credential required**: *Yes* / **Permission**: *read:drive* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/drive.ts tags: - drive security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: {} required: [] responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false properties: capacity: type: number optional: false nullable: false usage: type: number optional: false nullable: false required: - capacity - usage "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 /drive/files: post: operationId: drive/files summary: drive/files description: |- No description provided. **Credential required**: *Yes* / **Permission**: *read:drive* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/drive/files.ts tags: - drive security: - ApiKeyAuth: [] 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 folderId: type: string format: misskey:id nullable: true default: null type: type: string nullable: true pattern: ^[a-zA-Z\/\-*]+$ required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: DriveFile $ref: '#/components/schemas/DriveFile' "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 /drive/files/attached-notes: post: operationId: drive/files/attached-notes summary: drive/files/attached-notes description: |- Find the notes to which the given file is attached. **Credential required**: *Yes* / **Permission**: *read:drive* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/drive/files/attached-notes.ts tags: - drive security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: fileId: type: string format: misskey:id required: - fileId responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Note $ref: '#/components/schemas/Note' "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_FILE: value: error: message: No such file. code: NO_SUCH_FILE id: c118ece3-2e4b-4296-99d1-51756e32d232 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 /drive/files/check-existence: post: operationId: drive/files/check-existence summary: drive/files/check-existence description: |- Check if a given file exists. **Credential required**: *Yes* / **Permission**: *read:drive* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/drive/files/check-existence.ts tags: - drive security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: md5: type: string required: - md5 responses: "200": description: OK (with results) content: application/json: schema: type: boolean optional: false nullable: false "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 /drive/files/create: post: operationId: drive/files/create summary: drive/files/create description: |- Upload a new drive file. **Credential required**: *Yes* / **Permission**: *write:drive* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/drive/files/create.ts tags: - drive security: - ApiKeyAuth: [] requestBody: required: true content: multipart/form-data: schema: type: object properties: folderId: type: string format: misskey:id nullable: true default: null name: type: string nullable: true default: null comment: type: string nullable: true maxLength: 512 default: null isSensitive: type: boolean default: false force: type: boolean default: false file: type: string format: binary description: The file contents. required: - file responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false ref: DriveFile $ref: '#/components/schemas/DriveFile' "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_FILE_NAME: value: error: message: Invalid file name. code: INVALID_FILE_NAME id: f449b209-0c60-4e51-84d5-29486263bfd4 INAPPROPRIATE: value: error: message: Cannot upload the file because it has been determined that it possibly contains inappropriate content. code: INAPPROPRIATE id: bec5bd69-fba3-43c9-b4fb-2894b66ad5d2 NO_FREE_SPACE: value: error: message: Cannot upload the file because you have no free space of drive. code: NO_FREE_SPACE id: d08dbc37-a6a9-463a-8c47-96c32ab5f064 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: To 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 /drive/files/delete: post: operationId: drive/files/delete summary: drive/files/delete description: |- Delete an existing drive file. **Credential required**: *Yes* / **Permission**: *write:drive* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/drive/files/delete.ts tags: - drive security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: fileId: type: string format: misskey:id required: - fileId responses: "204": description: OK (without any results) "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_FILE: value: error: message: No such file. code: NO_SUCH_FILE id: 908939ec-e52b-4458-b395-1025195cea58 ACCESS_DENIED: value: error: message: Access denied. code: ACCESS_DENIED id: 5eb8d909-2540-4970-90b8-dd6f86088121 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 /drive/files/find-by-hash: post: operationId: drive/files/find-by-hash summary: drive/files/find-by-hash description: |- Search for a drive file by a hash of the contents. **Credential required**: *Yes* / **Permission**: *read:drive* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/drive/files/find-by-hash.ts tags: - drive security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: md5: type: string required: - md5 responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: DriveFile $ref: '#/components/schemas/DriveFile' "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 /drive/files/find: post: operationId: drive/files/find summary: drive/files/find description: |- Search for a drive file by the given parameters. **Credential required**: *Yes* / **Permission**: *read:drive* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/drive/files/find.ts tags: - drive security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: name: type: string folderId: type: string format: misskey:id nullable: true default: null required: - name responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: DriveFile $ref: '#/components/schemas/DriveFile' "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 /drive/files/show: post: operationId: drive/files/show summary: drive/files/show description: |- Show the properties of a drive file. **Credential required**: *Yes* / **Permission**: *read:drive* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/drive/files/show.ts tags: - drive security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object anyOf: - properties: fileId: type: string format: misskey:id required: - fileId - properties: url: type: string required: - url responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false ref: DriveFile $ref: '#/components/schemas/DriveFile' "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_FILE: value: error: message: No such file. code: NO_SUCH_FILE id: 067bc436-2718-4795-b0fb-ecbe43949e31 ACCESS_DENIED: value: error: message: Access denied. code: ACCESS_DENIED id: 25b73c73-68b1-41d0-bad1-381cfdf6579f 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 /drive/files/update: post: operationId: drive/files/update summary: drive/files/update description: |- Update the properties of a drive file. **Credential required**: *Yes* / **Permission**: *write:drive* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/drive/files/update.ts tags: - drive security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: fileId: type: string format: misskey:id folderId: type: string format: misskey:id nullable: true name: type: string isSensitive: type: boolean comment: type: string nullable: true maxLength: 512 required: - fileId responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false ref: DriveFile $ref: '#/components/schemas/DriveFile' "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INVALID_FILE_NAME: value: error: message: Invalid file name. code: INVALID_FILE_NAME id: 395e7156-f9f0-475e-af89-53c3c23080c2 NO_SUCH_FILE: value: error: message: No such file. code: NO_SUCH_FILE id: e7778c7e-3af9-49cd-9690-6dbc3e6c972d ACCESS_DENIED: value: error: message: Access denied. code: ACCESS_DENIED id: 01a53b27-82fc-445b-a0c1-b558465a8ed2 NO_SUCH_FOLDER: value: error: message: No such folder. code: NO_SUCH_FOLDER id: ea8fb7a5-af77-4a08-b608-c0218176cd73 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 /drive/files/upload-from-url: post: operationId: drive/files/upload-from-url summary: drive/files/upload-from-url description: |- Request the server to download a new drive file from the specified URL. **Credential required**: *Yes* / **Permission**: *write:drive* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/drive/files/upload-from-url.ts tags: - drive security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: url: type: string folderId: type: string format: misskey:id nullable: true default: null isSensitive: type: boolean default: false comment: type: string nullable: true maxLength: 512 default: null marker: type: string nullable: true default: null force: type: boolean default: false required: - url 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 "429": description: To 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 /drive/folders: post: operationId: drive/folders summary: drive/folders description: |- No description provided. **Credential required**: *Yes* / **Permission**: *read:drive* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/drive/folders.ts tags: - drive security: - ApiKeyAuth: [] 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 folderId: type: string format: misskey:id nullable: true default: null required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: DriveFolder $ref: '#/components/schemas/DriveFolder' "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 /drive/folders/create: post: operationId: drive/folders/create summary: drive/folders/create description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:drive* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/drive/folders/create.ts tags: - drive security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: name: type: string default: Untitled maxLength: 200 parentId: type: string format: misskey:id nullable: true required: [] responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false ref: DriveFolder $ref: '#/components/schemas/DriveFolder' "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_FOLDER: value: error: message: No such folder. code: NO_SUCH_FOLDER id: 53326628-a00d-40a6-a3cd-8975105c0f95 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 /drive/folders/delete: post: operationId: drive/folders/delete summary: drive/folders/delete description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:drive* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/drive/folders/delete.ts tags: - drive security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: folderId: type: string format: misskey:id required: - folderId responses: "204": description: OK (without any results) "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_FOLDER: value: error: message: No such folder. code: NO_SUCH_FOLDER id: 1069098f-c281-440f-b085-f9932edbe091 HAS_CHILD_FILES_OR_FOLDERS: value: error: message: This folder has child files or folders. code: HAS_CHILD_FILES_OR_FOLDERS id: b0fc8a17-963c-405d-bfbc-859a487295e1 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 /drive/folders/find: post: operationId: drive/folders/find summary: drive/folders/find description: |- No description provided. **Credential required**: *Yes* / **Permission**: *read:drive* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/drive/folders/find.ts tags: - drive security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: name: type: string parentId: type: string format: misskey:id nullable: true default: null required: - name responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: DriveFolder $ref: '#/components/schemas/DriveFolder' "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 /drive/folders/show: post: operationId: drive/folders/show summary: drive/folders/show description: |- No description provided. **Credential required**: *Yes* / **Permission**: *read:drive* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/drive/folders/show.ts tags: - drive security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: folderId: type: string format: misskey:id required: - folderId responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false ref: DriveFolder $ref: '#/components/schemas/DriveFolder' "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_FOLDER: value: error: message: No such folder. code: NO_SUCH_FOLDER id: d74ab9eb-bb09-4bba-bf24-fb58f761e1e9 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 /drive/folders/update: post: operationId: drive/folders/update summary: drive/folders/update description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:drive* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/drive/folders/update.ts tags: - drive security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: folderId: type: string format: misskey:id name: type: string maxLength: 200 parentId: type: string format: misskey:id nullable: true required: - folderId responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false ref: DriveFolder $ref: '#/components/schemas/DriveFolder' "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_FOLDER: value: error: message: No such folder. code: NO_SUCH_FOLDER id: f7974dac-2c0d-4a27-926e-23583b28e98e NO_SUCH_PARENT_FOLDER: value: error: message: It can not be structured like nesting folders recursively. code: NO_SUCH_PARENT_FOLDER id: ce104e3a-faaf-49d5-b459-10ff0cbbcaa1 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 /drive/stream: post: operationId: drive/stream summary: drive/stream description: |- No description provided. **Credential required**: *Yes* / **Permission**: *read:drive* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/drive/stream.ts tags: - drive security: - ApiKeyAuth: [] 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 type: type: string pattern: ^[a-zA-Z\/\-*]+$ required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: DriveFile $ref: '#/components/schemas/DriveFile' "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 /email-address/available: post: operationId: email-address/available summary: email-address/available description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/email-address/available.ts tags: - users requestBody: required: true content: application/json: schema: type: object properties: emailAddress: type: string required: - emailAddress responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false properties: available: type: boolean optional: false nullable: false reason: type: string optional: false nullable: true required: - available - reason "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 /endpoint: post: operationId: endpoint summary: endpoint description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/endpoint.ts tags: - meta 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 /endpoints: post: operationId: endpoints summary: endpoints description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/endpoints.ts tags: - meta requestBody: required: true content: application/json: schema: type: object properties: {} required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: string optional: false nullable: false example: - admin/abuse-user-reports - admin/accounts/create - admin/announcements/create - '...' "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 /federation/followers: post: operationId: federation/followers summary: federation/followers description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/federation/followers.ts tags: - federation requestBody: required: true content: application/json: schema: type: object properties: host: type: string sinceId: type: string format: misskey:id untilId: type: string format: misskey:id limit: type: integer minimum: 1 maximum: 100 default: 10 required: - host responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Following $ref: '#/components/schemas/Following' "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 /federation/following: post: operationId: federation/following summary: federation/following description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/federation/following.ts tags: - federation requestBody: required: true content: application/json: schema: type: object properties: host: type: string sinceId: type: string format: misskey:id untilId: type: string format: misskey:id limit: type: integer minimum: 1 maximum: 100 default: 10 required: - host responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Following $ref: '#/components/schemas/Following' "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 /federation/instances: post: operationId: federation/instances summary: federation/instances description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/federation/instances.ts tags: - federation requestBody: required: true content: application/json: schema: type: object properties: host: type: string nullable: true description: Omit or use `null` to not filter by host. blocked: type: boolean nullable: true notResponding: type: boolean nullable: true suspended: type: boolean nullable: true federating: type: boolean nullable: true subscribing: type: boolean nullable: true publishing: type: boolean nullable: true limit: type: integer minimum: 1 maximum: 100 default: 30 offset: type: integer default: 0 sort: type: string required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: FederationInstance $ref: '#/components/schemas/FederationInstance' "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 /federation/show-instance: post: operationId: federation/show-instance summary: federation/show-instance description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/federation/show-instance.ts tags: - federation requestBody: required: true content: application/json: schema: type: object properties: host: type: string required: - host responses: "200": description: OK (with results) content: application/json: schema: oneOf: - type: object ref: FederationInstance $ref: '#/components/schemas/FederationInstance' - type: "null" "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 /federation/update-remote-user: post: operationId: federation/update-remote-user summary: federation/update-remote-user description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/federation/update-remote-user.ts tags: - federation security: - ApiKeyAuth: [] 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: 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 /federation/users: post: operationId: federation/users summary: federation/users description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/federation/users.ts tags: - federation requestBody: required: true content: application/json: schema: type: object properties: host: type: string sinceId: type: string format: misskey:id untilId: type: string format: misskey:id limit: type: integer minimum: 1 maximum: 100 default: 10 required: - host responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: UserDetailedNotMe $ref: '#/components/schemas/UserDetailedNotMe' "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 /federation/stats: post: operationId: federation/stats summary: federation/stats description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/federation/stats.ts tags: - federation requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 10 required: [] 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 /following/create: post: operationId: following/create summary: following/create description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:following* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/following/create.ts tags: - following security: - ApiKeyAuth: [] 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 optional: false nullable: false ref: UserLite $ref: '#/components/schemas/UserLite' "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: fcd2eef9-a9b2-4c4f-8624-038099e90aa5 FOLLOWEE_IS_YOURSELF: value: error: message: Followee is yourself. code: FOLLOWEE_IS_YOURSELF id: 26fbe7bb-a331-4857-af17-205b426669a9 ALREADY_FOLLOWING: value: error: message: You are already following that user. code: ALREADY_FOLLOWING id: 35387507-38c7-4cb9-9197-300b93783fa0 BLOCKING: value: error: message: You are blocking that user. code: BLOCKING id: 4e2206ec-aa4f-4960-b865-6c23ac38e2d9 BLOCKED: value: error: message: You are blocked by that user. code: BLOCKED id: c4ab57cc-4e41-45e9-bfd9-584f61e35ce0 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: To 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 /following/delete: post: operationId: following/delete summary: following/delete description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:following* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/following/delete.ts tags: - following security: - ApiKeyAuth: [] 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 optional: false nullable: false ref: UserLite $ref: '#/components/schemas/UserLite' "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: 5b12c78d-2b28-4dca-99d2-f56139b42ff8 FOLLOWEE_IS_YOURSELF: value: error: message: Followee is yourself. code: FOLLOWEE_IS_YOURSELF id: d9e400b9-36b0-4808-b1d8-79e707f1296c NOT_FOLLOWING: value: error: message: You are not following that user. code: NOT_FOLLOWING id: 5dbf82f5-c92b-40b1-87d1-6c8c0741fd09 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: To 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 /following/invalidate: post: operationId: following/invalidate summary: following/invalidate description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:following* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/following/invalidate.ts tags: - following security: - ApiKeyAuth: [] 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 optional: false nullable: false ref: UserLite $ref: '#/components/schemas/UserLite' "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: 5b12c78d-2b28-4dca-99d2-f56139b42ff8 FOLLOWER_IS_YOURSELF: value: error: message: Follower is yourself. code: FOLLOWER_IS_YOURSELF id: 07dc03b9-03da-422d-885b-438313707662 NOT_FOLLOWING: value: error: message: The other use is not following you. code: NOT_FOLLOWING id: 5dbf82f5-c92b-40b1-87d1-6c8c0741fd09 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: To 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 /following/requests/accept: post: operationId: following/requests/accept summary: following/requests/accept description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:following* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/following/requests/accept.ts tags: - following security: - ApiKeyAuth: [] 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: 66ce1645-d66c-46bb-8b79-96739af885bd NO_FOLLOW_REQUEST: value: error: message: No follow request. code: NO_FOLLOW_REQUEST id: bcde4f8b-0913-4614-8881-614e522fb041 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 /following/requests/cancel: post: operationId: following/requests/cancel summary: following/requests/cancel description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:following* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/following/requests/cancel.ts tags: - following security: - ApiKeyAuth: [] 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 optional: false nullable: false ref: UserLite $ref: '#/components/schemas/UserLite' "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: 4e68c551-fc4c-4e46-bb41-7d4a37bf9dab FOLLOW_REQUEST_NOT_FOUND: value: error: message: Follow request not found. code: FOLLOW_REQUEST_NOT_FOUND id: 089b125b-d338-482a-9a09-e2622ac9f8d4 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 /following/requests/list: post: operationId: following/requests/list summary: following/requests/list description: |- No description provided. **Credential required**: *Yes* / **Permission**: *read:following* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/following/requests/list.ts tags: - following security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: {} required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false properties: id: type: string optional: false nullable: false format: id follower: type: object optional: false nullable: false ref: UserLite $ref: '#/components/schemas/UserLite' followee: type: object optional: false nullable: false ref: UserLite $ref: '#/components/schemas/UserLite' required: - id - follower - followee "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 /following/requests/reject: post: operationId: following/requests/reject summary: following/requests/reject description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:following* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/following/requests/reject.ts tags: - following security: - ApiKeyAuth: [] 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: abc2ffa6-25b2-4380-ba99-321ff3a94555 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 /gallery/featured: post: operationId: gallery/featured summary: gallery/featured description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/gallery/featured.ts tags: - gallery requestBody: required: true content: application/json: schema: type: object properties: {} required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: GalleryPost $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 /gallery/popular: post: operationId: gallery/popular summary: gallery/popular description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/gallery/popular.ts tags: - gallery requestBody: required: true content: application/json: schema: type: object properties: {} required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: GalleryPost $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 /gallery/posts: post: operationId: gallery/posts summary: gallery/posts description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/gallery/posts.ts tags: - gallery 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 required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: GalleryPost $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 /gallery/posts/create: post: operationId: gallery/posts/create summary: gallery/posts/create description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:gallery* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/gallery/posts/create.ts tags: - gallery security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: title: type: string minLength: 1 description: type: string nullable: true fileIds: type: array uniqueItems: true minItems: 1 maxItems: 32 items: type: string format: misskey:id isSensitive: type: boolean default: false required: - title - fileIds responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false ref: GalleryPost $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 "429": description: To 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 /gallery/posts/delete: post: operationId: gallery/posts/delete summary: gallery/posts/delete description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:gallery* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/gallery/posts/delete.ts tags: - gallery security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: postId: type: string format: misskey:id required: - postId responses: "204": description: OK (without any results) "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_POST: value: error: message: No such post. code: NO_SUCH_POST id: ae52f367-4bd7-4ecd-afc6-5672fff427f5 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 /gallery/posts/like: post: operationId: gallery/posts/like summary: gallery/posts/like description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:gallery-likes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/gallery/posts/like.ts tags: - gallery security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: postId: type: string format: misskey:id required: - postId responses: "204": description: OK (without any results) "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_POST: value: error: message: No such post. code: NO_SUCH_POST id: 56c06af3-1287-442f-9701-c93f7c4a62ff YOUR_POST: value: error: message: You cannot like your post. code: YOUR_POST id: f78f1511-5ebc-4478-a888-1198d752da68 ALREADY_LIKED: value: error: message: The post has already been liked. code: ALREADY_LIKED id: 40e9ed56-a59c-473a-bf3f-f289c54fb5a7 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 /gallery/posts/show: post: operationId: gallery/posts/show summary: gallery/posts/show description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/gallery/posts/show.ts tags: - gallery requestBody: required: true content: application/json: schema: type: object properties: postId: type: string format: misskey:id required: - postId responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false ref: GalleryPost $ref: '#/components/schemas/GalleryPost' "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_POST: value: error: message: No such post. code: NO_SUCH_POST id: 1137bf14-c5b0-4604-85bb-5b5371b1cd45 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 /gallery/posts/unlike: post: operationId: gallery/posts/unlike summary: gallery/posts/unlike description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:gallery-likes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/gallery/posts/unlike.ts tags: - gallery security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: postId: type: string format: misskey:id required: - postId responses: "204": description: OK (without any results) "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_POST: value: error: message: No such post. code: NO_SUCH_POST id: c32e6dd0-b555-4413-925e-b3757d19ed84 NOT_LIKED: value: error: message: You have not liked that post. code: NOT_LIKED id: e3e8e06e-be37-41f7-a5b4-87a8250288f0 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 /gallery/posts/update: post: operationId: gallery/posts/update summary: gallery/posts/update description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:gallery* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/gallery/posts/update.ts tags: - gallery security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: postId: type: string format: misskey:id title: type: string minLength: 1 description: type: string nullable: true fileIds: type: array uniqueItems: true minItems: 1 maxItems: 32 items: type: string format: misskey:id isSensitive: type: boolean default: false required: - postId - title - fileIds responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false ref: GalleryPost $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 "429": description: To 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 /get-online-users-count: post: operationId: get-online-users-count summary: get-online-users-count description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/get-online-users-count.ts tags: - meta requestBody: required: true content: application/json: schema: type: object properties: {} required: [] 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 /hashtags/list: post: operationId: hashtags/list summary: hashtags/list description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/hashtags/list.ts tags: - hashtags requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 10 attachedToUserOnly: type: boolean default: false attachedToLocalUserOnly: type: boolean default: false attachedToRemoteUserOnly: type: boolean default: false sort: type: string enum: - +mentionedUsers - -mentionedUsers - +mentionedLocalUsers - -mentionedLocalUsers - +mentionedRemoteUsers - -mentionedRemoteUsers - +attachedUsers - -attachedUsers - +attachedLocalUsers - -attachedLocalUsers - +attachedRemoteUsers - -attachedRemoteUsers required: - sort responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Hashtag $ref: '#/components/schemas/Hashtag' "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 /hashtags/search: post: operationId: hashtags/search summary: hashtags/search description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/hashtags/search.ts tags: - hashtags requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 10 query: type: string offset: type: integer default: 0 required: - query responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: string optional: false nullable: false "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 /hashtags/show: post: operationId: hashtags/show summary: hashtags/show description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/hashtags/show.ts tags: - hashtags requestBody: required: true content: application/json: schema: type: object properties: tag: type: string required: - tag responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false ref: Hashtag $ref: '#/components/schemas/Hashtag' "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_HASHTAG: value: error: message: No such hashtag. code: NO_SUCH_HASHTAG id: 110ee688-193e-4a3a-9ecf-c167b2e6981e 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 /hashtags/trend: post: operationId: hashtags/trend summary: hashtags/trend description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/hashtags/trend.ts tags: - hashtags requestBody: required: true content: application/json: schema: type: object properties: {} required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false properties: tag: type: string optional: false nullable: false chart: type: array optional: false nullable: false items: type: number optional: false nullable: false usersCount: type: number optional: false nullable: false required: - tag - chart - usersCount "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 /hashtags/users: post: operationId: hashtags/users summary: hashtags/users description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/hashtags/users.ts tags: - hashtags requestBody: required: true content: application/json: schema: type: object properties: tag: type: string limit: type: integer minimum: 1 maximum: 100 default: 10 sort: type: string enum: - +follower - -follower - +createdAt - -createdAt - +updatedAt - -updatedAt state: type: string enum: - all - alive default: all origin: type: string enum: - combined - local - remote default: local required: - tag - sort responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: UserDetailed $ref: '#/components/schemas/UserDetailed' "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: i summary: i description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/i.ts tags: - account security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: {} required: [] responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false ref: MeDetailed $ref: '#/components/schemas/MeDetailed' "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/favorites: post: operationId: i/favorites summary: i/favorites description: |- No description provided. **Credential required**: *Yes* / **Permission**: *read:favorites* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/i/favorites.ts tags: - account security: - ApiKeyAuth: [] 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 required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: NoteFavorite $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: 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/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/i/gallery/likes.ts tags: - account security: - ApiKeyAuth: [] 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 required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false properties: id: type: string optional: false nullable: false format: id post: type: object optional: false nullable: false ref: GalleryPost $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: 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/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/i/gallery/posts.ts tags: - account security: - ApiKeyAuth: [] 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 required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: GalleryPost $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/get-word-muted-notes-count: post: operationId: i/get-word-muted-notes-count summary: i/get-word-muted-notes-count description: |- No description provided. **Credential required**: *Yes* / **Permission**: *read:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/i/get-word-muted-notes-count.ts tags: - account security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: {} required: [] responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false properties: count: type: number optional: false nullable: false required: - count "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: i/notifications summary: i/notifications description: |- No description provided. **Credential required**: *Yes* / **Permission**: *read:notifications* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/i/notifications.ts tags: - account security: - ApiKeyAuth: [] 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 following: type: boolean default: false unreadOnly: type: boolean default: false markAsRead: type: boolean default: true includeTypes: type: array items: type: string enum: - follow - mention - reply - renote - quote - reaction - pollVote - pollEnded - receiveFollowRequest - followRequestAccepted - groupInvited - app excludeTypes: type: array items: type: string enum: - follow - mention - reply - renote - quote - reaction - pollVote - pollEnded - receiveFollowRequest - followRequestAccepted - groupInvited - app required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Notification $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: To 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: 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/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/i/page-likes.ts tags: - account security: - ApiKeyAuth: [] 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 required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object properties: id: type: string optional: false nullable: false format: id page: type: object optional: false nullable: false ref: Page $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: i/pages summary: i/pages description: |- No description provided. **Credential required**: *Yes* / **Permission**: *read:pages* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/i/pages.ts tags: - account security: - ApiKeyAuth: [] 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 required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Page $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: i/pin summary: i/pin description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/i/pin.ts tags: - account security: - ApiKeyAuth: [] 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 optional: false nullable: false ref: MeDetailed $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/read-all-messaging-messages: post: operationId: i/read-all-messaging-messages summary: i/read-all-messaging-messages description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/i/read-all-messaging-messages.ts tags: - account security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: {} required: [] 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/read-all-unread-notes: post: operationId: i/read-all-unread-notes summary: i/read-all-unread-notes description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/i/read-all-unread-notes.ts tags: - account security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: {} required: [] 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/read-announcement: post: operationId: 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/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/i/read-announcement.ts tags: - account security: - ApiKeyAuth: [] 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: NO_SUCH_ANNOUNCEMENT: value: error: message: No such announcement. code: NO_SUCH_ANNOUNCEMENT id: 184663db-df88-4bc2-8b52-fb85f0681939 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: i/unpin summary: i/unpin description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/i/unpin.ts tags: - account security: - ApiKeyAuth: [] 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 optional: false nullable: false ref: MeDetailed $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: i/update summary: i/update description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/i/update.ts tags: - account security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 50 nullable: true description: type: string minLength: 1 maxLength: 500 nullable: true location: type: string minLength: 1 maxLength: 50 nullable: true birthday: type: string pattern: ^([0-9]{4})-([0-9]{2})-([0-9]{2})$ nullable: true lang: type: string 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 nullable: true avatarId: type: string format: misskey:id nullable: true bannerId: type: string format: misskey:id nullable: true 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 isBot: type: boolean isCat: type: boolean showTimelineReplies: type: boolean injectFeaturedNote: type: boolean receiveAnnouncementEmail: type: boolean alwaysMarkNsfw: type: boolean autoSensitive: type: boolean ffVisibility: type: string enum: - public - followers - private pinnedPageId: type: array items: type: string format: misskey:id mutedWords: type: array mutedInstances: type: array items: type: string mutingNotificationTypes: type: array items: type: string enum: - follow - mention - reply - renote - quote - reaction - pollVote - pollEnded - receiveFollowRequest - followRequestAccepted - groupInvited - app emailNotificationTypes: type: array items: type: string responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false ref: MeDetailed $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_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 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 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/user-group-invites: post: operationId: i/user-group-invites summary: i/user-group-invites description: |- No description provided. **Credential required**: *Yes* / **Permission**: *read:user-groups* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/i/user-group-invites.ts tags: - account security: - ApiKeyAuth: [] 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 required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false properties: id: type: string optional: false nullable: false format: id group: type: object optional: false nullable: false ref: UserGroup $ref: '#/components/schemas/UserGroup' required: - id - group "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/webhooks/create: post: operationId: i/webhooks/create summary: i/webhooks/create description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/i/webhooks/create.ts tags: - webhooks security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 100 url: type: string minLength: 1 maxLength: 1024 secret: type: string minLength: 1 maxLength: 1024 "on": type: array items: type: string enum: - mention - unfollow - follow - followed - note - reply - renote - reaction required: - name - url - secret - "on" 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/webhooks/list: post: operationId: i/webhooks/list summary: i/webhooks/list description: |- No description provided. **Credential required**: *Yes* / **Permission**: *read:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/i/webhooks/list.ts tags: - webhooks security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: {} required: [] 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/webhooks/show: post: operationId: i/webhooks/show summary: i/webhooks/show description: |- No description provided. **Credential required**: *Yes* / **Permission**: *read:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/i/webhooks/show.ts tags: - webhooks security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: webhookId: type: string format: misskey:id required: - webhookId responses: "204": description: OK (without any results) "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_WEBHOOK: value: error: message: No such webhook. code: NO_SUCH_WEBHOOK id: 50f614d9-3047-4f7e-90d8-ad6b2d5fb098 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/webhooks/update: post: operationId: i/webhooks/update summary: i/webhooks/update description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/i/webhooks/update.ts tags: - webhooks security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: webhookId: type: string format: misskey:id name: type: string minLength: 1 maxLength: 100 url: type: string minLength: 1 maxLength: 1024 secret: type: string minLength: 1 maxLength: 1024 "on": type: array items: type: string enum: - mention - unfollow - follow - followed - note - reply - renote - reaction active: type: boolean required: - webhookId - name - url - secret - "on" - active responses: "204": description: OK (without any results) "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_WEBHOOK: value: error: message: No such webhook. code: NO_SUCH_WEBHOOK id: fb0fea69-da18-45b1-828d-bd4fd1612518 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/webhooks/delete: post: operationId: i/webhooks/delete summary: i/webhooks/delete description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/i/webhooks/delete.ts tags: - webhooks security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: webhookId: type: string format: misskey:id required: - webhookId responses: "204": description: OK (without any results) "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_WEBHOOK: value: error: message: No such webhook. code: NO_SUCH_WEBHOOK id: bae73e5a-5522-4965-ae19-3a8688e71d82 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 /messaging/history: post: operationId: messaging/history summary: messaging/history description: |- No description provided. **Credential required**: *Yes* / **Permission**: *read:messaging* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/messaging/history.ts tags: - messaging security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 10 group: type: boolean default: false required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: MessagingMessage $ref: '#/components/schemas/MessagingMessage' "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 /messaging/messages: post: operationId: messaging/messages summary: messaging/messages description: |- No description provided. **Credential required**: *Yes* / **Permission**: *read:messaging* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/messaging/messages.ts tags: - messaging security: - ApiKeyAuth: [] 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 anyOf: - properties: userId: type: string format: misskey:id required: - userId - properties: groupId: type: string format: misskey:id required: - groupId responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: MessagingMessage $ref: '#/components/schemas/MessagingMessage' "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: 11795c64-40ea-4198-b06e-3c873ed9039d NO_SUCH_GROUP: value: error: message: No such group. code: NO_SUCH_GROUP id: c4d9f88c-9270-4632-b032-6ed8cee36f7f GROUP_ACCESS_DENIED: value: error: message: You can not read messages of groups that you have not joined. code: GROUP_ACCESS_DENIED id: a053a8dd-a491-4718-8f87-50775aad9284 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 /messaging/messages/create: post: operationId: messaging/messages/create summary: messaging/messages/create description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:messaging* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/messaging/messages/create.ts tags: - messaging security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: text: type: string nullable: true maxLength: 3000 fileId: type: string format: misskey:id anyOf: - properties: userId: type: string format: misskey:id required: - userId - properties: groupId: type: string format: misskey:id required: - groupId responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false ref: MessagingMessage $ref: '#/components/schemas/MessagingMessage' "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: RECIPIENT_IS_YOURSELF: value: error: message: You can not send a message to yourself. code: RECIPIENT_IS_YOURSELF id: 17e2ba79-e22a-4cbc-bf91-d327643f4a7e NO_SUCH_USER: value: error: message: No such user. code: NO_SUCH_USER id: 11795c64-40ea-4198-b06e-3c873ed9039d NO_SUCH_GROUP: value: error: message: No such group. code: NO_SUCH_GROUP id: c94e2a5d-06aa-4914-8fa6-6a42e73d6537 GROUP_ACCESS_DENIED: value: error: message: You can not send messages to groups that you have not joined. code: GROUP_ACCESS_DENIED id: d96b3cca-5ad1-438b-ad8b-02f931308fbd NO_SUCH_FILE: value: error: message: No such file. code: NO_SUCH_FILE id: 4372b8e2-185d-4146-8749-2f68864a3e5f CONTENT_REQUIRED: value: error: message: Content required. You need to set text or fileId. code: CONTENT_REQUIRED id: 25587321-b0e6-449c-9239-f8925092942c YOU_HAVE_BEEN_BLOCKED: value: error: message: You cannot send a message because you have been blocked by this user. code: YOU_HAVE_BEEN_BLOCKED id: c15a5199-7422-4968-941a-2a462c478f7d 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 /messaging/messages/delete: post: operationId: messaging/messages/delete summary: messaging/messages/delete description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:messaging* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/messaging/messages/delete.ts tags: - messaging security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: messageId: type: string format: misskey:id required: - messageId responses: "204": description: OK (without any results) "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_MESSAGE: value: error: message: No such message. code: NO_SUCH_MESSAGE id: 54b5b326-7925-42cf-8019-130fda8b56af 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: To 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 /messaging/messages/read: post: operationId: messaging/messages/read summary: messaging/messages/read description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:messaging* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/messaging/messages/read.ts tags: - messaging security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: messageId: type: string format: misskey:id required: - messageId responses: "204": description: OK (without any results) "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_MESSAGE: value: error: message: No such message. code: NO_SUCH_MESSAGE id: 86d56a2f-a9c3-4afb-b13c-3e9bfef9aa14 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 /meta: post: operationId: meta summary: meta description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/meta.ts tags: - meta requestBody: required: true content: application/json: schema: type: object properties: detail: type: boolean default: true required: [] responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false properties: maintainerName: type: string optional: false nullable: true maintainerEmail: type: string optional: false nullable: true version: type: string optional: false nullable: false example: 12.119.2 name: type: string optional: false nullable: false uri: type: string optional: false nullable: false format: url example: https://misskey.example.com description: type: string optional: false nullable: true langs: type: array optional: false nullable: false items: type: string optional: false nullable: false tosUrl: type: string optional: false nullable: true repositoryUrl: type: string optional: false nullable: false default: https://github.com/misskey-dev/misskey feedbackUrl: type: string optional: false nullable: false default: https://github.com/misskey-dev/misskey/issues/new defaultDarkTheme: type: string optional: false nullable: true defaultLightTheme: type: string optional: false nullable: true disableRegistration: type: boolean optional: false nullable: false disableLocalTimeline: type: boolean optional: false nullable: false disableGlobalTimeline: type: boolean optional: false nullable: false driveCapacityPerLocalUserMb: type: number optional: false nullable: false driveCapacityPerRemoteUserMb: type: number optional: false nullable: false cacheRemoteFiles: type: boolean optional: false nullable: false emailRequiredForSignup: type: boolean optional: false nullable: false enableHcaptcha: type: boolean optional: false nullable: false hcaptchaSiteKey: type: string optional: false nullable: true enableRecaptcha: type: boolean optional: false nullable: false recaptchaSiteKey: type: string optional: false nullable: true swPublickey: type: string optional: false nullable: true mascotImageUrl: type: string optional: false nullable: false default: /assets/ai.png bannerUrl: type: string optional: false nullable: false errorImageUrl: type: string optional: false nullable: false default: https://xn--931a.moe/aiart/yubitun.png iconUrl: type: string optional: false nullable: true maxNoteTextLength: type: number optional: false nullable: false emojis: type: array optional: false nullable: false items: type: object optional: false nullable: false properties: id: type: string optional: false nullable: false format: id aliases: type: array optional: false nullable: false items: type: string optional: false nullable: false category: type: string optional: false nullable: true host: type: string optional: false nullable: true description: The local host is represented with `null`. url: type: string optional: false nullable: false format: url required: - id - aliases - category - host - url ads: type: array optional: false nullable: false items: type: object optional: false nullable: false properties: place: type: string optional: false nullable: false url: type: string optional: false nullable: false format: url imageUrl: type: string optional: false nullable: false format: url required: - place - url - imageUrl requireSetup: type: boolean optional: false nullable: false example: false enableEmail: type: boolean optional: false nullable: false enableTwitterIntegration: type: boolean optional: false nullable: false enableGithubIntegration: type: boolean optional: false nullable: false enableDiscordIntegration: type: boolean optional: false nullable: false enableServiceWorker: type: boolean optional: false nullable: false translatorAvailable: type: boolean optional: false nullable: false proxyAccountName: type: string optional: false nullable: true features: type: object optional: true nullable: false properties: registration: type: boolean optional: false nullable: false localTimeLine: type: boolean optional: false nullable: false globalTimeLine: type: boolean optional: false nullable: false elasticsearch: type: boolean optional: false nullable: false hcaptcha: type: boolean optional: false nullable: false recaptcha: type: boolean optional: false nullable: false objectStorage: type: boolean optional: false nullable: false twitter: type: boolean optional: false nullable: false github: type: boolean optional: false nullable: false discord: type: boolean optional: false nullable: false serviceWorker: type: boolean optional: false nullable: false miauth: type: boolean optional: true nullable: false default: true required: - registration - localTimeLine - globalTimeLine - elasticsearch - hcaptcha - recaptcha - objectStorage - twitter - github - discord - serviceWorker required: - maintainerName - maintainerEmail - version - name - uri - description - langs - tosUrl - repositoryUrl - feedbackUrl - defaultDarkTheme - defaultLightTheme - disableRegistration - disableLocalTimeline - disableGlobalTimeline - driveCapacityPerLocalUserMb - driveCapacityPerRemoteUserMb - cacheRemoteFiles - emailRequiredForSignup - enableHcaptcha - hcaptchaSiteKey - enableRecaptcha - recaptchaSiteKey - swPublickey - mascotImageUrl - bannerUrl - errorImageUrl - iconUrl - maxNoteTextLength - emojis - ads - requireSetup - enableEmail - enableTwitterIntegration - enableGithubIntegration - enableDiscordIntegration - enableServiceWorker - translatorAvailable - proxyAccountName "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 /mute/create: post: operationId: mute/create summary: mute/create description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:mutes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/mute/create.ts tags: - account security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: userId: type: string format: misskey:id expiresAt: type: integer nullable: true 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 "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: mute/delete summary: mute/delete description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:mutes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/mute/delete.ts tags: - account security: - ApiKeyAuth: [] 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: mute/list summary: mute/list description: |- No description provided. **Credential required**: *Yes* / **Permission**: *read:mutes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/mute/list.ts tags: - account security: - ApiKeyAuth: [] 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 required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Muting $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: my/apps summary: my/apps description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/my/apps.ts tags: - account security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 10 offset: type: integer default: 0 required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: App $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 /notes: post: operationId: notes summary: notes description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notes.ts tags: - notes requestBody: required: true content: application/json: schema: type: object properties: local: type: boolean default: false reply: type: boolean renote: type: boolean withFiles: type: boolean poll: type: boolean limit: type: integer minimum: 1 maximum: 100 default: 10 sinceId: type: string format: misskey:id untilId: type: string format: misskey:id required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Note $ref: '#/components/schemas/Note' "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 /notes/children: post: operationId: notes/children summary: notes/children description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notes/children.ts tags: - notes requestBody: required: true content: application/json: schema: type: object properties: noteId: 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: - noteId responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Note $ref: '#/components/schemas/Note' "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 /notes/clips: post: operationId: notes/clips summary: notes/clips description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notes/clips.ts tags: - clips 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: array optional: false nullable: false items: type: object optional: false nullable: false ref: Clip $ref: '#/components/schemas/Clip' "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: 47db1a1c-b0af-458d-8fb4-986e4efafe1e 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 /notes/conversation: post: operationId: notes/conversation summary: notes/conversation description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notes/conversation.ts tags: - notes requestBody: required: true content: application/json: schema: type: object properties: noteId: type: string format: misskey:id limit: type: integer minimum: 1 maximum: 100 default: 10 offset: type: integer default: 0 required: - noteId responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Note $ref: '#/components/schemas/Note' "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: e1035875-9551-45ec-afa8-1ded1fcb53c8 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 /notes/create: post: operationId: notes/create summary: notes/create description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:notes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notes/create.ts tags: - notes security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: visibility: type: string enum: - public - home - followers - specified default: public visibleUserIds: type: array uniqueItems: true items: type: string format: misskey:id text: type: string maxLength: 3000 nullable: true cw: type: string nullable: true maxLength: 100 localOnly: type: boolean default: false noExtractMentions: type: boolean default: false noExtractHashtags: type: boolean default: false noExtractEmojis: type: boolean default: false fileIds: type: array uniqueItems: true minItems: 1 maxItems: 16 items: type: string format: misskey:id mediaIds: deprecated: true description: Use `fileIds` instead. If both are specified, this property is discarded. type: array uniqueItems: true minItems: 1 maxItems: 16 items: type: string format: misskey:id replyId: type: string format: misskey:id nullable: true renoteId: type: string format: misskey:id nullable: true channelId: type: string format: misskey:id nullable: true poll: type: object nullable: true properties: choices: type: array uniqueItems: true minItems: 2 maxItems: 10 items: type: string minLength: 1 maxLength: 50 multiple: type: boolean default: false expiresAt: type: integer nullable: true expiredAfter: type: integer nullable: true minimum: 1 required: - choices anyOf: - properties: text: type: string minLength: 1 maxLength: 3000 nullable: false required: - text - required: - fileIds - required: - mediaIds - properties: poll: type: object nullable: false required: - poll - required: - renoteId responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false properties: createdNote: type: object optional: false nullable: false ref: Note $ref: '#/components/schemas/Note' required: - createdNote "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_RENOTE_TARGET: value: error: message: No such renote target. code: NO_SUCH_RENOTE_TARGET id: b5c90186-4ab0-49c8-9bba-a1f76c282ba4 CANNOT_RENOTE_TO_A_PURE_RENOTE: value: error: message: You can not Renote a pure Renote. code: CANNOT_RENOTE_TO_A_PURE_RENOTE id: fd4cc33e-2a37-48dd-99cc-9b806eb2031a NO_SUCH_REPLY_TARGET: value: error: message: No such reply target. code: NO_SUCH_REPLY_TARGET id: 749ee0f6-d3da-459a-bf02-282e2da4292c CANNOT_REPLY_TO_A_PURE_RENOTE: value: error: message: You can not reply to a pure Renote. code: CANNOT_REPLY_TO_A_PURE_RENOTE id: 3ac74a84-8fd5-4bb0-870f-01804f82ce15 CANNOT_CREATE_ALREADY_EXPIRED_POLL: value: error: message: Poll is already expired. code: CANNOT_CREATE_ALREADY_EXPIRED_POLL id: 04da457d-b083-4055-9082-955525eda5a5 NO_SUCH_CHANNEL: value: error: message: No such channel. code: NO_SUCH_CHANNEL id: b1653923-5453-4edc-b786-7c4f39bb0bbb YOU_HAVE_BEEN_BLOCKED: value: error: message: You have been blocked by this user. code: YOU_HAVE_BEEN_BLOCKED id: b390d7e1-8a5e-46ed-b625-06271cafd3d3 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: To 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 /notes/delete: post: operationId: notes/delete summary: notes/delete description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:notes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notes/delete.ts tags: - notes security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: noteId: type: string format: misskey:id required: - noteId responses: "204": description: OK (without any results) "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: 490be23f-8c1f-4796-819f-94cb4f9d1630 ACCESS_DENIED: value: error: message: Access denied. code: ACCESS_DENIED id: fe8d7103-0ea8-4ec3-814d-f8b401dc69e9 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: To 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 /notes/favorites/create: post: operationId: notes/favorites/create summary: notes/favorites/create description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:favorites* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notes/favorites/create.ts tags: - notes security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: noteId: type: string format: misskey:id required: - noteId responses: "204": description: OK (without any results) "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: 6dd26674-e060-4816-909a-45ba3f4da458 ALREADY_FAVORITED: value: error: message: The note has already been marked as a favorite. code: ALREADY_FAVORITED id: a402c12b-34dd-41d2-97d8-4d2ffd96a1a6 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 /notes/favorites/delete: post: operationId: notes/favorites/delete summary: notes/favorites/delete description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:favorites* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notes/favorites/delete.ts tags: - notes security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: noteId: type: string format: misskey:id required: - noteId responses: "204": description: OK (without any results) "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: 80848a2c-398f-4343-baa9-df1d57696c56 NOT_FAVORITED: value: error: message: You have not marked that note a favorite. code: NOT_FAVORITED id: b625fc69-635e-45e9-86f4-dbefbef35af5 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 /notes/featured: post: operationId: notes/featured summary: notes/featured description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notes/featured.ts tags: - notes requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 10 offset: type: integer default: 0 required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Note $ref: '#/components/schemas/Note' "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 /notes/global-timeline: post: operationId: notes/global-timeline summary: notes/global-timeline description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notes/global-timeline.ts tags: - notes requestBody: required: true content: application/json: schema: type: object properties: withFiles: type: boolean default: false description: Only show notes that have attached files. limit: type: integer minimum: 1 maximum: 100 default: 10 sinceId: type: string format: misskey:id untilId: type: string format: misskey:id sinceDate: type: integer untilDate: type: integer required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Note $ref: '#/components/schemas/Note' "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: GTL_DISABLED: value: error: message: Global timeline has been disabled. code: GTL_DISABLED id: 0332fc13-6ab2-4427-ae80-a9fadffd1a6b 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 /notes/hybrid-timeline: post: operationId: notes/hybrid-timeline summary: notes/hybrid-timeline description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notes/hybrid-timeline.ts tags: - notes security: - ApiKeyAuth: [] 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 sinceDate: type: integer untilDate: type: integer includeMyRenotes: type: boolean default: true includeRenotedMyNotes: type: boolean default: true includeLocalRenotes: type: boolean default: true withFiles: type: boolean default: false description: Only show notes that have attached files. required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Note $ref: '#/components/schemas/Note' "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: STL_DISABLED: value: error: message: Hybrid timeline has been disabled. code: STL_DISABLED id: 620763f4-f621-4533-ab33-0577a1a3c342 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 /notes/local-timeline: post: operationId: notes/local-timeline summary: notes/local-timeline description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notes/local-timeline.ts tags: - notes requestBody: required: true content: application/json: schema: type: object properties: withFiles: type: boolean default: false description: Only show notes that have attached files. fileType: type: array items: type: string excludeNsfw: type: boolean default: false limit: type: integer minimum: 1 maximum: 100 default: 10 sinceId: type: string format: misskey:id untilId: type: string format: misskey:id sinceDate: type: integer untilDate: type: integer required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Note $ref: '#/components/schemas/Note' "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: LTL_DISABLED: value: error: message: Local timeline has been disabled. code: LTL_DISABLED id: 45a6eb02-7695-4393-b023-dd3be9aaaefd 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 /notes/mentions: post: operationId: notes/mentions summary: notes/mentions description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notes/mentions.ts tags: - notes security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: following: type: boolean default: false limit: type: integer minimum: 1 maximum: 100 default: 10 sinceId: type: string format: misskey:id untilId: type: string format: misskey:id visibility: type: string required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Note $ref: '#/components/schemas/Note' "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 /notes/polls/recommendation: post: operationId: notes/polls/recommendation summary: notes/polls/recommendation description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notes/polls/recommendation.ts tags: - notes security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 10 offset: type: integer default: 0 required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Note $ref: '#/components/schemas/Note' "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 /notes/polls/vote: post: operationId: notes/polls/vote summary: notes/polls/vote description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:votes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notes/polls/vote.ts tags: - notes security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: noteId: type: string format: misskey:id choice: type: integer required: - noteId - choice responses: "204": description: OK (without any results) "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: ecafbd2e-c283-4d6d-aecb-1a0a33b75396 NO_POLL: value: error: message: The note does not attach a poll. code: NO_POLL id: 5f979967-52d9-4314-a911-1c673727f92f INVALID_CHOICE: value: error: message: Choice ID is invalid. code: INVALID_CHOICE id: e0cc9a04-f2e8-41e4-a5f1-4127293260cc ALREADY_VOTED: value: error: message: You have already voted. code: ALREADY_VOTED id: 0963fc77-efac-419b-9424-b391608dc6d8 ALREADY_EXPIRED: value: error: message: The poll is already expired. code: ALREADY_EXPIRED id: 1022a357-b085-4054-9083-8f8de358337e YOU_HAVE_BEEN_BLOCKED: value: error: message: You cannot vote this poll because you have been blocked by this user. code: YOU_HAVE_BEEN_BLOCKED id: 85a5377e-b1e9-4617-b0b9-5bea73331e49 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 /notes/reactions: post: operationId: notes/reactions summary: notes/reactions description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notes/reactions.ts tags: - notes requestBody: required: true content: application/json: schema: type: object properties: noteId: type: string format: misskey:id type: type: string nullable: true limit: type: integer minimum: 1 maximum: 100 default: 10 offset: type: integer default: 0 sinceId: type: string format: misskey:id untilId: type: string format: misskey:id required: - noteId responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: NoteReaction $ref: '#/components/schemas/NoteReaction' "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: 263fff3d-d0e1-4af4-bea7-8408059b451a 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 /notes/reactions/create: post: operationId: notes/reactions/create summary: notes/reactions/create description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:reactions* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notes/reactions/create.ts tags: - reactions security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: noteId: type: string format: misskey:id reaction: type: string required: - noteId - reaction responses: "204": description: OK (without any results) "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: 033d0620-5bfe-4027-965d-980b0c85a3ea ALREADY_REACTED: value: error: message: You are already reacting to that note. code: ALREADY_REACTED id: 71efcf98-86d6-4e2b-b2ad-9d032369366b YOU_HAVE_BEEN_BLOCKED: value: error: message: You cannot react this note because you have been blocked by this user. code: YOU_HAVE_BEEN_BLOCKED id: 20ef5475-9f38-4e4c-bd33-de6d979498ec 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 /notes/reactions/delete: post: operationId: notes/reactions/delete summary: notes/reactions/delete description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:reactions* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notes/reactions/delete.ts tags: - reactions security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: noteId: type: string format: misskey:id required: - noteId responses: "204": description: OK (without any results) "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: 764d9fce-f9f2-4a0e-92b1-6ceac9a7ad37 NOT_REACTED: value: error: message: You are not reacting to that note. code: NOT_REACTED id: 92f4426d-4196-4125-aa5b-02943e2ec8fc 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: To 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 /notes/renotes: post: operationId: notes/renotes summary: notes/renotes description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notes/renotes.ts tags: - notes requestBody: required: true content: application/json: schema: type: object properties: noteId: 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: - noteId responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Note $ref: '#/components/schemas/Note' "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: 12908022-2e21-46cd-ba6a-3edaf6093f46 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 /notes/replies: post: operationId: notes/replies summary: notes/replies description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notes/replies.ts tags: - notes requestBody: required: true content: application/json: schema: type: object properties: noteId: type: string format: misskey:id sinceId: type: string format: misskey:id untilId: type: string format: misskey:id limit: type: integer minimum: 1 maximum: 100 default: 10 required: - noteId responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Note $ref: '#/components/schemas/Note' "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 /notes/search-by-tag: post: operationId: notes/search-by-tag summary: notes/search-by-tag description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notes/search-by-tag.ts tags: - notes requestBody: required: true content: application/json: schema: type: object properties: reply: type: boolean nullable: true default: null renote: type: boolean nullable: true default: null withFiles: type: boolean default: false description: Only show notes that have attached files. poll: type: boolean nullable: true default: null sinceId: type: string format: misskey:id untilId: type: string format: misskey:id limit: type: integer minimum: 1 maximum: 100 default: 10 anyOf: - properties: tag: type: string minLength: 1 required: - tag - properties: query: type: array description: The outer arrays are chained with OR, the inner arrays are chained with AND. items: type: array items: type: string minLength: 1 minItems: 1 minItems: 1 required: - query responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Note $ref: '#/components/schemas/Note' "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 /notes/search: post: operationId: notes/search summary: notes/search description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notes/search.ts tags: - notes requestBody: required: true content: application/json: schema: type: object properties: query: type: string sinceId: type: string format: misskey:id untilId: type: string format: misskey:id limit: type: integer minimum: 1 maximum: 100 default: 10 offset: type: integer default: 0 host: type: string nullable: true description: The local host is represented with `null`. userId: type: string format: misskey:id nullable: true default: null channelId: type: string format: misskey:id nullable: true default: null required: - query responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Note $ref: '#/components/schemas/Note' "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 /notes/show: post: operationId: notes/show summary: notes/show description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notes/show.ts tags: - notes 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 optional: false nullable: false ref: Note $ref: '#/components/schemas/Note' "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: 24fcbfc6-2e37-42b6-8388-c29b3861a08d 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 /notes/state: post: operationId: notes/state summary: notes/state description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notes/state.ts tags: - notes security: - ApiKeyAuth: [] 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 optional: false nullable: false properties: isFavorited: type: boolean optional: false nullable: false isWatching: type: boolean optional: false nullable: false isMutedThread: type: boolean optional: false nullable: false required: - isFavorited - isWatching - isMutedThread "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 /notes/thread-muting/create: post: operationId: notes/thread-muting/create summary: notes/thread-muting/create description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notes/thread-muting/create.ts tags: - notes security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: noteId: type: string format: misskey:id required: - noteId responses: "204": description: OK (without any results) "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: 5ff67ada-ed3b-2e71-8e87-a1a421e177d2 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 /notes/thread-muting/delete: post: operationId: notes/thread-muting/delete summary: notes/thread-muting/delete description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notes/thread-muting/delete.ts tags: - notes security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: noteId: type: string format: misskey:id required: - noteId responses: "204": description: OK (without any results) "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: bddd57ac-ceb3-b29d-4334-86ea5fae481a 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 /notes/timeline: post: operationId: notes/timeline summary: notes/timeline description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notes/timeline.ts tags: - notes security: - ApiKeyAuth: [] 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 sinceDate: type: integer untilDate: type: integer includeMyRenotes: type: boolean default: true includeRenotedMyNotes: type: boolean default: true includeLocalRenotes: type: boolean default: true withFiles: type: boolean default: false description: Only show notes that have attached files. required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Note $ref: '#/components/schemas/Note' "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 /notes/translate: post: operationId: notes/translate summary: notes/translate description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notes/translate.ts tags: - notes requestBody: required: true content: application/json: schema: type: object properties: noteId: type: string format: misskey:id targetLang: type: string required: - noteId - targetLang responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false "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: bea9b03f-36e0-49c5-a4db-627a029f8971 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 /notes/unrenote: post: operationId: notes/unrenote summary: notes/unrenote description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:notes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notes/unrenote.ts tags: - notes security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: noteId: type: string format: misskey:id required: - noteId responses: "204": description: OK (without any results) "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: efd4a259-2442-496b-8dd7-b255aa1a160f 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: To 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 /notes/user-list-timeline: post: operationId: notes/user-list-timeline summary: notes/user-list-timeline description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notes/user-list-timeline.ts tags: - notes security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: listId: 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 sinceDate: type: integer untilDate: type: integer includeMyRenotes: type: boolean default: true includeRenotedMyNotes: type: boolean default: true includeLocalRenotes: type: boolean default: true withFiles: type: boolean default: false description: Only show notes that have attached files. required: - listId responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Note $ref: '#/components/schemas/Note' "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: 8fb1fbd5-e476-4c37-9fb0-43d55b63a2ff 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 /notes/watching/create: post: operationId: notes/watching/create summary: notes/watching/create description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notes/watching/create.ts tags: - notes security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: noteId: type: string format: misskey:id required: - noteId responses: "204": description: OK (without any results) "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: ea0e37a6-90a3-4f58-ba6b-c328ca206fc7 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 /notes/watching/delete: post: operationId: notes/watching/delete summary: notes/watching/delete description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notes/watching/delete.ts tags: - notes security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: noteId: type: string format: misskey:id required: - noteId responses: "204": description: OK (without any results) "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: 09b3695c-f72c-4731-a428-7cff825fc82e 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 /notifications/create: post: operationId: notifications/create summary: notifications/create description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:notifications* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notifications/create.ts tags: - notifications security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: body: type: string header: type: string nullable: true icon: type: string nullable: true required: - body 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 /notifications/mark-all-as-read: post: operationId: notifications/mark-all-as-read summary: notifications/mark-all-as-read description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:notifications* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notifications/mark-all-as-read.ts tags: - notifications security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: {} required: [] 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 /notifications/read: post: operationId: notifications/read summary: notifications/read description: |- Mark a notification as read. **Credential required**: *Yes* / **Permission**: *write:notifications* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/notifications/read.ts tags: - notifications security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: oneOf: - type: object properties: notificationId: type: string format: misskey:id required: - notificationId - type: object properties: notificationIds: type: array items: type: string format: misskey:id maxItems: 100 required: - notificationIds responses: "204": description: OK (without any results) "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_NOTIFICATION: value: error: message: No such notification. code: NO_SUCH_NOTIFICATION id: efa929d5-05b5-47d1-beec-e6a4dbed011e 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 /pages/create: post: operationId: pages/create summary: pages/create description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:pages* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/pages/create.ts tags: - pages security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: title: type: string name: type: string minLength: 1 summary: type: string nullable: true content: type: array items: type: object additionalProperties: true variables: type: array items: type: object additionalProperties: true script: type: string eyeCatchingImageId: type: string format: misskey:id nullable: true font: type: string enum: - serif - sans-serif default: sans-serif alignCenter: type: boolean default: false hideTitleWhenPinned: type: boolean default: false required: - title - name - content - variables - script responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false ref: Page $ref: '#/components/schemas/Page' "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_FILE: value: error: message: No such file. code: NO_SUCH_FILE id: b7b97489-0f66-4b12-a5ff-b21bd63f6e1c NAME_ALREADY_EXISTS: value: error: message: Specified name already exists. code: NAME_ALREADY_EXISTS id: 4650348e-301c-499a-83c9-6aa988c66bc1 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: To 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 /pages/delete: post: operationId: pages/delete summary: pages/delete description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:pages* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/pages/delete.ts tags: - pages security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: pageId: type: string format: misskey:id required: - pageId responses: "204": description: OK (without any results) "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_PAGE: value: error: message: No such page. code: NO_SUCH_PAGE id: eb0c6e1d-d519-4764-9486-52a7e1c6392a ACCESS_DENIED: value: error: message: Access denied. code: ACCESS_DENIED id: 8b741b3e-2c22-44b3-a15f-29949aa1601e 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 /pages/featured: post: operationId: pages/featured summary: pages/featured description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/pages/featured.ts tags: - pages requestBody: required: true content: application/json: schema: type: object properties: {} required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Page $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 /pages/like: post: operationId: pages/like summary: pages/like description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:page-likes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/pages/like.ts tags: - pages security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: pageId: type: string format: misskey:id required: - pageId responses: "204": description: OK (without any results) "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_PAGE: value: error: message: No such page. code: NO_SUCH_PAGE id: cc98a8a2-0dc3-4123-b198-62c71df18ed3 YOUR_PAGE: value: error: message: You cannot like your page. code: YOUR_PAGE id: 28800466-e6db-40f2-8fae-bf9e82aa92b8 ALREADY_LIKED: value: error: message: The page has already been liked. code: ALREADY_LIKED id: cc98a8a2-0dc3-4123-b198-62c71df18ed3 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 /pages/show: post: operationId: pages/show summary: pages/show description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/pages/show.ts tags: - pages requestBody: required: true content: application/json: schema: type: object anyOf: - properties: pageId: type: string format: misskey:id required: - pageId - properties: name: type: string username: type: string required: - name - username responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false ref: Page $ref: '#/components/schemas/Page' "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_PAGE: value: error: message: No such page. code: NO_SUCH_PAGE id: 222120c0-3ead-4528-811b-b96f233388d7 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 /pages/unlike: post: operationId: pages/unlike summary: pages/unlike description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:page-likes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/pages/unlike.ts tags: - pages security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: pageId: type: string format: misskey:id required: - pageId responses: "204": description: OK (without any results) "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_PAGE: value: error: message: No such page. code: NO_SUCH_PAGE id: a0d41e20-1993-40bd-890e-f6e560ae648e NOT_LIKED: value: error: message: You have not liked that page. code: NOT_LIKED id: f5e586b0-ce93-4050-b0e3-7f31af5259ee 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 /pages/update: post: operationId: pages/update summary: pages/update description: |- No description provided. **Credential required**: *Yes* / **Permission**: *write:pages* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/pages/update.ts tags: - pages security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: pageId: type: string format: misskey:id title: type: string name: type: string minLength: 1 summary: type: string nullable: true content: type: array items: type: object additionalProperties: true variables: type: array items: type: object additionalProperties: true script: type: string eyeCatchingImageId: type: string format: misskey:id nullable: true font: type: string enum: - serif - sans-serif alignCenter: type: boolean hideTitleWhenPinned: type: boolean required: - pageId - title - name - content - variables - script responses: "204": description: OK (without any results) "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_PAGE: value: error: message: No such page. code: NO_SUCH_PAGE id: 21149b9e-3616-4778-9592-c4ce89f5a864 ACCESS_DENIED: value: error: message: Access denied. code: ACCESS_DENIED id: 3c15cd52-3b4b-4274-967d-6456fc4f792b NO_SUCH_FILE: value: error: message: No such file. code: NO_SUCH_FILE id: cfc23c7c-3887-490e-af30-0ed576703c82 NAME_ALREADY_EXISTS: value: error: message: Specified name already exists. code: NAME_ALREADY_EXISTS id: 2298a392-d4a1-44c5-9ebb-ac1aeaa5a9ab 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: To 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 /ping: post: operationId: ping summary: ping description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/ping.ts tags: - meta requestBody: required: true content: application/json: schema: type: object properties: {} required: [] responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false properties: pong: type: number optional: false nullable: false required: - pong "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 /pinned-users: post: operationId: pinned-users summary: pinned-users description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/pinned-users.ts tags: - users requestBody: required: true content: application/json: schema: type: object properties: {} required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: UserDetailed $ref: '#/components/schemas/UserDetailed' "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 /promo/read: post: operationId: promo/read summary: promo/read description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/promo/read.ts tags: - notes security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: noteId: type: string format: misskey:id required: - noteId responses: "204": description: OK (without any results) "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: d785b897-fcd3-4fe9-8fc3-b85c26e6c932 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 /request-reset-password: post: operationId: request-reset-password summary: request-reset-password description: |- Request a users password to be reset. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/request-reset-password.ts tags: - reset password requestBody: required: true content: application/json: schema: type: object properties: username: type: string email: type: string required: - username - email 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 "429": description: To 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 /reset-db: post: operationId: reset-db summary: reset-db description: |- Only available when running with NODE_ENV=testing. Reset the database and flush Redis. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/reset-db.ts tags: - non-productive requestBody: required: true content: application/json: schema: type: object properties: {} required: [] 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 /reset-password: post: operationId: reset-password summary: reset-password description: |- Complete the password reset that was previously requested. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/reset-password.ts tags: - reset password requestBody: required: true content: application/json: schema: type: object properties: token: type: string password: type: string required: - token - password 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 /server-info: post: operationId: server-info summary: server-info description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/server-info.ts tags: - meta requestBody: required: true content: application/json: schema: type: object properties: {} required: [] 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 /stats: post: operationId: stats summary: stats description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/stats.ts tags: - meta requestBody: required: true content: application/json: schema: type: object properties: {} required: [] responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false properties: notesCount: type: number optional: false nullable: false originalNotesCount: type: number optional: false nullable: false usersCount: type: number optional: false nullable: false originalUsersCount: type: number optional: false nullable: false instances: type: number optional: false nullable: false driveUsageLocal: type: number optional: false nullable: false driveUsageRemote: type: number optional: false nullable: false required: - notesCount - originalNotesCount - usersCount - originalUsersCount - instances - driveUsageLocal - driveUsageRemote "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: sw/register summary: sw/register description: |- Register to receive push notifications. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/sw/register.ts tags: - account security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: endpoint: type: string auth: type: string publickey: type: string required: - endpoint - auth - publickey responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false properties: state: type: string optional: true nullable: false enum: - already-subscribed - subscribed key: type: string optional: false nullable: true required: - key "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: sw/unregister summary: sw/unregister description: |- Unregister from receiving push notifications. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/sw/unregister.ts tags: - account security: - ApiKeyAuth: [] 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 /test: post: operationId: test summary: test description: |- Endpoint for testing input validation. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/test.ts tags: - non-productive requestBody: required: true content: application/json: schema: type: object properties: required: type: boolean string: type: string default: type: string default: hello nullableDefault: type: string nullable: true default: hello id: type: string format: misskey:id required: - required 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 /username/available: post: operationId: username/available summary: username/available description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/username/available.ts tags: - users requestBody: required: true content: application/json: schema: type: object properties: username: type: string pattern: ^\w{1,20}$ required: - username responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false properties: available: type: boolean optional: false nullable: false required: - available "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 /users: post: operationId: users summary: users description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users.ts tags: - users requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 10 offset: type: integer default: 0 sort: type: string enum: - +follower - -follower - +createdAt - -createdAt - +updatedAt - -updatedAt state: type: string enum: - all - admin - moderator - adminOrModerator - alive default: all origin: type: string enum: - combined - local - remote default: local hostname: type: string nullable: true default: null description: The local host is represented with `null`. required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: UserDetailed $ref: '#/components/schemas/UserDetailed' "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 /users/clips: post: operationId: users/clips summary: users/clips description: |- Show all clips this user owns. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users/clips.ts tags: - users requestBody: required: true content: application/json: schema: type: object properties: userId: 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: - userId responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Clip $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 /users/followers: post: operationId: users/followers summary: users/followers description: |- Show everyone that follows this user. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users/followers.ts tags: - users requestBody: required: true content: application/json: schema: type: object properties: sinceId: type: string format: misskey:id untilId: type: string format: misskey:id limit: type: integer minimum: 1 maximum: 100 default: 10 anyOf: - properties: userId: type: string format: misskey:id required: - userId - properties: username: type: string host: type: string nullable: true description: The local host is represented with `null`. required: - username - host responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Following $ref: '#/components/schemas/Following' "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: 27fa5435-88ab-43de-9360-387de88727cd FORBIDDEN: value: error: message: Forbidden. code: FORBIDDEN id: 3c6a84db-d619-26af-ca14-06232a21df8a 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/following: post: operationId: users/following summary: users/following description: |- Show everyone that this user is following. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users/following.ts tags: - users requestBody: required: true content: application/json: schema: type: object properties: sinceId: type: string format: misskey:id untilId: type: string format: misskey:id limit: type: integer minimum: 1 maximum: 100 default: 10 anyOf: - properties: userId: type: string format: misskey:id required: - userId - properties: username: type: string host: type: string nullable: true description: The local host is represented with `null`. required: - username - host responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Following $ref: '#/components/schemas/Following' "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: 63e4aba4-4156-4e53-be25-c9559e42d71b FORBIDDEN: value: error: message: Forbidden. code: FORBIDDEN id: f6cdb0df-c19f-ec5c-7dbb-0ba84a1f92ba 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/gallery/posts: post: operationId: users/gallery/posts summary: users/gallery/posts description: |- Show all gallery posts by the given user. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users/gallery/posts.ts tags: - users requestBody: required: true content: application/json: schema: type: object properties: userId: 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: - userId responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: GalleryPost $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 /users/get-frequently-replied-users: post: operationId: users/get-frequently-replied-users summary: users/get-frequently-replied-users description: |- Get a list of other users that the specified user frequently replies to. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users/get-frequently-replied-users.ts tags: - users requestBody: required: true content: application/json: schema: type: object properties: userId: type: string format: misskey:id limit: type: integer minimum: 1 maximum: 100 default: 10 required: - userId responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false properties: user: type: object optional: false nullable: false ref: UserDetailed $ref: '#/components/schemas/UserDetailed' weight: type: number optional: false nullable: false required: - user - weight "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: e6965129-7b2a-40a4-bae2-cd84cd434822 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/groups/create: post: operationId: users/groups/create summary: users/groups/create description: |- Create a new group. **Credential required**: *Yes* / **Permission**: *write:user-groups* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users/groups/create.ts tags: - groups security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 100 required: - name responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false ref: UserGroup $ref: '#/components/schemas/UserGroup' "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 /users/groups/delete: post: operationId: users/groups/delete summary: users/groups/delete description: |- Delete an existing group. **Credential required**: *Yes* / **Permission**: *write:user-groups* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users/groups/delete.ts tags: - groups security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: groupId: type: string format: misskey:id required: - groupId responses: "204": description: OK (without any results) "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_GROUP: value: error: message: No such group. code: NO_SUCH_GROUP id: 63dbd64c-cd77-413f-8e08-61781e210b38 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/groups/invitations/accept: post: operationId: users/groups/invitations/accept summary: users/groups/invitations/accept description: |- Join a group the authenticated user has been invited to. **Credential required**: *Yes* / **Permission**: *write:user-groups* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users/groups/invitations/accept.ts tags: - groups security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: invitationId: type: string format: misskey:id required: - invitationId responses: "204": description: OK (without any results) "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_INVITATION: value: error: message: No such invitation. code: NO_SUCH_INVITATION id: 98c11eca-c890-4f42-9806-c8c8303ebb5e 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/groups/invitations/reject: post: operationId: users/groups/invitations/reject summary: users/groups/invitations/reject description: |- Delete an existing group invitation for the authenticated user without joining the group. **Credential required**: *Yes* / **Permission**: *write:user-groups* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users/groups/invitations/reject.ts tags: - groups security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: invitationId: type: string format: misskey:id required: - invitationId responses: "204": description: OK (without any results) "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_INVITATION: value: error: message: No such invitation. code: NO_SUCH_INVITATION id: ad7471d4-2cd9-44b4-ac68-e7136b4ce656 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/groups/invite: post: operationId: users/groups/invite summary: users/groups/invite description: |- Invite a user to an existing group. **Credential required**: *Yes* / **Permission**: *write:user-groups* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users/groups/invite.ts tags: - groups security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: groupId: type: string format: misskey:id userId: type: string format: misskey:id required: - groupId - userId responses: "204": description: OK (without any results) "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_GROUP: value: error: message: No such group. code: NO_SUCH_GROUP id: 583f8bc0-8eee-4b78-9299-1e14fc91e409 NO_SUCH_USER: value: error: message: No such user. code: NO_SUCH_USER id: da52de61-002c-475b-90e1-ba64f9cf13a8 ALREADY_ADDED: value: error: message: That user has already been added to that group. code: ALREADY_ADDED id: 7e35c6a0-39b2-4488-aea6-6ee20bd5da2c ALREADY_INVITED: value: error: message: That user has already been invited to that group. code: ALREADY_INVITED id: ee0f58b4-b529-4d13-b761-b9a3e69f97e6 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/groups/joined: post: operationId: users/groups/joined summary: users/groups/joined description: |- List the groups that the authenticated user is a member of. **Credential required**: *Yes* / **Permission**: *read:user-groups* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users/groups/joined.ts tags: - groups security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: {} required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: UserGroup $ref: '#/components/schemas/UserGroup' "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 /users/groups/leave: post: operationId: users/groups/leave summary: users/groups/leave description: |- Leave a group. The owner of a group can not leave. They must transfer ownership or delete the group instead. **Credential required**: *Yes* / **Permission**: *write:user-groups* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users/groups/leave.ts tags: - groups security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: groupId: type: string format: misskey:id required: - groupId responses: "204": description: OK (without any results) "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_GROUP: value: error: message: No such group. code: NO_SUCH_GROUP id: 62780270-1f67-5dc0-daca-3eb510612e31 YOU_ARE_OWNER: value: error: message: Your are the owner. code: YOU_ARE_OWNER id: b6d6e0c2-ef8a-9bb8-653d-79f4a3107c69 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/groups/owned: post: operationId: users/groups/owned summary: users/groups/owned description: |- List the groups that the authenticated user is the owner of. **Credential required**: *Yes* / **Permission**: *read:user-groups* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users/groups/owned.ts tags: - groups security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: {} required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: UserGroup $ref: '#/components/schemas/UserGroup' "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 /users/groups/pull: post: operationId: users/groups/pull summary: users/groups/pull description: |- Removes a specified user from a group. The owner can not be removed. **Credential required**: *Yes* / **Permission**: *write:user-groups* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users/groups/pull.ts tags: - groups security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: groupId: type: string format: misskey:id userId: type: string format: misskey:id required: - groupId - userId responses: "204": description: OK (without any results) "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_GROUP: value: error: message: No such group. code: NO_SUCH_GROUP id: 4662487c-05b1-4b78-86e5-fd46998aba74 NO_SUCH_USER: value: error: message: No such user. code: NO_SUCH_USER id: 0b5cc374-3681-41da-861e-8bc1146f7a55 IS_OWNER: value: error: message: The user is the owner. code: IS_OWNER id: 1546eed5-4414-4dea-81c1-b0aec4f6d2af 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/groups/show: post: operationId: users/groups/show summary: users/groups/show description: |- Show the properties of a group. **Credential required**: *Yes* / **Permission**: *read:user-groups* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users/groups/show.ts tags: - groups security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: groupId: type: string format: misskey:id required: - groupId responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false ref: UserGroup $ref: '#/components/schemas/UserGroup' "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_GROUP: value: error: message: No such group. code: NO_SUCH_GROUP id: ea04751e-9b7e-487b-a509-330fb6bd6b9b 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/groups/transfer: post: operationId: users/groups/transfer summary: users/groups/transfer description: |- Transfer ownership of a group from the authenticated user to another user. **Credential required**: *Yes* / **Permission**: *write:user-groups* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users/groups/transfer.ts tags: - groups security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: groupId: type: string format: misskey:id userId: type: string format: misskey:id required: - groupId - userId responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false ref: UserGroup $ref: '#/components/schemas/UserGroup' "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_GROUP: value: error: message: No such group. code: NO_SUCH_GROUP id: 8e31d36b-2f88-4ccd-a438-e2d78a9162db NO_SUCH_USER: value: error: message: No such user. code: NO_SUCH_USER id: 711f7ebb-bbb9-4dfa-b540-b27809fed5e9 NO_SUCH_GROUP_MEMBER: value: error: message: No such group member. code: NO_SUCH_GROUP_MEMBER id: d31bebee-196d-42c2-9a3e-9474d4be6cc4 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/groups/update: post: operationId: users/groups/update summary: users/groups/update description: |- Update the properties of a group. **Credential required**: *Yes* / **Permission**: *write:user-groups* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users/groups/update.ts tags: - groups security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: groupId: type: string format: misskey:id name: type: string minLength: 1 maxLength: 100 required: - groupId - name responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false ref: UserGroup $ref: '#/components/schemas/UserGroup' "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_GROUP: value: error: message: No such group. code: NO_SUCH_GROUP id: 9081cda3-7a9e-4fac-a6ce-908d70f282f6 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/lists/create: post: operationId: users/lists/create summary: users/lists/create description: |- Create a new list of users. **Credential required**: *Yes* / **Permission**: *write:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users/lists/create.ts tags: - lists security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 100 required: - name responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false ref: UserList $ref: '#/components/schemas/UserList' "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 /users/lists/delete: post: operationId: users/lists/delete summary: users/lists/delete description: |- Delete an existing list of users. **Credential required**: *Yes* / **Permission**: *write:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users/lists/delete.ts tags: - lists security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: listId: type: string format: misskey:id required: - listId 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: 78436795-db79-42f5-b1e2-55ea2cf19166 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/lists/list: post: operationId: users/lists/list summary: users/lists/list description: |- Show all lists that the authenticated user has created. **Credential required**: *Yes* / **Permission**: *read:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users/lists/list.ts tags: - lists security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: {} required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: UserList $ref: '#/components/schemas/UserList' "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 /users/lists/pull: post: operationId: users/lists/pull summary: users/lists/pull description: |- Remove a user from a list. **Credential required**: *Yes* / **Permission**: *write:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users/lists/pull.ts tags: - lists security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: listId: type: string format: misskey:id userId: type: string format: misskey:id required: - listId - userId 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: 7f44670e-ab16-43b8-b4c1-ccd2ee89cc02 NO_SUCH_USER: value: error: message: No such user. code: NO_SUCH_USER id: 588e7f72-c744-4a61-b180-d354e912bda2 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/lists/push: post: operationId: users/lists/push summary: users/lists/push description: |- Add a user to an existing list. **Credential required**: *Yes* / **Permission**: *write:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users/lists/push.ts tags: - lists security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: listId: type: string format: misskey:id userId: type: string format: misskey:id required: - listId - userId 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: 2214501d-ac96-4049-b717-91e42272a711 NO_SUCH_USER: value: error: message: No such user. code: NO_SUCH_USER id: a89abd3d-f0bc-4cce-beb1-2f446f4f1e6a ALREADY_ADDED: value: error: message: That user has already been added to that list. code: ALREADY_ADDED id: 1de7c884-1595-49e9-857e-61f12f4d4fc5 YOU_HAVE_BEEN_BLOCKED: value: error: message: You cannot push this user because you have been blocked by this user. code: YOU_HAVE_BEEN_BLOCKED id: 990232c5-3f9d-4d83-9f3f-ef27b6332a4b 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/lists/show: post: operationId: users/lists/show summary: users/lists/show description: |- Show the properties of a list. **Credential required**: *Yes* / **Permission**: *read:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users/lists/show.ts tags: - lists security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: listId: type: string format: misskey:id required: - listId responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false ref: UserList $ref: '#/components/schemas/UserList' "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: 7bc05c21-1d7a-41ae-88f1-66820f4dc686 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/lists/update: post: operationId: users/lists/update summary: users/lists/update description: |- Update the properties of a list. **Credential required**: *Yes* / **Permission**: *write:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users/lists/update.ts tags: - lists security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: listId: type: string format: misskey:id name: type: string minLength: 1 maxLength: 100 required: - listId - name responses: "200": description: OK (with results) content: application/json: schema: type: object optional: false nullable: false ref: UserList $ref: '#/components/schemas/UserList' "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: 796666fe-3dff-4d39-becb-8a5932c1d5b7 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/notes: post: operationId: users/notes summary: users/notes description: |- Show all notes that this user created. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users/notes.ts tags: - users requestBody: required: true content: application/json: schema: type: object properties: userId: type: string format: misskey:id includeReplies: type: boolean default: true limit: type: integer minimum: 1 maximum: 100 default: 10 sinceId: type: string format: misskey:id untilId: type: string format: misskey:id sinceDate: type: integer untilDate: type: integer includeMyRenotes: type: boolean default: true withFiles: type: boolean default: false fileType: type: array items: type: string excludeNsfw: type: boolean default: false required: - userId responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Note $ref: '#/components/schemas/Note' "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: 27e494ba-2ac2-48e8-893b-10d4d8c2387b 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/pages: post: operationId: users/pages summary: users/pages description: |- Show all pages this user created. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users/pages.ts tags: - users requestBody: required: true content: application/json: schema: type: object properties: userId: 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: - userId responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: Page $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 /users/reactions: post: operationId: users/reactions summary: users/reactions description: |- Show all reactions this user made. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users/reactions.ts tags: - users requestBody: required: true content: application/json: schema: type: object properties: userId: 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 sinceDate: type: integer untilDate: type: integer required: - userId responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: NoteReaction $ref: '#/components/schemas/NoteReaction' "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: REACTIONS_NOT_PUBLIC: value: error: message: Reactions of the user is not public. code: REACTIONS_NOT_PUBLIC id: 673a7dd2-6924-1093-e0c0-e68456ceae5c 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/recommendation: post: operationId: users/recommendation summary: users/recommendation description: |- Show users that the authenticated user might be interested to follow. **Credential required**: *Yes* / **Permission**: *read:account* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users/recommendation.ts tags: - users security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 10 offset: type: integer default: 0 required: [] responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: UserDetailed $ref: '#/components/schemas/UserDetailed' "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 /users/relation: post: operationId: users/relation summary: users/relation description: |- Show the different kinds of relations between the authenticated user and the specified user(s). **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users/relation.ts tags: - users security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: userId: anyOf: - type: string format: misskey:id - type: array items: type: string format: misskey:id required: - userId responses: "200": description: OK (with results) content: application/json: schema: optional: false nullable: false oneOf: - type: object properties: id: type: string optional: false nullable: false format: id isFollowing: type: boolean optional: false nullable: false hasPendingFollowRequestFromYou: type: boolean optional: false nullable: false hasPendingFollowRequestToYou: type: boolean optional: false nullable: false isFollowed: type: boolean optional: false nullable: false isBlocking: type: boolean optional: false nullable: false isBlocked: type: boolean optional: false nullable: false isMuted: type: boolean optional: false nullable: false required: - id - isFollowing - hasPendingFollowRequestFromYou - hasPendingFollowRequestToYou - isFollowed - isBlocking - isBlocked - isMuted - type: array items: type: object optional: false nullable: false properties: id: type: string optional: false nullable: false format: id isFollowing: type: boolean optional: false nullable: false hasPendingFollowRequestFromYou: type: boolean optional: false nullable: false hasPendingFollowRequestToYou: type: boolean optional: false nullable: false isFollowed: type: boolean optional: false nullable: false isBlocking: type: boolean optional: false nullable: false isBlocked: type: boolean optional: false nullable: false isMuted: type: boolean optional: false nullable: false required: - id - isFollowing - hasPendingFollowRequestFromYou - hasPendingFollowRequestToYou - isFollowed - isBlocking - isBlocked - isMuted "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 /users/report-abuse: post: operationId: users/report-abuse summary: users/report-abuse description: |- File a report. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users/report-abuse.ts tags: - users security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: userId: type: string format: misskey:id comment: type: string minLength: 1 maxLength: 2048 required: - userId - comment 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: 1acefcb5-0959-43fd-9685-b48305736cb5 CANNOT_REPORT_YOURSELF: value: error: message: Cannot report yourself. code: CANNOT_REPORT_YOURSELF id: 1e13149e-b1e8-43cf-902e-c01dbfcb202f CANNOT_REPORT_THE_ADMIN: value: error: message: Cannot report the admin. code: CANNOT_REPORT_THE_ADMIN id: 35e166f5-05fb-4f87-a2d5-adb42676d48f 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/search-by-username-and-host: post: operationId: users/search-by-username-and-host summary: users/search-by-username-and-host description: |- Search for a user by username and/or host. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users/search-by-username-and-host.ts tags: - users requestBody: required: true content: application/json: schema: type: object properties: username: type: string nullable: true host: type: string nullable: true limit: type: integer minimum: 1 maximum: 100 default: 10 detail: type: boolean default: true anyOf: - required: - username - required: - host responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: User $ref: '#/components/schemas/User' "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 /users/search: post: operationId: users/search summary: users/search description: |- Search for users. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users/search.ts tags: - users requestBody: required: true content: application/json: schema: type: object properties: query: type: string offset: type: integer default: 0 limit: type: integer minimum: 1 maximum: 100 default: 10 origin: type: string enum: - local - remote - combined default: combined detail: type: boolean default: true required: - query responses: "200": description: OK (with results) content: application/json: schema: type: array optional: false nullable: false items: type: object optional: false nullable: false ref: User $ref: '#/components/schemas/User' "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 /users/show: post: operationId: users/show summary: users/show description: |- Show the properties of a user. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users/show.ts tags: - users requestBody: required: true content: application/json: schema: type: object anyOf: - properties: userId: type: string format: misskey:id required: - userId - properties: userIds: type: array uniqueItems: true items: type: string format: misskey:id required: - userIds - properties: username: type: string host: type: string nullable: true description: The local host is represented with `null`. required: - username responses: "200": description: OK (with results) content: application/json: schema: optional: false nullable: false oneOf: - type: object ref: UserDetailed $ref: '#/components/schemas/UserDetailed' - type: array items: type: object ref: UserDetailed $ref: '#/components/schemas/UserDetailed' "400": description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: FAILED_TO_RESOLVE_REMOTE_USER: value: error: message: Failed to resolve remote user. code: FAILED_TO_RESOLVE_REMOTE_USER id: ef7b9be4-9cba-4e6f-ab41-90ed171c7d3c kind: server NO_SUCH_USER: value: error: message: No such user. code: NO_SUCH_USER id: 4362f8dc-731f-4ad8-a694-be5a88922a24 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/stats: post: operationId: users/stats summary: users/stats description: |- Show statistics about a user. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/users/stats.ts tags: - users 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 optional: false nullable: false properties: notesCount: type: integer optional: false nullable: false repliesCount: type: integer optional: false nullable: false renotesCount: type: integer optional: false nullable: false repliedCount: type: integer optional: false nullable: false renotedCount: type: integer optional: false nullable: false pollVotesCount: type: integer optional: false nullable: false pollVotedCount: type: integer optional: false nullable: false localFollowingCount: type: integer optional: false nullable: false remoteFollowingCount: type: integer optional: false nullable: false localFollowersCount: type: integer optional: false nullable: false remoteFollowersCount: type: integer optional: false nullable: false followingCount: type: integer optional: false nullable: false followersCount: type: integer optional: false nullable: false sentReactionsCount: type: integer optional: false nullable: false receivedReactionsCount: type: integer optional: false nullable: false noteFavoritesCount: type: integer optional: false nullable: false pageLikesCount: type: integer optional: false nullable: false pageLikedCount: type: integer optional: false nullable: false driveFilesCount: type: integer optional: false nullable: false driveUsage: type: integer optional: false nullable: false description: Drive usage in bytes required: - notesCount - repliesCount - renotesCount - repliedCount - renotedCount - pollVotesCount - pollVotedCount - localFollowingCount - remoteFollowingCount - localFollowersCount - remoteFollowersCount - followingCount - followersCount - sentReactionsCount - receivedReactionsCount - noteFavoritesCount - pageLikesCount - pageLikedCount - driveFilesCount - driveUsage "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: 9e638e45-3b25-4ef7-8f95-07e8498f1819 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 /admin/drive-capacity-override: post: operationId: admin/drive-capacity-override summary: admin/drive-capacity-override description: |- No description provided. **Credential required**: *Yes* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/admin/drive-capacity-override.ts tags: - admin security: - ApiKeyAuth: [] requestBody: required: true content: application/json: schema: type: object properties: userId: type: string format: misskey:id overrideMb: type: number nullable: true required: - userId - overrideMb 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 /fetch-rss: post: operationId: fetch-rss summary: fetch-rss description: |- No description provided. **Credential required**: *No* externalDocs: description: Source code url: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/fetch-rss.ts tags: - meta requestBody: required: true content: application/json: schema: type: object properties: url: type: string required: - url 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 components: schemas: 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 UserLite: type: object properties: id: type: string nullable: false optional: false format: id example: xxxxxxxxxx name: type: string nullable: true optional: false example: 藍 username: type: string nullable: false optional: false example: ai host: type: string nullable: true optional: false example: misskey.example.com description: The local host is represented with `null`. avatarUrl: type: string format: url nullable: true optional: false avatarBlurhash: type: any nullable: true optional: false avatarColor: type: any nullable: true optional: false default: null isAdmin: type: boolean nullable: false optional: true default: false isModerator: type: boolean nullable: false optional: true default: false isBot: type: boolean nullable: false optional: true isCat: type: boolean nullable: false optional: true emojis: type: array nullable: false optional: false items: type: object nullable: false optional: false properties: name: type: string nullable: false optional: false url: type: string nullable: false optional: false format: url required: - name - url onlineStatus: type: string format: url nullable: true optional: false enum: - unknown - online - active - offline required: - id - name - username - host - avatarUrl - avatarBlurhash - avatarColor - emojis - onlineStatus UserDetailedNotMeOnly: type: object properties: url: type: string format: url nullable: true optional: false uri: type: string format: uri nullable: true optional: false createdAt: type: string nullable: false optional: false format: date-time updatedAt: type: string nullable: true optional: false format: date-time lastFetchedAt: type: string nullable: true optional: false format: date-time bannerUrl: type: string format: url nullable: true optional: false bannerBlurhash: type: any nullable: true optional: false bannerColor: type: any nullable: true optional: false default: null isLocked: type: boolean nullable: false optional: false isSilenced: type: boolean nullable: false optional: false isSuspended: type: boolean nullable: false optional: false example: false description: type: string nullable: true optional: false example: Hi masters, I am Ai! location: type: string nullable: true optional: false birthday: type: string nullable: true optional: false example: "2018-03-12" lang: type: string nullable: true optional: false example: ja-JP fields: type: array nullable: false optional: false items: type: object nullable: false optional: false properties: name: type: string nullable: false optional: false value: type: string nullable: false optional: false maxLength: 4 required: - name - value followersCount: type: number nullable: false optional: false followingCount: type: number nullable: false optional: false notesCount: type: number nullable: false optional: false pinnedNoteIds: type: array nullable: false optional: false items: type: string nullable: false optional: false format: id pinnedNotes: type: array nullable: false optional: false items: type: object nullable: false optional: false ref: Note $ref: '#/components/schemas/Note' pinnedPageId: type: string nullable: true optional: false pinnedPage: type: object nullable: true optional: false ref: Page $ref: '#/components/schemas/Page' publicReactions: type: boolean nullable: false optional: false twoFactorEnabled: type: boolean nullable: false optional: false default: false usePasswordLessLogin: type: boolean nullable: false optional: false default: false securityKeys: type: boolean nullable: false optional: false default: false isFollowing: type: boolean nullable: false optional: true isFollowed: type: boolean nullable: false optional: true hasPendingFollowRequestFromYou: type: boolean nullable: false optional: true hasPendingFollowRequestToYou: type: boolean nullable: false optional: true isBlocking: type: boolean nullable: false optional: true isBlocked: type: boolean nullable: false optional: true isMuted: type: boolean nullable: false optional: true required: - url - uri - createdAt - updatedAt - lastFetchedAt - bannerUrl - bannerBlurhash - bannerColor - isLocked - isSilenced - isSuspended - description - location - birthday - lang - fields - followersCount - followingCount - notesCount - pinnedNoteIds - pinnedNotes - pinnedPageId - pinnedPage - publicReactions - twoFactorEnabled - usePasswordLessLogin - securityKeys MeDetailedOnly: type: object properties: avatarId: type: string nullable: true optional: false format: id bannerId: type: string nullable: true optional: false format: id injectFeaturedNote: type: boolean nullable: true optional: false receiveAnnouncementEmail: type: boolean nullable: true optional: false alwaysMarkNsfw: type: boolean nullable: true optional: false autoSensitive: type: boolean nullable: true optional: false carefulBot: type: boolean nullable: true optional: false autoAcceptFollowed: type: boolean nullable: true optional: false noCrawle: type: boolean nullable: true optional: false isExplorable: type: boolean nullable: false optional: false isDeleted: type: boolean nullable: false optional: false hideOnlineStatus: type: boolean nullable: false optional: false hasUnreadSpecifiedNotes: type: boolean nullable: false optional: false hasUnreadMentions: type: boolean nullable: false optional: false hasUnreadAnnouncement: type: boolean nullable: false optional: false hasUnreadAntenna: type: boolean nullable: false optional: false hasUnreadChannel: type: boolean nullable: false optional: false hasUnreadMessagingMessage: type: boolean nullable: false optional: false hasUnreadNotification: type: boolean nullable: false optional: false hasPendingReceivedFollowRequest: type: boolean nullable: false optional: false integrations: type: object nullable: true optional: false mutedWords: type: array nullable: false optional: false items: type: array nullable: false optional: false items: type: string nullable: false optional: false mutedInstances: type: array nullable: true optional: false items: type: string nullable: false optional: false mutingNotificationTypes: type: array nullable: true optional: false items: type: string nullable: false optional: false emailNotificationTypes: type: array nullable: true optional: false items: type: string nullable: false optional: false email: type: string nullable: true optional: true emailVerified: type: boolean nullable: true optional: true securityKeysList: type: array nullable: false optional: true items: type: object nullable: false optional: false required: - avatarId - bannerId - injectFeaturedNote - receiveAnnouncementEmail - alwaysMarkNsfw - autoSensitive - carefulBot - autoAcceptFollowed - noCrawle - isExplorable - isDeleted - hideOnlineStatus - hasUnreadSpecifiedNotes - hasUnreadMentions - hasUnreadAnnouncement - hasUnreadAntenna - hasUnreadChannel - hasUnreadMessagingMessage - hasUnreadNotification - hasPendingReceivedFollowRequest - integrations - mutedWords - mutedInstances - mutingNotificationTypes - emailNotificationTypes UserDetailedNotMe: type: object allOf: - type: object ref: UserLite $ref: '#/components/schemas/UserLite' - type: object ref: UserDetailedNotMeOnly $ref: '#/components/schemas/UserDetailedNotMeOnly' MeDetailed: type: object allOf: - type: object ref: UserLite $ref: '#/components/schemas/UserLite' - type: object ref: UserDetailedNotMeOnly $ref: '#/components/schemas/UserDetailedNotMeOnly' - type: object ref: MeDetailedOnly $ref: '#/components/schemas/MeDetailedOnly' UserDetailed: oneOf: - type: object ref: UserDetailedNotMe $ref: '#/components/schemas/UserDetailedNotMe' - type: object ref: MeDetailed $ref: '#/components/schemas/MeDetailed' User: oneOf: - type: object ref: UserLite $ref: '#/components/schemas/UserLite' - type: object ref: UserDetailed $ref: '#/components/schemas/UserDetailed' UserList: type: object properties: id: type: string optional: false nullable: false format: id example: xxxxxxxxxx createdAt: type: string optional: false nullable: false format: date-time name: type: string optional: false nullable: false userIds: type: array nullable: false optional: true items: type: string nullable: false optional: false format: id required: - id - createdAt - name UserGroup: type: object properties: id: type: string optional: false nullable: false format: id example: xxxxxxxxxx createdAt: type: string optional: false nullable: false format: date-time name: type: string optional: false nullable: false ownerId: type: string nullable: false optional: false format: id userIds: type: array nullable: false optional: true items: type: string nullable: false optional: false format: id required: - id - createdAt - name - ownerId App: type: object properties: id: type: string optional: false nullable: false name: type: string optional: false nullable: false callbackUrl: type: string optional: false nullable: true permission: type: array optional: false nullable: false items: type: string optional: false nullable: false secret: type: string optional: true nullable: false isAuthorized: type: boolean optional: true nullable: false required: - id - name - callbackUrl - permission MessagingMessage: type: object properties: id: type: string optional: false nullable: false format: id example: xxxxxxxxxx createdAt: type: string optional: false nullable: false format: date-time userId: type: string optional: false nullable: false format: id user: type: object ref: UserLite optional: true nullable: false $ref: '#/components/schemas/UserLite' text: type: string optional: false nullable: true fileId: type: string optional: true nullable: true format: id file: type: object optional: true nullable: true ref: DriveFile $ref: '#/components/schemas/DriveFile' recipientId: type: string optional: false nullable: true format: id recipient: type: object optional: true nullable: true ref: UserLite $ref: '#/components/schemas/UserLite' groupId: type: string optional: false nullable: true format: id group: type: object optional: true nullable: true ref: UserGroup $ref: '#/components/schemas/UserGroup' isRead: type: boolean optional: true nullable: false reads: type: array optional: true nullable: false items: type: string optional: false nullable: false format: id required: - id - createdAt - userId - text - recipientId - groupId Note: type: object properties: id: type: string optional: false nullable: false format: id example: xxxxxxxxxx createdAt: type: string optional: false nullable: false format: date-time text: type: string optional: false nullable: true cw: type: string optional: true nullable: true userId: type: string optional: false nullable: false format: id user: type: object ref: UserLite optional: false nullable: false $ref: '#/components/schemas/UserLite' replyId: type: string optional: true nullable: true format: id example: xxxxxxxxxx renoteId: type: string optional: true nullable: true format: id example: xxxxxxxxxx reply: type: object optional: true nullable: true ref: Note $ref: '#/components/schemas/Note' renote: type: object optional: true nullable: true ref: Note $ref: '#/components/schemas/Note' isHidden: type: boolean optional: true nullable: false visibility: type: string optional: false nullable: false mentions: type: array optional: true nullable: false items: type: string optional: false nullable: false format: id visibleUserIds: type: array optional: true nullable: false items: type: string optional: false nullable: false format: id fileIds: type: array optional: true nullable: false items: type: string optional: false nullable: false format: id files: type: array optional: true nullable: false items: type: object optional: false nullable: false ref: DriveFile $ref: '#/components/schemas/DriveFile' tags: type: array optional: true nullable: false items: type: string optional: false nullable: false poll: type: object optional: true nullable: true channelId: type: string optional: true nullable: true format: id example: xxxxxxxxxx channel: type: object optional: true nullable: true items: type: object optional: false nullable: false properties: id: type: string optional: false nullable: false name: type: string optional: false nullable: true localOnly: type: boolean optional: true nullable: false emojis: type: array optional: false nullable: false items: type: object optional: false nullable: false properties: name: type: string optional: false nullable: false url: type: string optional: false nullable: true required: - name - url reactions: type: object optional: false nullable: false renoteCount: type: number optional: false nullable: false repliesCount: type: number optional: false nullable: false uri: type: string optional: true nullable: false url: type: string optional: true nullable: false myReaction: type: object optional: true nullable: true required: - id - createdAt - text - userId - user - visibility - emojis - reactions - renoteCount - repliesCount NoteReaction: type: object properties: id: type: string optional: false nullable: false format: id example: xxxxxxxxxx createdAt: type: string optional: false nullable: false format: date-time user: type: object optional: false nullable: false ref: UserLite $ref: '#/components/schemas/UserLite' type: type: string optional: false nullable: false required: - id - createdAt - user - type NoteFavorite: type: object properties: id: type: string optional: false nullable: false format: id example: xxxxxxxxxx createdAt: type: string optional: false nullable: false format: date-time note: type: object optional: false nullable: false ref: Note $ref: '#/components/schemas/Note' noteId: type: string optional: false nullable: false format: id required: - id - createdAt - note - noteId Notification: type: object properties: id: type: string optional: false nullable: false format: id example: xxxxxxxxxx createdAt: type: string optional: false nullable: false format: date-time isRead: type: boolean optional: false nullable: false type: type: string optional: false nullable: false enum: - follow - mention - reply - renote - quote - reaction - pollVote - pollEnded - receiveFollowRequest - followRequestAccepted - groupInvited - app user: type: object ref: UserLite optional: true nullable: true $ref: '#/components/schemas/UserLite' userId: type: string optional: true nullable: true format: id note: type: object ref: Note optional: true nullable: true $ref: '#/components/schemas/Note' reaction: type: string optional: true nullable: true choice: type: number optional: true nullable: true invitation: type: object optional: true nullable: true body: type: string optional: true nullable: true header: type: string optional: true nullable: true icon: type: string optional: true nullable: true required: - id - createdAt - isRead - type DriveFile: type: object properties: id: type: string optional: false nullable: false format: id example: xxxxxxxxxx createdAt: type: string optional: false nullable: false format: date-time name: type: string optional: false nullable: false example: lenna.jpg type: type: string optional: false nullable: false example: image/jpeg md5: type: string optional: false nullable: false format: md5 example: 15eca7fba0480996e2245f5185bf39f2 size: type: number optional: false nullable: false example: 51469 isSensitive: type: boolean optional: false nullable: false blurhash: type: string optional: false nullable: true properties: type: object optional: false nullable: false properties: width: type: number optional: true nullable: false example: 1280 height: type: number optional: true nullable: false example: 720 orientation: type: number optional: true nullable: false example: 8 avgColor: type: string optional: true nullable: false example: rgb(40,65,87) required: [] url: type: string optional: false nullable: true format: url thumbnailUrl: type: string optional: false nullable: true format: url comment: type: string optional: false nullable: true folderId: type: string optional: false nullable: true format: id example: xxxxxxxxxx folder: type: object optional: true nullable: true ref: DriveFolder $ref: '#/components/schemas/DriveFolder' userId: type: string optional: false nullable: true format: id example: xxxxxxxxxx user: type: object optional: true nullable: true ref: UserLite $ref: '#/components/schemas/UserLite' required: - id - createdAt - name - type - md5 - size - isSensitive - blurhash - properties - url - thumbnailUrl - comment - folderId - userId DriveFolder: type: object properties: id: type: string optional: false nullable: false format: id example: xxxxxxxxxx createdAt: type: string optional: false nullable: false format: date-time name: type: string optional: false nullable: false foldersCount: type: number optional: true nullable: false filesCount: type: number optional: true nullable: false parentId: type: string optional: false nullable: true format: id example: xxxxxxxxxx parent: type: object optional: true nullable: true ref: DriveFolder $ref: '#/components/schemas/DriveFolder' required: - id - createdAt - name - parentId Following: type: object properties: id: type: string optional: false nullable: false format: id example: xxxxxxxxxx createdAt: type: string optional: false nullable: false format: date-time followeeId: type: string optional: false nullable: false format: id followee: type: object optional: true nullable: false ref: UserDetailed $ref: '#/components/schemas/UserDetailed' followerId: type: string optional: false nullable: false format: id follower: type: object optional: true nullable: false ref: UserDetailed $ref: '#/components/schemas/UserDetailed' required: - id - createdAt - followeeId - followerId Muting: type: object properties: id: type: string optional: false nullable: false format: id example: xxxxxxxxxx createdAt: type: string optional: false nullable: false format: date-time expiresAt: type: string optional: false nullable: true format: date-time muteeId: type: string optional: false nullable: false format: id mutee: type: object optional: false nullable: false ref: UserDetailed $ref: '#/components/schemas/UserDetailed' required: - id - createdAt - expiresAt - muteeId - mutee Blocking: type: object properties: id: type: string optional: false nullable: false format: id example: xxxxxxxxxx createdAt: type: string optional: false nullable: false format: date-time blockeeId: type: string optional: false nullable: false format: id blockee: type: object optional: false nullable: false ref: UserDetailed $ref: '#/components/schemas/UserDetailed' required: - id - createdAt - blockeeId - blockee Hashtag: type: object properties: tag: type: string optional: false nullable: false example: misskey mentionedUsersCount: type: number optional: false nullable: false mentionedLocalUsersCount: type: number optional: false nullable: false mentionedRemoteUsersCount: type: number optional: false nullable: false attachedUsersCount: type: number optional: false nullable: false attachedLocalUsersCount: type: number optional: false nullable: false attachedRemoteUsersCount: type: number optional: false nullable: false required: - tag - mentionedUsersCount - mentionedLocalUsersCount - mentionedRemoteUsersCount - attachedUsersCount - attachedLocalUsersCount - attachedRemoteUsersCount Page: type: object properties: id: type: string optional: false nullable: false format: id example: xxxxxxxxxx createdAt: type: string optional: false nullable: false format: date-time updatedAt: type: string optional: false nullable: false format: date-time title: type: string optional: false nullable: false name: type: string optional: false nullable: false summary: type: string optional: false nullable: true content: type: array optional: false nullable: false variables: type: array optional: false nullable: false userId: type: string optional: false nullable: false format: id user: type: object ref: UserLite optional: false nullable: false $ref: '#/components/schemas/UserLite' required: - id - createdAt - updatedAt - title - name - summary - content - variables - userId - user Channel: type: object properties: id: type: string optional: false nullable: false format: id example: xxxxxxxxxx createdAt: type: string optional: false nullable: false format: date-time lastNotedAt: type: string optional: false nullable: true format: date-time name: type: string optional: false nullable: false description: type: string nullable: true optional: false bannerUrl: type: string format: url nullable: true optional: false notesCount: type: number nullable: false optional: false usersCount: type: number nullable: false optional: false isFollowing: type: boolean optional: true nullable: false userId: type: string nullable: true optional: false format: id required: - id - createdAt - lastNotedAt - name - description - bannerUrl - notesCount - usersCount - userId QueueCount: type: object properties: waiting: type: number optional: false nullable: false active: type: number optional: false nullable: false completed: type: number optional: false nullable: false failed: type: number optional: false nullable: false delayed: type: number optional: false nullable: false required: - waiting - active - completed - failed - delayed Antenna: type: object properties: id: type: string optional: false nullable: false format: id createdAt: type: string optional: false nullable: false format: date-time name: type: string optional: false nullable: false keywords: type: array optional: false nullable: false items: type: array optional: false nullable: false items: type: string optional: false nullable: false excludeKeywords: type: array optional: false nullable: false items: type: array optional: false nullable: false items: type: string optional: false nullable: false src: type: string optional: false nullable: false enum: - home - all - users - list - group userListId: type: string optional: false nullable: true format: id userGroupId: type: string optional: false nullable: true format: id users: type: array optional: false nullable: false items: type: string optional: false nullable: false caseSensitive: type: boolean optional: false nullable: false default: false notify: type: boolean optional: false nullable: false withReplies: type: boolean optional: false nullable: false default: false withFile: type: boolean optional: false nullable: false hasUnreadNote: type: boolean optional: false nullable: false default: false required: - id - createdAt - name - keywords - excludeKeywords - src - userListId - userGroupId - users - caseSensitive - notify - withReplies - withFile - hasUnreadNote Clip: type: object properties: id: type: string optional: false nullable: false format: id example: xxxxxxxxxx createdAt: type: string optional: false nullable: false format: date-time userId: type: string optional: false nullable: false format: id user: type: object ref: UserLite optional: false nullable: false $ref: '#/components/schemas/UserLite' name: type: string optional: false nullable: false description: type: string optional: false nullable: true isPublic: type: boolean optional: false nullable: false required: - id - createdAt - userId - user - name - description - isPublic FederationInstance: type: object properties: id: type: string optional: false nullable: false format: id caughtAt: type: string optional: false nullable: false format: date-time host: type: string optional: false nullable: false example: misskey.example.com usersCount: type: number optional: false nullable: false notesCount: type: number optional: false nullable: false followingCount: type: number optional: false nullable: false followersCount: type: number optional: false nullable: false latestRequestSentAt: type: string optional: false nullable: true format: date-time lastCommunicatedAt: type: string optional: false nullable: false format: date-time isNotResponding: type: boolean optional: false nullable: false isSuspended: type: boolean optional: false nullable: false isBlocked: type: boolean optional: false nullable: false softwareName: type: string optional: false nullable: true example: misskey softwareVersion: type: string optional: false nullable: true example: 12.119.2 openRegistrations: type: boolean optional: false nullable: true example: true name: type: string optional: false nullable: true description: type: string optional: false nullable: true maintainerName: type: string optional: false nullable: true maintainerEmail: type: string optional: false nullable: true iconUrl: type: string optional: false nullable: true format: url faviconUrl: type: string optional: false nullable: true format: url themeColor: type: string optional: false nullable: true infoUpdatedAt: type: string optional: false nullable: true format: date-time required: - id - caughtAt - host - usersCount - notesCount - followingCount - followersCount - latestRequestSentAt - lastCommunicatedAt - isNotResponding - isSuspended - isBlocked - softwareName - softwareVersion - openRegistrations - name - description - maintainerName - maintainerEmail - iconUrl - faviconUrl - themeColor - infoUpdatedAt GalleryPost: type: object properties: id: type: string optional: false nullable: false format: id example: xxxxxxxxxx createdAt: type: string optional: false nullable: false format: date-time updatedAt: type: string optional: false nullable: false format: date-time title: type: string optional: false nullable: false description: type: string optional: false nullable: true userId: type: string optional: false nullable: false format: id user: type: object ref: UserLite optional: false nullable: false $ref: '#/components/schemas/UserLite' fileIds: type: array optional: true nullable: false items: type: string optional: false nullable: false format: id files: type: array optional: true nullable: false items: type: object optional: false nullable: false ref: DriveFile $ref: '#/components/schemas/DriveFile' tags: type: array optional: true nullable: false items: type: string optional: false nullable: false isSensitive: type: boolean optional: false nullable: false required: - id - createdAt - updatedAt - title - description - userId - user - isSensitive Emoji: type: object properties: id: type: string optional: false nullable: false format: id example: xxxxxxxxxx aliases: type: array optional: false nullable: false items: type: string optional: false nullable: false format: id name: type: string optional: false nullable: false category: type: string optional: false nullable: true host: type: string optional: false nullable: true description: The local host is represented with `null`. url: type: string optional: false nullable: false required: - id - aliases - name - category - host - url securitySchemes: ApiKeyAuth: type: apiKey in: body name: i