openapi: 3.1.0 info: version: 2025.4.1-io.12b-fb6fbea074 title: Misskey account I API servers: - url: https://misskey.io/api tags: - name: I paths: /i/2fa/done: post: operationId: post___i___2fa___done summary: i/2fa/done description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/2fa/done.ts security: - bearerAuth: [] 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 properties: backupCodes: type: array items: type: string required: - backupCodes '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 tags: - I /i/2fa/key-done: post: operationId: post___i___2fa___key-done summary: i/2fa/key-done description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/2fa/key-done.ts security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: password: type: string token: type: - string - 'null' name: type: string minLength: 1 maxLength: 30 credential: type: object required: - password - name - credential responses: '200': description: OK (with results) content: application/json: schema: type: object properties: id: type: string name: type: string required: - id - name '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INCORRECT_PASSWORD: value: error: message: Incorrect password. code: INCORRECT_PASSWORD id: 0d7ec6d2-e652-443e-a7bf-9ee9a0cd77b0 AUTHENTICATION_FAILED: value: error: message: Authentication failed. code: AUTHENTICATION_FAILED id: 7b7b1e88-c569-4873-9676-25c5717ace4e TWO_FACTOR_NOT_ENABLED: value: error: message: 2fa not enabled. code: TWO_FACTOR_NOT_ENABLED id: 798d6847-b1ed-4f9c-b1f9-163c42655995 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac tags: - I /i/2fa/password-less: post: operationId: post___i___2fa___password-less summary: i/2fa/password-less description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/2fa/password-less.ts security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: value: type: boolean required: - value responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SECURITY_KEY: value: error: message: No security key. code: NO_SECURITY_KEY id: f9c54d7f-d4c2-4d3c-9a8g-a70daac86512 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac tags: - I /i/2fa/register: post: operationId: post___i___2fa___register summary: i/2fa/register description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/2fa/register.ts security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: password: type: string token: type: - string - 'null' required: - password responses: '200': description: OK (with results) content: application/json: schema: type: object properties: qr: type: string url: type: string secret: type: string label: type: string issuer: type: string required: - qr - url - secret - label - issuer '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INCORRECT_PASSWORD: value: error: message: Incorrect password. code: INCORRECT_PASSWORD id: 78d6c839-20c9-4c66-b90a-fc0542168b48 AUTHENTICATION_FAILED: value: error: message: Authentication failed. code: AUTHENTICATION_FAILED id: e428f177-c6ae-4e91-9c7e-334b1836f9aa INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac tags: - I /i/2fa/register-key: post: operationId: post___i___2fa___register-key summary: i/2fa/register-key description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/2fa/register-key.ts security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: password: type: string token: type: - string - 'null' required: - password responses: '200': description: OK (with results) content: application/json: schema: type: object properties: rp: type: object properties: id: type: string user: type: object properties: id: type: string name: type: string displayName: type: string required: - id - name - displayName challenge: type: string pubKeyCredParams: type: array items: type: object properties: type: type: string alg: type: number required: - type - alg timeout: type: - number - 'null' excludeCredentials: type: - array - 'null' items: type: object properties: id: type: string type: type: string transports: type: array items: type: string enum: - ble - cable - hybrid - internal - nfc - smart-card - usb required: - id - type - transports authenticatorSelection: type: - object - 'null' properties: authenticatorAttachment: type: string enum: - cross-platform - platform requireResidentKey: type: boolean userVerification: type: string enum: - discouraged - preferred - required required: - authenticatorAttachment - requireResidentKey - userVerification attestation: type: - string - 'null' enum: - direct - enterprise - indirect - none - null extensions: type: - object - 'null' properties: appid: type: - string - 'null' credProps: type: - boolean - 'null' hmacCreateSecret: type: - boolean - 'null' required: - appid - credProps - hmacCreateSecret required: - rp - user - challenge - pubKeyCredParams - timeout - excludeCredentials - authenticatorSelection - attestation - extensions '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: USER_NOT_FOUND: value: error: message: User not found. code: USER_NOT_FOUND id: 652f899f-66d4-490e-993e-6606c8ec04c3 INCORRECT_PASSWORD: value: error: message: Incorrect password. code: INCORRECT_PASSWORD id: 38769596-efe2-4faf-9bec-abbb3f2cd9ba AUTHENTICATION_FAILED: value: error: message: Authentication failed. code: AUTHENTICATION_FAILED id: a7628591-668b-47b2-919f-d986b22af06a TWO_FACTOR_NOT_ENABLED: value: error: message: 2fa not enabled. code: TWO_FACTOR_NOT_ENABLED id: bf32b864-449b-47b8-974e-f9a5468546f1 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac tags: - I /i/2fa/remove-key: post: operationId: post___i___2fa___remove-key summary: i/2fa/remove-key description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/2fa/remove-key.ts security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: password: type: string token: type: - string - 'null' credentialId: type: string required: - password - credentialId responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INCORRECT_PASSWORD: value: error: message: Incorrect password. code: INCORRECT_PASSWORD id: 141c598d-a825-44c8-9173-cfb9d92be493 AUTHENTICATION_FAILED: value: error: message: Authentication failed. code: AUTHENTICATION_FAILED id: 724bcf94-1f52-4c57-ad40-4f7fbbf6ce87 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac tags: - I /i/2fa/unregister: post: operationId: post___i___2fa___unregister summary: i/2fa/unregister description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/2fa/unregister.ts security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: password: type: string token: type: - string - 'null' required: - password responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INCORRECT_PASSWORD: value: error: message: Incorrect password. code: INCORRECT_PASSWORD id: 7add0395-9901-4098-82f9-4f67af65f775 AUTHENTICATION_FAILED: value: error: message: Authentication failed. code: AUTHENTICATION_FAILED id: 1b99d9c1-629c-41f9-9315-b27ee876f498 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac tags: - I /i/2fa/update-key: post: operationId: post___i___2fa___update-key summary: i/2fa/update-key description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/2fa/update-key.ts security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 30 credentialId: type: string required: - name - credentialId responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_KEY: value: error: message: No such key. code: NO_SUCH_KEY id: f9c5467f-d492-4d3c-9a8g-a70dacc86512 ACCESS_DENIED: value: error: message: You do not have edit privilege of this key. code: ACCESS_DENIED id: 1fb7cb09-d46a-4fff-b8df-057708cce513 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac tags: - I /i/apps: post: operationId: post___i___apps summary: i/apps description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/apps.ts security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: sort: type: string enum: - +createdAt - -createdAt - +lastUsedAt - -lastUsedAt responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object properties: id: type: string format: misskey:id name: type: string createdAt: type: string format: date-time lastUsedAt: type: string format: date-time permission: type: array uniqueItems: true items: type: string required: - id - createdAt - permission '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 tags: - I /i/authorized-apps: post: operationId: post___i___authorized-apps summary: i/authorized-apps description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/authorized-apps.ts security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 10 offset: type: integer default: 0 sort: type: string enum: - desc - asc default: desc responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object properties: id: type: string format: misskey:id name: type: string callbackUrl: type: - string - 'null' permission: type: array uniqueItems: true items: type: string isAuthorized: type: boolean required: - id - name - callbackUrl - permission '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 tags: - I /i/change-password: post: operationId: post___i___change-password summary: i/change-password description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/change-password.ts security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: currentPassword: type: string newPassword: type: string minLength: 1 token: type: - string - 'null' required: - currentPassword - newPassword responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INCORRECT_PASSWORD: value: error: message: Incorrect password. code: INCORRECT_PASSWORD id: f5bcd508-adcf-40b1-9031-2e944a5d8390 AUTHENTICATION_FAILED: value: error: message: Authentication failed. code: AUTHENTICATION_FAILED id: 97fee157-34eb-4b0d-8fc3-375d0040f807 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac tags: - I /i/claim-achievement: post: operationId: post___i___claim-achievement summary: i/claim-achievement description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:account*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/claim-achievement.ts security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: name: type: string enum: - notes1 - notes10 - notes100 - notes500 - notes1000 - notes5000 - notes10000 - notes20000 - notes30000 - notes40000 - notes50000 - notes60000 - notes70000 - notes80000 - notes90000 - notes100000 - login3 - login7 - login15 - login30 - login60 - login100 - login200 - login300 - login400 - login500 - login600 - login700 - login800 - login900 - login1000 - passedSinceAccountCreated1 - passedSinceAccountCreated2 - passedSinceAccountCreated3 - loggedInOnBirthday - loggedInOnNewYearsDay - noteClipped1 - noteFavorited1 - myNoteFavorited1 - profileFilled - markedAsCat - following1 - following10 - following50 - following100 - following300 - followers1 - followers10 - followers50 - followers100 - followers300 - followers500 - followers1000 - collectAchievements30 - viewAchievements3min - iLoveMisskey - foundTreasure - client30min - client60min - noteDeletedWithin1min - postedAtLateNight - postedAt0min0sec - selfQuote - htl20npm - viewInstanceChart - outputHelloWorldOnScratchpad - open3windows - driveFolderCircularReference - reactWithoutRead - clickedClickHere - justPlainLucky - setNameToSyuilo - cookieClicked - brainDiver - smashTestNotificationButton - tutorialCompleted - sensitiveContentConsentResponded - postingLanguageConfigured - viewingLanguagesConfigured - dimensionConfigured - bubbleGameExplodingHead - bubbleGameDoubleExplodingHead required: - name 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 tags: - I /i/delete-account: post: operationId: post___i___delete-account summary: i/delete-account description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/delete-account.ts security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: password: type: string token: type: - string - 'null' required: - password responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INCORRECT_PASSWORD: value: error: message: Incorrect password. code: INCORRECT_PASSWORD id: 44326b04-08ea-4525-b01c-98cc117bdd2a AUTHENTICATION_FAILED: value: error: message: Authentication failed. code: AUTHENTICATION_FAILED id: ea791cff-63e7-4b2a-92fc-646ab641794e INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac tags: - I /i/export-antennas: post: operationId: post___i___export-antennas summary: i/export-antennas description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/export-antennas.ts security: - bearerAuth: [] 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: Too many requests content: application/json: schema: $ref: '#/components/schemas/Error' examples: RATE_LIMIT_EXCEEDED: value: error: message: Rate limit exceeded. Please try again later. code: RATE_LIMIT_EXCEEDED id: d5826d14-3982-4d2e-8011-b9e9f02499ef '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac tags: - I /i/export-blocking: post: operationId: post___i___export-blocking summary: i/export-blocking description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/export-blocking.ts security: - bearerAuth: [] 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: Too many requests content: application/json: schema: $ref: '#/components/schemas/Error' examples: RATE_LIMIT_EXCEEDED: value: error: message: Rate limit exceeded. Please try again later. code: RATE_LIMIT_EXCEEDED id: d5826d14-3982-4d2e-8011-b9e9f02499ef '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac tags: - I /i/export-clips: post: operationId: post___i___export-clips summary: i/export-clips description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/export-clips.ts security: - bearerAuth: [] 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: Too many requests content: application/json: schema: $ref: '#/components/schemas/Error' examples: RATE_LIMIT_EXCEEDED: value: error: message: Rate limit exceeded. Please try again later. code: RATE_LIMIT_EXCEEDED id: d5826d14-3982-4d2e-8011-b9e9f02499ef '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac tags: - I /i/export-favorites: post: operationId: post___i___export-favorites summary: i/export-favorites description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/export-favorites.ts security: - bearerAuth: [] 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: Too many requests content: application/json: schema: $ref: '#/components/schemas/Error' examples: RATE_LIMIT_EXCEEDED: value: error: message: Rate limit exceeded. Please try again later. code: RATE_LIMIT_EXCEEDED id: d5826d14-3982-4d2e-8011-b9e9f02499ef '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac tags: - I /i/export-following: post: operationId: post___i___export-following summary: i/export-following description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/export-following.ts security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: excludeMuting: type: boolean default: false excludeInactive: type: boolean default: false 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: Too many requests content: application/json: schema: $ref: '#/components/schemas/Error' examples: RATE_LIMIT_EXCEEDED: value: error: message: Rate limit exceeded. Please try again later. code: RATE_LIMIT_EXCEEDED id: d5826d14-3982-4d2e-8011-b9e9f02499ef '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac tags: - I /i/export-mute: post: operationId: post___i___export-mute summary: i/export-mute description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/export-mute.ts security: - bearerAuth: [] 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: Too many requests content: application/json: schema: $ref: '#/components/schemas/Error' examples: RATE_LIMIT_EXCEEDED: value: error: message: Rate limit exceeded. Please try again later. code: RATE_LIMIT_EXCEEDED id: d5826d14-3982-4d2e-8011-b9e9f02499ef '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac tags: - I /i/export-notes: post: operationId: post___i___export-notes summary: i/export-notes description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/export-notes.ts security: - bearerAuth: [] 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: Too many requests content: application/json: schema: $ref: '#/components/schemas/Error' examples: RATE_LIMIT_EXCEEDED: value: error: message: Rate limit exceeded. Please try again later. code: RATE_LIMIT_EXCEEDED id: d5826d14-3982-4d2e-8011-b9e9f02499ef '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac tags: - I /i/export-user-lists: post: operationId: post___i___export-user-lists summary: i/export-user-lists description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/export-user-lists.ts security: - bearerAuth: [] 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: Too many requests content: application/json: schema: $ref: '#/components/schemas/Error' examples: RATE_LIMIT_EXCEEDED: value: error: message: Rate limit exceeded. Please try again later. code: RATE_LIMIT_EXCEEDED id: d5826d14-3982-4d2e-8011-b9e9f02499ef '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac tags: - I /i/import-antennas: post: operationId: post___i___import-antennas summary: i/import-antennas description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/import-antennas.ts security: - bearerAuth: [] 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: 3b71d086-c3fa-431c-b01d-ded65a777172 NO_SUCH_USER: value: error: message: No such user. code: NO_SUCH_USER id: e842c379-8ac7-4cf7-b07a-4d4de7e4671c EMPTY_FILE: value: error: message: That file is empty. code: EMPTY_FILE id: 7f60115d-8d93-4b0f-bd0e-3815dcbb389f TOO_MANY_ANTENNAS: value: error: message: You cannot create antenna any more. code: TOO_MANY_ANTENNAS id: 600917d4-a4cb-4cc5-8ba8-7ac8ea3c7779 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/Error' examples: RATE_LIMIT_EXCEEDED: value: error: message: Rate limit exceeded. Please try again later. code: RATE_LIMIT_EXCEEDED id: d5826d14-3982-4d2e-8011-b9e9f02499ef '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac tags: - I /i/import-blocking: post: operationId: post___i___import-blocking summary: i/import-blocking description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/import-blocking.ts security: - bearerAuth: [] 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: ebb53e5f-6574-9c0c-0b92-7ca6def56d7e UNEXPECTED_FILE_TYPE: value: error: message: We need csv file. code: UNEXPECTED_FILE_TYPE id: b6fab7d6-d945-d67c-dfdb-32da1cd12cfe TOO_BIG_FILE: value: error: message: That file is too big. code: TOO_BIG_FILE id: b7fbf0b1-aeef-3b21-29ef-fadd4cb72ccf EMPTY_FILE: value: error: message: That file is empty. code: EMPTY_FILE id: 6f3a4dcc-f060-a707-4950-806fbdbe60d6 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/Error' examples: RATE_LIMIT_EXCEEDED: value: error: message: Rate limit exceeded. Please try again later. code: RATE_LIMIT_EXCEEDED id: d5826d14-3982-4d2e-8011-b9e9f02499ef '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac tags: - I /i/import-following: post: operationId: post___i___import-following summary: i/import-following description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/import-following.ts security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: fileId: type: string format: misskey:id withReplies: type: boolean 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: b98644cf-a5ac-4277-a502-0b8054a709a3 UNEXPECTED_FILE_TYPE: value: error: message: We need csv file. code: UNEXPECTED_FILE_TYPE id: 660f3599-bce0-4f95-9dde-311fd841c183 TOO_BIG_FILE: value: error: message: That file is too big. code: TOO_BIG_FILE id: dee9d4ed-ad07-43ed-8b34-b2856398bc60 EMPTY_FILE: value: error: message: That file is empty. code: EMPTY_FILE id: 31a1b42c-06f7-42ae-8a38-a661c5c9f691 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/Error' examples: RATE_LIMIT_EXCEEDED: value: error: message: Rate limit exceeded. Please try again later. code: RATE_LIMIT_EXCEEDED id: d5826d14-3982-4d2e-8011-b9e9f02499ef '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac tags: - I /i/import-muting: post: operationId: post___i___import-muting summary: i/import-muting description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/import-muting.ts security: - bearerAuth: [] 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: e674141e-bd2a-ba85-e616-aefb187c9c2a UNEXPECTED_FILE_TYPE: value: error: message: We need csv file. code: UNEXPECTED_FILE_TYPE id: 568c6e42-c86c-ba09-c004-517f83f9f1a8 TOO_BIG_FILE: value: error: message: That file is too big. code: TOO_BIG_FILE id: 9b4ada6d-d7f7-0472-0713-4f558bd1ec9c EMPTY_FILE: value: error: message: That file is empty. code: EMPTY_FILE id: d2f12af1-e7b4-feac-86a3-519548f2728e INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/Error' examples: RATE_LIMIT_EXCEEDED: value: error: message: Rate limit exceeded. Please try again later. code: RATE_LIMIT_EXCEEDED id: d5826d14-3982-4d2e-8011-b9e9f02499ef '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac tags: - I /i/import-user-lists: post: operationId: post___i___import-user-lists summary: i/import-user-lists description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/import-user-lists.ts security: - bearerAuth: [] 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: ea9cc34f-c415-4bc6-a6fe-28ac40357049 UNEXPECTED_FILE_TYPE: value: error: message: We need csv file. code: UNEXPECTED_FILE_TYPE id: a3c9edda-dd9b-4596-be6a-150ef813745c TOO_BIG_FILE: value: error: message: That file is too big. code: TOO_BIG_FILE id: ae6e7a22-971b-4b52-b2be-fc0b9b121fe9 EMPTY_FILE: value: error: message: That file is empty. code: EMPTY_FILE id: 99efe367-ce6e-4d44-93f8-5fae7b040356 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/Error' examples: RATE_LIMIT_EXCEEDED: value: error: message: Rate limit exceeded. Please try again later. code: RATE_LIMIT_EXCEEDED id: d5826d14-3982-4d2e-8011-b9e9f02499ef '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac tags: - I /i/regenerate-token: post: operationId: post___i___regenerate-token summary: i/regenerate-token description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/regenerate-token.ts security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: password: type: string required: - 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 tags: - I /i/registry/get: post: operationId: post___i___registry___get summary: i/registry/get description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:account*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/registry/get.ts security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: key: type: string scope: type: array default: [] items: type: string pattern: ^[a-zA-Z0-9_]+$ domain: type: - string - 'null' required: - key - scope responses: '200': description: OK (with results) content: application/json: schema: type: object '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_KEY: value: error: message: No such key. code: NO_SUCH_KEY id: ac3ed68a-62f0-422b-a7bc-d5e09e8f6a6a INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac tags: - I /i/registry/get-all: post: operationId: post___i___registry___get-all summary: i/registry/get-all description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:account*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/registry/get-all.ts security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: scope: type: array default: [] items: type: string pattern: ^[a-zA-Z0-9_]+$ domain: type: - string - 'null' required: - scope responses: '200': description: OK (with results) content: application/json: schema: type: object '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 tags: - I /i/registry/get-detail: post: operationId: post___i___registry___get-detail summary: i/registry/get-detail description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:account*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/registry/get-detail.ts security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: key: type: string scope: type: array default: [] items: type: string pattern: ^[a-zA-Z0-9_]+$ domain: type: - string - 'null' required: - key - scope responses: '200': description: OK (with results) content: application/json: schema: type: object properties: updatedAt: type: string value: {} required: - updatedAt - value '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_KEY: value: error: message: No such key. code: NO_SUCH_KEY id: 97a1e8e7-c0f7-47d2-957a-92e61256e01a INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac tags: - I /i/registry/keys: post: operationId: post___i___registry___keys summary: i/registry/keys description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:account*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/registry/keys.ts security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: scope: type: array default: [] items: type: string pattern: ^[a-zA-Z0-9_]+$ domain: type: - string - 'null' required: - scope responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: string '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 tags: - I /i/registry/keys-with-type: post: operationId: post___i___registry___keys-with-type summary: i/registry/keys-with-type description: 'No description provided. **Credential required**: *Yes* / **Permission**: *read:account*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/registry/keys-with-type.ts security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: scope: type: array default: [] items: type: string pattern: ^[a-zA-Z0-9_]+$ domain: type: - string - 'null' required: - scope responses: '200': description: OK (with results) content: application/json: schema: type: object additionalProperties: type: string '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 tags: - I /i/registry/remove: post: operationId: post___i___registry___remove summary: i/registry/remove description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:account*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/registry/remove.ts security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: key: type: string scope: type: array default: [] items: type: string pattern: ^[a-zA-Z0-9_]+$ domain: type: - string - 'null' required: - key - scope responses: '204': description: OK (without any results) '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: NO_SUCH_KEY: value: error: message: No such key. code: NO_SUCH_KEY id: 1fac4e8a-a6cd-4e39-a4a5-3a7e11f1b019 INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac tags: - I /i/registry/scopes-with-domain: post: operationId: post___i___registry___scopes-with-domain summary: i/registry/scopes-with-domain description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/registry/scopes-with-domain.ts security: - bearerAuth: [] responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object properties: scopes: type: array items: type: array items: type: string domain: type: - string - 'null' required: - scopes - domain '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 tags: - I /i/registry/set: post: operationId: post___i___registry___set summary: i/registry/set description: 'No description provided. **Credential required**: *Yes* / **Permission**: *write:account*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/registry/set.ts security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: key: type: string minLength: 1 value: {} scope: type: array default: [] items: type: string pattern: ^[a-zA-Z0-9_]+$ domain: type: - string - 'null' required: - key - value - scope 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 tags: - I /i/revoke-token: post: operationId: post___i___revoke-token summary: i/revoke-token description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/revoke-token.ts security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: tokenId: type: string format: misskey:id token: type: - string - 'null' anyOf: - required: - tokenId - required: - token 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 tags: - I /i/signin-history: post: operationId: post___i___signin-history summary: i/signin-history description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/signin-history.ts security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: limit: type: integer minimum: 1 maximum: 100 default: 10 sinceId: type: string format: misskey:id untilId: type: string format: misskey:id responses: '200': description: OK (with results) content: application/json: schema: type: array items: type: object $ref: '#/components/schemas/Signin' '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 tags: - I /i/update-email: post: operationId: post___i___update-email summary: i/update-email description: 'No description provided. **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties. **Credential required**: *Yes*' externalDocs: description: Source code url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/i/update-email.ts security: - bearerAuth: [] requestBody: required: true content: application/json: schema: type: object properties: password: type: string email: type: - string - 'null' token: type: - string - 'null' required: - password responses: '200': description: OK (with results) content: application/json: schema: type: object $ref: '#/components/schemas/MeDetailed' '400': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INCORRECT_PASSWORD: value: error: message: Incorrect password. code: INCORRECT_PASSWORD id: e54c1d7e-e7d6-4103-86b6-0a95069b4ad3 AUTHENTICATION_FAILED: value: error: message: Authentication failed. code: AUTHENTICATION_FAILED id: ef9323ea-8451-4f7a-8f35-4b1ee014d9b7 UNAVAILABLE: value: error: message: Unavailable email address. code: UNAVAILABLE id: a2defefb-f220-8849-0af6-17f816099323 EMAIL_REQUIRED: value: error: message: Email address is required. code: EMAIL_REQUIRED id: 324c7a88-59f2-492f-903f-89134f93e47e INVALID_PARAM: value: error: message: Invalid param. code: INVALID_PARAM id: 3d81ceae-475f-4600-b2a8-2bc116157532 '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/Error' examples: CREDENTIAL_REQUIRED: value: error: message: Credential required. code: CREDENTIAL_REQUIRED id: 1384574d-a912-4b81-8601-c7b1c4085df1 '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/Error' examples: AUTHENTICATION_FAILED: value: error: message: Authentication failed. Please ensure your token is correct. code: AUTHENTICATION_FAILED id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14 '418': description: I'm Ai content: application/json: schema: $ref: '#/components/schemas/Error' examples: I_AM_AI: value: error: message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server. code: I_AM_AI id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84 '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/Error' examples: RATE_LIMIT_EXCEEDED: value: error: message: Rate limit exceeded. Please try again later. code: RATE_LIMIT_EXCEEDED id: d5826d14-3982-4d2e-8011-b9e9f02499ef '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' examples: INTERNAL_ERROR: value: error: message: Internal error occurred. Please contact us if the error persists. code: INTERNAL_ERROR id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac tags: - I components: schemas: UserDetailedNotMeOnly: type: object properties: url: type: - string - 'null' format: url uri: type: - string - 'null' format: uri movedTo: type: - string - 'null' format: uri alsoKnownAs: type: - array - 'null' items: type: string format: id createdAt: type: string format: date-time updatedAt: type: - string - 'null' format: date-time lastFetchedAt: type: - string - 'null' format: date-time bannerUrl: type: - string - 'null' format: url bannerBlurhash: type: - string - 'null' isLocked: type: boolean isSilenced: type: boolean isLimited: type: boolean isSuspended: type: boolean example: false description: type: - string - 'null' example: Hi masters, I am Ai! location: type: - string - 'null' birthday: type: - string - 'null' example: '2018-03-12' lang: type: - string - 'null' example: ja-JP fields: type: array maxItems: 16 items: type: object properties: name: type: string value: type: string required: - name - value verifiedLinks: type: array items: type: string format: url followersCount: type: number followingCount: type: number notesCount: type: number pinnedNoteIds: type: array items: type: string format: id pinnedNotes: type: array items: type: object $ref: '#/components/schemas/Note' pinnedPageId: type: - string - 'null' pinnedPage: type: - object - 'null' anyOf: - $ref: '#/components/schemas/Page' - type: 'null' publicReactions: type: boolean followingVisibility: type: string enum: - public - followers - private followersVisibility: type: string enum: - public - followers - private chatScope: type: string enum: - everyone - following - followers - mutual - none canChat: type: boolean roles: type: array items: type: object $ref: '#/components/schemas/RoleLite' followedMessage: type: - string - 'null' memo: type: - string - 'null' moderationNote: type: string twoFactorEnabled: type: boolean usePasswordLessLogin: type: boolean securityKeys: type: boolean mutualLinkSections: type: array items: type: object properties: name: type: - string - 'null' mutualLinks: type: array items: type: object properties: id: type: string format: misskey:id url: type: string format: url fileId: type: string format: misskey:id description: type: - string - 'null' imgSrc: type: string required: - id - url - fileId - description - imgSrc required: - name - mutualLinks isFollowing: type: boolean isFollowed: type: boolean hasPendingFollowRequestFromYou: type: boolean hasPendingFollowRequestToYou: type: boolean isBlocking: type: boolean isBlocked: type: boolean isMuted: type: boolean isRenoteMuted: type: boolean notify: type: string enum: - normal - none withReplies: type: boolean required: - url - uri - movedTo - alsoKnownAs - createdAt - updatedAt - lastFetchedAt - bannerUrl - bannerBlurhash - isLocked - isSilenced - isLimited - isSuspended - description - location - birthday - lang - fields - verifiedLinks - followersCount - followingCount - notesCount - pinnedNoteIds - pinnedNotes - pinnedPageId - pinnedPage - publicReactions - followingVisibility - followersVisibility - chatScope - canChat - roles - memo - mutualLinkSections Signin: type: object properties: id: type: string createdAt: type: string format: date-time ip: type: string headers: type: object success: type: boolean required: - id - createdAt - ip - headers - success MeDetailedOnly: type: object properties: avatarId: type: - string - 'null' format: id bannerId: type: - string - 'null' format: id followedMessage: type: - string - 'null' isModerator: type: - boolean - 'null' isAdmin: type: - boolean - 'null' injectFeaturedNote: type: boolean receiveAnnouncementEmail: type: boolean alwaysMarkNsfw: type: boolean autoSensitive: type: boolean carefulBot: type: boolean autoAcceptFollowed: type: boolean noCrawle: type: boolean preventAiLearning: type: boolean isExplorable: type: boolean isDeleted: type: boolean twoFactorBackupCodesStock: type: string enum: - full - partial - none hideOnlineStatus: type: boolean hasUnreadSpecifiedNotes: type: boolean hasUnreadMentions: type: boolean hasUnreadAnnouncement: type: boolean unreadAnnouncements: type: array items: type: object $ref: '#/components/schemas/Announcement' hasUnreadAntenna: type: boolean hasUnreadChannel: type: boolean hasUnreadChatMessages: type: boolean hasUnreadNotification: type: boolean hasPendingReceivedFollowRequest: type: boolean unreadNotificationsCount: type: number mutedWords: type: array items: type: array items: type: string mutedInstances: type: - array - 'null' items: type: string postingLang: type: - string - 'null' example: ja-JP viewingLangs: type: array items: type: string showMediaInAllLanguages: type: boolean showHashtagsInAllLanguages: type: boolean notificationRecieveConfig: type: object properties: note: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId follow: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId mention: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId reply: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId renote: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId quote: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId reaction: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId pollEnded: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId receiveFollowRequest: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId followRequestAccepted: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId roleAssigned: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId chatRoomInvitationReceived: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId achievementEarned: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId app: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId test: type: object oneOf: - type: object properties: type: type: string enum: - all - following - follower - mutualFollow - followingOrFollower - never required: - type - type: object properties: type: type: string enum: - list userListId: type: string format: misskey:id required: - type - userListId emailNotificationTypes: type: array items: type: string achievements: type: array items: type: object properties: name: type: string unlockedAt: type: number required: - name - unlockedAt loggedInDays: type: number policies: type: object $ref: '#/components/schemas/RolePolicies' twoFactorEnabled: type: boolean default: false usePasswordLessLogin: type: boolean default: false securityKeys: type: boolean default: false email: type: - string - 'null' emailVerified: type: - boolean - 'null' securityKeysList: type: array items: type: object properties: id: type: string format: id example: xxxxxxxxxx name: type: string lastUsed: type: string format: date-time required: - id - name - lastUsed required: - avatarId - bannerId - followedMessage - isModerator - isAdmin - injectFeaturedNote - receiveAnnouncementEmail - alwaysMarkNsfw - autoSensitive - carefulBot - autoAcceptFollowed - noCrawle - preventAiLearning - isExplorable - isDeleted - twoFactorBackupCodesStock - hideOnlineStatus - hasUnreadSpecifiedNotes - hasUnreadMentions - hasUnreadAnnouncement - unreadAnnouncements - hasUnreadAntenna - hasUnreadChannel - hasUnreadChatMessages - hasUnreadNotification - hasPendingReceivedFollowRequest - unreadNotificationsCount - mutedWords - mutedInstances - postingLang - viewingLangs - showMediaInAllLanguages - showHashtagsInAllLanguages - notificationRecieveConfig - emailNotificationTypes - achievements - loggedInDays - policies - twoFactorEnabled - usePasswordLessLogin - securityKeys RolePolicies: type: object properties: gtlAvailable: type: boolean ltlAvailable: type: boolean canPublicNote: type: boolean canScheduleNote: type: boolean scheduleNoteLimit: type: integer scheduleNoteMaxDays: type: integer canInitiateConversation: type: boolean canCreateContent: type: boolean canUpdateContent: type: boolean canDeleteContent: type: boolean canPurgeAccount: type: boolean canUpdateAvatar: type: boolean canUpdateBanner: type: boolean mentionLimit: type: integer canInvite: type: boolean inviteLimit: type: integer inviteLimitCycle: type: integer inviteExpirationTime: type: integer canManageCustomEmojis: type: boolean canManageAvatarDecorations: type: boolean canSearchNotes: type: boolean canUseTranslator: type: boolean canUseDriveFileInSoundSettings: type: boolean canUseReaction: type: boolean canHideAds: type: boolean driveCapacityMb: type: integer maxFileSizeMb: type: integer alwaysMarkNsfw: type: boolean skipNsfwDetection: type: boolean canUpdateBioMedia: type: boolean pinLimit: type: integer antennaLimit: type: integer antennaNotesLimit: type: integer wordMuteLimit: type: integer webhookLimit: type: integer clipLimit: type: integer noteEachClipsLimit: type: integer userListLimit: type: integer userEachUserListsLimit: type: integer rateLimitFactor: type: integer avatarDecorationLimit: type: integer canImportAntennas: type: boolean canImportBlocking: type: boolean canImportFollowing: type: boolean canImportMuting: type: boolean canImportUserLists: type: boolean mutualLinkSectionLimit: type: integer mutualLinkLimit: type: integer chatAvailability: type: string enum: - available - readonly - unavailable required: - gtlAvailable - ltlAvailable - canPublicNote - canScheduleNote - scheduleNoteLimit - scheduleNoteMaxDays - canInitiateConversation - canCreateContent - canUpdateContent - canDeleteContent - canPurgeAccount - canUpdateAvatar - canUpdateBanner - mentionLimit - canInvite - inviteLimit - inviteLimitCycle - inviteExpirationTime - canManageCustomEmojis - canManageAvatarDecorations - canSearchNotes - canUseTranslator - canUseDriveFileInSoundSettings - canUseReaction - canHideAds - driveCapacityMb - maxFileSizeMb - alwaysMarkNsfw - skipNsfwDetection - canUpdateBioMedia - pinLimit - antennaLimit - antennaNotesLimit - wordMuteLimit - webhookLimit - clipLimit - noteEachClipsLimit - userListLimit - userEachUserListsLimit - rateLimitFactor - avatarDecorationLimit - canImportAntennas - canImportBlocking - canImportFollowing - canImportMuting - canImportUserLists - mutualLinkSectionLimit - mutualLinkLimit - chatAvailability DriveFile: type: object properties: id: type: string format: id example: xxxxxxxxxx createdAt: type: string format: date-time name: type: string example: 192.jpg type: type: string example: image/jpeg md5: type: string format: md5 example: 15eca7fba0480996e2245f5185bf39f2 size: type: number example: 51469 isSensitive: type: boolean isSensitiveByModerator: type: - boolean - 'null' blurhash: type: - string - 'null' properties: type: object properties: width: type: number example: 1280 height: type: number example: 720 orientation: type: number example: 8 avgColor: type: string example: rgb(40,65,87) url: type: string format: url thumbnailUrl: type: - string - 'null' format: url comment: type: - string - 'null' folderId: type: - string - 'null' format: id example: xxxxxxxxxx folder: type: - object - 'null' anyOf: - $ref: '#/components/schemas/DriveFolder' - type: 'null' userId: type: - string - 'null' format: id example: xxxxxxxxxx user: type: - object - 'null' anyOf: - $ref: '#/components/schemas/UserLite' - type: 'null' required: - id - createdAt - name - type - md5 - size - isSensitive - blurhash - properties - url - thumbnailUrl - comment - folderId - userId Note: type: object properties: id: type: string format: id example: xxxxxxxxxx createdAt: type: string format: date-time deletedAt: type: - string - 'null' format: date-time text: type: - string - 'null' cw: type: - string - 'null' userId: type: string format: id user: type: object $ref: '#/components/schemas/UserLite' replyId: type: - string - 'null' format: id example: xxxxxxxxxx renoteId: type: - string - 'null' format: id example: xxxxxxxxxx reply: type: - object - 'null' anyOf: - $ref: '#/components/schemas/Note' - type: 'null' renote: type: - object - 'null' anyOf: - $ref: '#/components/schemas/Note' - type: 'null' isHidden: type: boolean visibility: type: string enum: - public - home - followers - specified mentions: type: array items: type: string format: id visibleUserIds: type: array items: type: string format: id fileIds: type: array items: type: string format: id files: type: array items: type: object $ref: '#/components/schemas/DriveFile' tags: type: array items: type: string poll: type: - object - 'null' properties: expiresAt: type: - string - 'null' format: date-time multiple: type: boolean choices: type: array items: type: object properties: isVoted: type: boolean text: type: string votes: type: number required: - isVoted - text - votes required: - multiple - choices emojis: type: object additionalProperties: anyOf: - type: string channelId: type: - string - 'null' format: id example: xxxxxxxxxx channel: type: - object - 'null' properties: id: type: string name: type: string color: type: string isSensitive: type: boolean allowRenoteToExternal: type: boolean userId: type: - string - 'null' required: - id - name - color - isSensitive - allowRenoteToExternal - userId localOnly: type: boolean dimension: type: - integer - 'null' reactionAcceptance: type: - string - 'null' enum: - likeOnly - likeOnlyForRemote - nonSensitiveOnly - nonSensitiveOnlyForLocalLikeOnlyForRemote - null reactionEmojis: type: object additionalProperties: anyOf: - type: string reactions: type: object additionalProperties: anyOf: - type: number reactionCount: type: number renoteCount: type: number repliesCount: type: number uri: type: string url: type: string reactionAndUserPairCache: type: array items: type: string clippedCount: type: number myReaction: type: - string - 'null' required: - id - createdAt - text - userId - user - visibility - reactionAcceptance - reactionEmojis - reactions - reactionCount - renoteCount - repliesCount MeDetailed: type: object allOf: - type: object $ref: '#/components/schemas/UserLite' - type: object $ref: '#/components/schemas/UserDetailedNotMeOnly' - type: object $ref: '#/components/schemas/MeDetailedOnly' PageBlock: type: object oneOf: - type: object properties: id: type: string type: type: string enum: - text text: type: string required: - id - type - text - type: object properties: id: type: string type: type: string enum: - section title: type: string children: type: array items: type: object required: - id - type - title - children - type: object properties: id: type: string type: type: string enum: - image fileId: type: - string - 'null' required: - id - type - fileId - type: object properties: id: type: string type: type: string enum: - note detailed: type: boolean note: type: - string - 'null' required: - id - type - detailed - note RoleLite: type: object properties: id: type: string format: id example: xxxxxxxxxx name: type: string example: New Role color: type: - string - 'null' example: '#000000' iconUrl: type: - string - 'null' description: type: string isModerator: type: boolean example: false isAdministrator: type: boolean example: false displayOrder: type: integer example: 0 required: - id - name - color - iconUrl - description - isModerator - isAdministrator - displayOrder Page: type: object properties: id: type: string format: id example: xxxxxxxxxx createdAt: type: string format: date-time updatedAt: type: string format: date-time userId: type: string format: id user: type: object $ref: '#/components/schemas/UserLite' content: type: array items: type: object $ref: '#/components/schemas/PageBlock' variables: type: array items: type: object title: type: string name: type: string summary: type: - string - 'null' hideTitleWhenPinned: type: boolean alignCenter: type: boolean font: type: string script: type: string eyeCatchingImageId: type: - string - 'null' eyeCatchingImage: type: - object - 'null' anyOf: - $ref: '#/components/schemas/DriveFile' - type: 'null' attachedFiles: type: array items: type: object $ref: '#/components/schemas/DriveFile' likedCount: type: number isLiked: type: boolean visibility: type: string enum: - public - private required: - id - createdAt - updatedAt - userId - user - content - variables - title - name - summary - hideTitleWhenPinned - alignCenter - font - script - eyeCatchingImageId - eyeCatchingImage - attachedFiles - likedCount - visibility Announcement: type: object properties: id: type: string format: id example: xxxxxxxxxx createdAt: type: string format: date-time updatedAt: type: - string - 'null' format: date-time text: type: string title: type: string imageUrl: type: - string - 'null' icon: type: string enum: - info - warning - error - success display: type: string enum: - dialog - normal - banner needConfirmationToRead: type: boolean needEnrollmentTutorialToRead: type: boolean forYou: type: boolean closeDuration: type: number displayOrder: type: number silence: type: boolean isRead: type: boolean required: - id - createdAt - updatedAt - text - title - imageUrl - icon - display - needConfirmationToRead - needEnrollmentTutorialToRead - forYou - closeDuration - displayOrder - silence DriveFolder: type: object properties: id: type: string format: id example: xxxxxxxxxx createdAt: type: string format: date-time name: type: string parentId: type: - string - 'null' format: id example: xxxxxxxxxx foldersCount: type: number filesCount: type: number parent: type: - object - 'null' anyOf: - $ref: '#/components/schemas/DriveFolder' - type: 'null' required: - id - createdAt - name - parentId UserLite: type: object properties: id: type: string format: id example: xxxxxxxxxx name: type: - string - 'null' example: 藍 username: type: string example: ai host: type: - string - 'null' example: misskey.example.com description: The local host is represented with `null`. avatarUrl: type: - string - 'null' format: url avatarBlurhash: type: - string - 'null' avatarDecorations: type: array items: type: object properties: id: type: string format: id angle: type: number flipH: type: boolean url: type: string format: url offsetX: type: number offsetY: type: number required: - id - url isBot: type: boolean isCat: type: boolean requireSigninToViewContents: type: boolean makeNotesFollowersOnlyBefore: type: - number - 'null' makeNotesHiddenBefore: type: - number - 'null' instance: type: object properties: name: type: - string - 'null' softwareName: type: - string - 'null' softwareVersion: type: - string - 'null' iconUrl: type: - string - 'null' faviconUrl: type: - string - 'null' themeColor: type: - string - 'null' required: - name - softwareName - softwareVersion - iconUrl - faviconUrl - themeColor emojis: type: object additionalProperties: type: string onlineStatus: type: string enum: - unknown - online - active - offline badgeRoles: type: array items: type: object properties: name: type: string iconUrl: type: - string - 'null' displayOrder: type: number behavior: type: string required: - name - iconUrl - displayOrder required: - id - name - username - host - avatarUrl - avatarBlurhash - avatarDecorations - emojis - onlineStatus Error: type: object properties: error: type: object description: An error object. properties: code: type: string description: An error code. Unique within the endpoint. message: type: string description: An error message. id: type: string format: uuid description: An error ID. This ID is static. required: - code - id - message required: - error securitySchemes: bearerAuth: type: http scheme: bearer externalDocs: description: Repository url: https://github.com/MisskeyIO/misskey