Misskey API

Misskey provides a comprehensive HTTP and streaming API for building clients, integration web services, bots, and similar applications. All HTTP API endpoints use POST requests with JSON request and response bodies. The API covers notes (posts), users, timelines, follows, drives, channels, notifications, federation via ActivityPub, and administrative operations. Authentication uses access tokens via the MiAuth flow or personal token generation, passed as the i parameter in the request body or via an Authorization Bearer header.

OpenAPI Specification

misskey-openapi.json Raw ↑
{"openapi":"3.1.0","info":{"version":"2025.4.1-io.12b-fb6fbea074","title":"Misskey API"},"externalDocs":{"description":"Repository","url":"https://github.com/MisskeyIO/misskey"},"servers":[{"url":"https://misskey.io/api"}],"paths":{"/admin/abuse-report-resolver/create":{"post":{"operationId":"post___admin___abuse-report-resolver___create","summary":"admin/abuse-report-resolver/create","description":"No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:abuse-report-resolvers*","externalDocs":{"description":"Source code","url":"https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/abuse-report-resolver/create.ts"},"tags":["admin"],"security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1},"targetUserPattern":{"type":["string","null"]},"reporterPattern":{"type":["string","null"]},"reportContentPattern":{"type":["string","null"]},"expiresAt":{"type":"string","enum":["1hour","12hours","1day","1week","1month","3months","6months","1year","indefinitely"]},"forward":{"type":"boolean"}},"required":["name","targetUserPattern","reporterPattern","reportContentPattern","expiresAt","forward"]}}}},"responses":{"200":{"description":"OK (with results)","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"targetUserPattern":{"type":["string","null"]},"reporterPattern":{"type":["string","null"]},"reportContentPattern":{"type":["string","null"]},"expiresAt":{"type":"string"},"forward":{"type":"boolean"}},"required":["name","targetUserPattern","reporterPattern","reportContentPattern","expiresAt","forward"]}}}},"400":{"description":"Client error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"INVALID_REGULAR_EXPRESSION_FOR_TARGET_USER":{"value":{"error":{"message":"Invalid regular expression for target user.","code":"INVALID_REGULAR_EXPRESSION_FOR_TARGET_USER","id":"c008484a-0a14-4e74-86f4-b176dc49fcaa"}}},"INVALID_REGULAR_EXPRESSION_FOR_REPORTER":{"value":{"error":{"message":"Invalid regular expression for reporter.","code":"INVALID_REGULAR_EXPRESSION_FOR_REPORTER","id":"399b4062-257f-44c8-87cc-4ffae2527fbc"}}},"INVALID_REGULAR_EXPRESSION_FOR_REPORT_CONTENT":{"value":{"error":{"message":"Invalid regular expression for report content.","code":"INVALID_REGULAR_EXPRESSION_FOR_REPORT_CONTENT","id":"88c124d8-f517-4c63-a464-0abc274168b"}}},"INVALID_PARAM":{"value":{"error":{"message":"Invalid param.","code":"INVALID_PARAM","id":"3d81ceae-475f-4600-b2a8-2bc116157532"}}}}}}},"401":{"description":"Authentication error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"CREDENTIAL_REQUIRED":{"value":{"error":{"message":"Credential required.","code":"CREDENTIAL_REQUIRED","id":"1384574d-a912-4b81-8601-c7b1c4085df1"}}}}}}},"403":{"description":"Forbidden error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"AUTHENTICATION_FAILED":{"value":{"error":{"message":"Authentication failed. Please ensure your token is correct.","code":"AUTHENTICATION_FAILED","id":"b0a7f5f8-dc2f-4171-b91f-de88ad238e14"}}}}}}},"418":{"description":"I'm Ai","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"I_AM_AI":{"value":{"error":{"message":"You sent a request to Ai-chan, Misskey's showgirl, instead of the server.","code":"I_AM_AI","id":"60c46cd1-f23a-46b1-bebe-5d2b73951a84"}}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"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-report-resolver/delete":{"post":{"operationId":"post___admin___abuse-report-resolver___delete","summary":"admin/abuse-report-resolver/delete","description":"No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:abuse-report-resolvers*","externalDocs":{"description":"Source code","url":"https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/abuse-report-resolver/delete.ts"},"tags":["admin"],"security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"resolverId":{"type":"string","format":"misskey:id"}},"required":["resolverId"]}}}},"responses":{"204":{"description":"OK (without any results)"},"400":{"description":"Client error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"RESOLVER_NOT_FOUND":{"value":{"error":{"message":"Resolver not found.","code":"RESOLVER_NOT_FOUND","id":"121fbea9-3e49-4456-998a-d4095c7ac5c5"}}},"INVALID_PARAM":{"value":{"error":{"message":"Invalid param.","code":"INVALID_PARAM","id":"3d81ceae-475f-4600-b2a8-2bc116157532"}}}}}}},"401":{"description":"Authentication error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"CREDENTIAL_REQUIRED":{"value":{"error":{"message":"Credential required.","code":"CREDENTIAL_REQUIRED","id":"1384574d-a912-4b81-8601-c7b1c4085df1"}}}}}}},"403":{"description":"Forbidden error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"AUTHENTICATION_FAILED":{"value":{"error":{"message":"Authentication failed. Please ensure your token is correct.","code":"AUTHENTICATION_FAILED","id":"b0a7f5f8-dc2f-4171-b91f-de88ad238e14"}}}}}}},"418":{"description":"I'm Ai","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"I_AM_AI":{"value":{"error":{"message":"You sent a request to Ai-chan, Misskey's showgirl, instead of the server.","code":"I_AM_AI","id":"60c46cd1-f23a-46b1-bebe-5d2b73951a84"}}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"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-report-resolver/list":{"post":{"operationId":"post___admin___abuse-report-resolver___list","summary":"admin/abuse-report-resolver/list","description":"No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:abuse-report-resolvers*","externalDocs":{"description":"Source code","url":"https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/abuse-report-resolver/list.ts"},"tags":["admin"],"security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"limit":{"type":"number","minimum":1,"maximum":100,"default":10},"sinceId":{"type":"string","format":"misskey:id"},"untilId":{"type":"string","format":"misskey:id"}}}}}},"responses":{"200":{"description":"OK (with results)","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"targetUserPattern":{"type":["string","null"]},"reporterPattern":{"type":["string","null"]},"reportContentPattern":{"type":["string","null"]},"expiresAt":{"type":"string"},"forward":{"type":"boolean"}},"required":["name","targetUserPattern","reporterPattern","reportContentPattern","expiresAt","forward"]}}}}},"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-report-resolver/update":{"post":{"operationId":"post___admin___abuse-report-resolver___update","summary":"admin/abuse-report-resolver/update","description":"No description provided.\n\n**Credential required**: *Yes* / **Permission**: *write:admin:abuse-report-resolvers*","externalDocs":{"description":"Source code","url":"https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/abuse-report-resolver/update.ts"},"tags":["admin"],"security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"resolverId":{"type":"string","format":"misskey:id"},"name":{"type":"string"},"targetUserPattern":{"type":["string","null"]},"reporterPattern":{"type":["string","null"]},"reportContentPattern":{"type":["string","null"]},"expiresAt":{"type":"string","enum":["1hour","12hours","1day","1week","1month","3months","6months","1year","indefinitely"]},"forward":{"type":"boolean"}},"required":["resolverId"]}}}},"responses":{"204":{"description":"OK (without any results)"},"400":{"description":"Client error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"RESOLVER_NOT_FOUND":{"value":{"error":{"message":"Resolver not found.","id":"fd32710e-75e1-4d20-bbd2-f89029acb16e","code":"RESOLVER_NOT_FOUND"}}},"INVALID_REGULAR_EXPRESSION_FOR_TARGET_USER":{"value":{"error":{"message":"Invalid regular expression for target user.","code":"INVALID_REGULAR_EXPRESSION_FOR_TARGET_USER","id":"c008484a-0a14-4e74-86f4-b176dc49fcaa"}}},"INVALID_REGULAR_EXPRESSION_FOR_REPORTER":{"value":{"error":{"message":"Invalid regular expression for reporter.","code":"INVALID_REGULAR_EXPRESSION_FOR_REPORTER","id":"399b4062-257f-44c8-87cc-4ffae2527fbc"}}},"INVALID_REGULAR_EXPRESSION_FOR_REPORT_CONTENT":{"value":{"error":{"message":"Invalid regular expression for report content.","code":"INVALID_REGULAR_EXPRESSION_FOR_REPORT_CONTENT","id":"88c124d8-f517-4c63-a464-0abc274168b"}}},"INVALID_PARAM":{"value":{"error":{"message":"Invalid param.","code":"INVALID_PARAM","id":"3d81ceae-475f-4600-b2a8-2bc116157532"}}}}}}},"401":{"description":"Authentication error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"CREDENTIAL_REQUIRED":{"value":{"error":{"message":"Credential required.","code":"CREDENTIAL_REQUIRED","id":"1384574d-a912-4b81-8601-c7b1c4085df1"}}}}}}},"403":{"description":"Forbidden error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"AUTHENTICATION_FAILED":{"value":{"error":{"message":"Authentication failed. Please ensure your token is correct.","code":"AUTHENTICATION_FAILED","id":"b0a7f5f8-dc2f-4171-b91f-de88ad238e14"}}}}}}},"418":{"description":"I'm Ai","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"I_AM_AI":{"value":{"error":{"message":"You sent a request to Ai-chan, Misskey's showgirl, instead of the server.","code":"I_AM_AI","id":"60c46cd1-f23a-46b1-bebe-5d2b73951a84"}}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"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-report/notification-recipient/create":{"post":{"operationId":"post___admin___abuse-report___notification-recipient___create","summary":"admin/abuse-report/notification-recipient/create","description":"No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes* / **Permission**: *write:admin:abuse-report:notification-recipient*","externalDocs":{"description":"Source code","url":"https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/abuse-report/notification-recipient/create.ts"},"tags":["admin"],"security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"isActive":{"type":"boolean"},"name":{"type":"string","minLength":1,"maxLength":255},"method":{"type":"string","enum":["email","webhook"]},"userId":{"type":"string","format":"misskey:id"},"systemWebhookId":{"type":"string","format":"misskey:id"}},"required":["isActive","name","method"]}}}},"responses":{"200":{"description":"OK (with results)","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/AbuseReportNotificationRecipient"}}}},"400":{"description":"Client error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"CORRELATION_CHECK_EMAIL":{"value":{"error":{"message":"If \"method\" is email, \"userId\" must be set.","code":"CORRELATION_CHECK_EMAIL","id":"348bb8ae-575a-6fe9-4327-5811999def8f","httpStatusCode":400}}},"CORRELATION_CHECK_WEBHOOK":{"value":{"error":{"message":"If \"method\" is webhook, \"systemWebhookId\" must be set.","code":"CORRELATION_CHECK_WEBHOOK","id":"b0c15051-de2d-29ef-260c-9585cddd701a","httpStatusCode":400}}},"EMAIL_ADDRESS_NOT_SET":{"value":{"error":{"message":"Email address is not set.","code":"EMAIL_ADDRESS_NOT_SET","id":"7cc1d85e-2f58-fc31-b644-3de8d0d3421f","httpStatusCode":400}}},"INVALID_PARAM":{"value":{"error":{"message":"Invalid param.","code":"INVALID_PARAM","id":"3d81ceae-475f-4600-b2a8-2bc116157532"}}}}}}},"401":{"description":"Authentication error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"CREDENTIAL_REQUIRED":{"value":{"error":{"message":"Credential required.","code":"CREDENTIAL_REQUIRED","id":"1384574d-a912-4b81-8601-c7b1c4085df1"}}}}}}},"403":{"description":"Forbidden error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"AUTHENTICATION_FAILED":{"value":{"error":{"message":"Authentication failed. Please ensure your token is correct.","code":"AUTHENTICATION_FAILED","id":"b0a7f5f8-dc2f-4171-b91f-de88ad238e14"}}}}}}},"418":{"description":"I'm Ai","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"I_AM_AI":{"value":{"error":{"message":"You sent a request to Ai-chan, Misskey's showgirl, instead of the server.","code":"I_AM_AI","id":"60c46cd1-f23a-46b1-bebe-5d2b73951a84"}}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"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-report/notification-recipient/delete":{"post":{"operationId":"post___admin___abuse-report___notification-recipient___delete","summary":"admin/abuse-report/notification-recipient/delete","description":"No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes* / **Permission**: *write:admin:abuse-report:notification-recipient*","externalDocs":{"description":"Source code","url":"https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/abuse-report/notification-recipient/delete.ts"},"tags":["admin"],"security":[{"bearerAuth":[]}],"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":{"INVALID_PARAM":{"value":{"error":{"message":"Invalid param.","code":"INVALID_PARAM","id":"3d81ceae-475f-4600-b2a8-2bc116157532"}}}}}}},"401":{"description":"Authentication error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"CREDENTIAL_REQUIRED":{"value":{"error":{"message":"Credential required.","code":"CREDENTIAL_REQUIRED","id":"1384574d-a912-4b81-8601-c7b1c4085df1"}}}}}}},"403":{"description":"Forbidden error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"AUTHENTICATION_FAILED":{"value":{"error":{"message":"Authentication failed. Please ensure your token is correct.","code":"AUTHENTICATION_FAILED","id":"b0a7f5f8-dc2f-4171-b91f-de88ad238e14"}}}}}}},"418":{"description":"I'm Ai","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"I_AM_AI":{"value":{"error":{"message":"You sent a request to Ai-chan, Misskey's showgirl, instead of the server.","code":"I_AM_AI","id":"60c46cd1-f23a-46b1-bebe-5d2b73951a84"}}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"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-report/notification-recipient/list":{"post":{"operationId":"post___admin___abuse-report___notification-recipient___list","summary":"admin/abuse-report/notification-recipient/list","description":"No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes* / **Permission**: *read:admin:abuse-report:notification-recipient*","externalDocs":{"description":"Source code","url":"https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/abuse-report/notification-recipient/list.ts"},"tags":["admin"],"security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"method":{"type":"array","items":{"type":"string","enum":["email","webhook"]}}}}}}},"responses":{"200":{"description":"OK (with results)","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/AbuseReportNotificationRecipient"}}}}},"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-report/notification-recipient/show":{"post":{"operationId":"post___admin___abuse-report___notification-recipient___show","summary":"admin/abuse-report/notification-recipient/show","description":"No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes* / **Permission**: *read:admin:abuse-report:notification-recipient*","externalDocs":{"description":"Source code","url":"https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/abuse-report/notification-recipient/show.ts"},"tags":["admin"],"security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"misskey:id"}},"required":["id"]}}}},"responses":{"200":{"description":"OK (with results)","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/AbuseReportNotificationRecipient"}}}},"400":{"description":"Client error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"NO_SUCH_RECIPIENT":{"value":{"error":{"message":"No such recipient.","code":"NO_SUCH_RECIPIENT","id":"013de6a8-f757-04cb-4d73-cc2a7e3368e4","kind":"server","httpStatusCode":404}}},"INVALID_PARAM":{"value":{"error":{"message":"Invalid param.","code":"INVALID_PARAM","id":"3d81ceae-475f-4600-b2a8-2bc116157532"}}}}}}},"401":{"description":"Authentication error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"CREDENTIAL_REQUIRED":{"value":{"error":{"message":"Credential required.","code":"CREDENTIAL_REQUIRED","id":"1384574d-a912-4b81-8601-c7b1c4085df1"}}}}}}},"403":{"description":"Forbidden error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"AUTHENTICATION_FAILED":{"value":{"error":{"message":"Authentication failed. Please ensure your token is correct.","code":"AUTHENTICATION_FAILED","id":"b0a7f5f8-dc2f-4171-b91f-de88ad238e14"}}}}}}},"418":{"description":"I'm Ai","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"I_AM_AI":{"value":{"error":{"message":"You sent a request to Ai-chan, Misskey's showgirl, instead of the server.","code":"I_AM_AI","id":"60c46cd1-f23a-46b1-bebe-5d2b73951a84"}}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"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-report/notification-recipient/update":{"post":{"operationId":"post___admin___abuse-report___notification-recipient___update","summary":"admin/abuse-report/notification-recipient/update","description":"No description provided.\n\n**Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.\n**Credential required**: *Yes* / **Permission**: *write:admin:abuse-report:notification-recipient*","externalDocs":{"description":"Source code","url":"https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/abuse-report/notification-recipient/update.ts"},"tags":["admin"],"security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"misskey:id"},"isActive":{"type":"boolean"},"name":{"type":"string","minLength":1,"maxLength":255},"method":{"type":"string","enum":["email","webhook"]},"userId":{"type":"string","format":"misskey:id"},"systemWebhookId":{"type":"string","format":"misskey:id"}},"required":["id","isActive","name","method"]}}}},"responses":{"200":{"description":"OK (with results)","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/AbuseReportNotificationRecipient"}}}},"400":{"description":"Client error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"CORRELATION_CHECK_EMAIL":{"value":{"error":{"message":"If \"method\" is email, \"userId\" must be set.","code":"CORRELATION_CHECK_EMAIL","id":"348bb8ae-575a-6fe9-4327-5811999def8f","httpStatusCode":400}}},"CORRELATION_CHECK_WEBHOOK":{"value":{"error":{"message":"If \"method\" is webhook, \"systemWebhookId\" must be set.","code":"CORRELATION_CHECK_WEBHOOK","id":"b0c15051-de2d-29ef-260c-9585cddd701a","httpStatusCode":400}}},"EMAIL_ADDRESS_NOT_SET":{"value":{"error":{"message":"Email address is not set.","code":"EMAIL_ADDRESS_NOT_SET","id":"7cc1d85e-2f58-fc31-b644-3de8d0d3421f","httpStatusCode":400}}},"INVALID_PARAM":{"value":{"error":{"message":"Invalid param.","code":"INVALID_PARAM","id":"3d81ceae-475f-4600-b2a8-2bc116157532"}}}}}}},"401":{"description":"Authentication error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"CREDENTIAL_REQUIRED":{"value":{"error":{"message":"Credential required.","code":"CREDENTIAL_REQUIRED","id":"1384574d-a912-4b81-8601-c7b1c4085df1"}}}}}}},"403":{"description":"Forbidden error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"AUTHENTICATION_FAILED":{"value":{"error":{"message":"Authentication failed. Please ensure your token is correct.","code":"AUTHENTICATION_FAILED","id":"b0a7f5f8-dc2f-4171-b91f-de88ad238e14"}}}}}}},"418":{"description":"I'm Ai","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"I_AM_AI":{"value":{"error":{"message":"You sent a request to Ai-chan, Misskey's showgirl, instead of the server.","code":"I_AM_AI","id":"60c46cd1-f23a-46b1-bebe-5d2b73951a84"}}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"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":"post___admin___abuse-user-reports","summary":"admin/abuse-user-reports","description":"No description provided.\n\n**Credential required**: *Yes* / **Permission**: *read:admin:abuse-user-reports*","externalDocs":{"description":"Source code","url":"https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/abuse-user-reports.ts"},"tags":["admin"],"security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"limit":{"type":"integer","minimum":1,"maximum":100,"default":10},"sinceId":{"type":"string","format":"misskey:id"},"untilId":{"type":"string","format":"misskey:id"},"state":{"type":["string","null"],"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},"category":{"type":["string","null"],"default":null}}}}}},"responses":{"200":{"description":"OK (with results)","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"id","example":"xxxxxxxxxx"},"createdAt":{"type":"string","format":"date-time"},"comment":{"type":"string"},"resolved":{"type":"boolean","example":false},"forwarded":{"type":"boolean","example":false},"resolvedAs":{"type":["string","null"],"enum":["accept","reject",null]},"reporterId":{"type":"string","format":"id"},"targetUserId":{"type":"string","format":"id"},"assigneeId":{"type":["string","null"],"format":"id"},"reporter":{"type":"object","$ref":"#/components/schemas/UserDetailed"},"targetUser":{"type":"object","$ref":"#/components/schemas/UserDetailed"},"assignee":{"type":["object","null"],"anyOf":[{"$ref":"#/components/schemas/UserDetailed"},{"type":"null"}]},"category":{"type":"string"},"moderationNote":{"type":["string","null"]}},"required":["id","createdAt","comment","resolved","forwarded","resolvedAs","reporterId","targetUserId","assigneeId","reporter","targetUser","category","moderationNote"]}}}}},"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":"post___admin___accounts___create","summary":"admin/accounts/create","description":"No description provided.\n\n**Credential required**: *No*","externalDocs":{"description":"Source code","url":"https://github.com/MisskeyIO/misskey/blob/io/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},"setupPassword":{"type":["string","null"]}},"required":["username","password"]}}}},"responses":{"200":{"description":"OK (with results)","content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string"}},"required":["token"],"$ref":"#/components/schemas/MeDetailed"}}}},"400":{"description":"Client error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"ACCESS_DENIED":{"value":{"error":{"message":"Access denied.","code":"ACCESS_DENIED","id":"1fb7cb09-d46a-4fff-b8df-057708cce513"}}},"INCORRECT_INITIAL_PASSWORD":{"value":{"error":{"message":"Initial password is incorrect.","code":"INCORRECT_INITIAL_PASSWORD","id":"97147c55-1ae1-4f6f-91d6-e1c3e0e76d62"}}},"INVALID_PARAM":{"value":{"error":{"message":"Invalid param.","code":"INVALID_PARAM","id":"3d81ceae-475f-4600-b2a8-2bc116157532"}}}}}}},"401":{"description":"Authentication error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"CREDENTIAL_REQUIRED":{"value":{"error":{"message":"Credential required.","code":"CREDENTIAL_REQUIRED","id":"1384574d-a912-4b81-8601-c7b1c4085df1"}}}}}}},"403":{"description":"Forbidden error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"AUTHENTICATION_FAILED":{"value":{"error":{"message":"Authentication failed. Please ensure your token is correct.","code":"AUTHENTICATION_FAILED","id":"b0a7f5f8-dc2f-41

# --- truncated at 32 KB (1222 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/misskey/refs/heads/main/openapi/misskey-openapi.json