Misskey meta API

The meta API from Misskey — 18 operation(s) for meta.

OpenAPI Specification

misskey-meta-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  version: 2025.4.1-io.12b-fb6fbea074
  title: Misskey account meta API
servers:
- url: https://misskey.io/api
tags:
- name: meta
paths:
  /admin/meta:
    post:
      operationId: post___admin___meta
      summary: admin/meta
      description: 'No description provided.


        **Credential required**: *Yes* / **Permission**: *read:admin:meta*'
      externalDocs:
        description: Source code
        url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/admin/meta.ts
      tags:
      - meta
      security:
      - bearerAuth: []
      responses:
        '200':
          description: OK (with results)
          content:
            application/json:
              schema:
                type: object
                properties:
                  cacheRemoteFiles:
                    type: boolean
                  cacheRemoteSensitiveFiles:
                    type: boolean
                  emailRequiredForSignup:
                    type: boolean
                  enableHcaptcha:
                    type: boolean
                  hcaptchaSiteKey:
                    type:
                    - string
                    - 'null'
                  enableMcaptcha:
                    type: boolean
                  mcaptchaSiteKey:
                    type:
                    - string
                    - 'null'
                  mcaptchaInstanceUrl:
                    type:
                    - string
                    - 'null'
                  enableRecaptcha:
                    type: boolean
                  recaptchaSiteKey:
                    type:
                    - string
                    - 'null'
                  enableTurnstile:
                    type: boolean
                  turnstileSiteKey:
                    type:
                    - string
                    - 'null'
                  googleAnalyticsId:
                    type:
                    - string
                    - 'null'
                  swPublickey:
                    type:
                    - string
                    - 'null'
                  mascotImageUrl:
                    type:
                    - string
                    - 'null'
                    default: /assets/ai.png
                  bannerUrl:
                    type:
                    - string
                    - 'null'
                  serverErrorImageUrl:
                    type:
                    - string
                    - 'null'
                  infoImageUrl:
                    type:
                    - string
                    - 'null'
                  notFoundImageUrl:
                    type:
                    - string
                    - 'null'
                  iconUrl:
                    type:
                    - string
                    - 'null'
                  app192IconUrl:
                    type:
                    - string
                    - 'null'
                  app512IconUrl:
                    type:
                    - string
                    - 'null'
                  enableEmail:
                    type: boolean
                  enableServiceWorker:
                    type: boolean
                  translatorAvailable:
                    type: boolean
                  silencedHosts:
                    type: array
                    items:
                      type: string
                  sensitiveMediaHosts:
                    type: array
                    items:
                      type: string
                  pinnedUsers:
                    type: array
                    items:
                      type: string
                  hiddenTags:
                    type: array
                    items:
                      type: string
                  blockedHosts:
                    type: array
                    items:
                      type: string
                  blockedRemoteCustomEmojis:
                    type: array
                    items:
                      type: string
                  sensitiveWords:
                    type: array
                    items:
                      type: string
                  prohibitedWords:
                    type: array
                    items:
                      type: string
                  bannedEmailDomains:
                    type: array
                    items:
                      type: string
                  preservedUsernames:
                    type: array
                    items:
                      type: string
                  hcaptchaSecretKey:
                    type:
                    - string
                    - 'null'
                  mcaptchaSecretKey:
                    type:
                    - string
                    - 'null'
                  recaptchaSecretKey:
                    type:
                    - string
                    - 'null'
                  turnstileSecretKey:
                    type:
                    - string
                    - 'null'
                  sensitiveMediaDetection:
                    type: string
                  sensitiveMediaDetectionSensitivity:
                    type: string
                  setSensitiveFlagAutomatically:
                    type: boolean
                  enableSensitiveMediaDetectionForVideos:
                    type: boolean
                  proxyAccountId:
                    type: string
                    format: id
                  email:
                    type:
                    - string
                    - 'null'
                  smtpSecure:
                    type: boolean
                  smtpHost:
                    type:
                    - string
                    - 'null'
                  smtpPort:
                    type:
                    - number
                    - 'null'
                  smtpUser:
                    type:
                    - string
                    - 'null'
                  smtpPass:
                    type:
                    - string
                    - 'null'
                  swPrivateKey:
                    type:
                    - string
                    - 'null'
                  useObjectStorage:
                    type: boolean
                  objectStorageBaseUrl:
                    type:
                    - string
                    - 'null'
                  objectStorageBucket:
                    type:
                    - string
                    - 'null'
                  objectStoragePrefix:
                    type:
                    - string
                    - 'null'
                  objectStorageEndpoint:
                    type:
                    - string
                    - 'null'
                  objectStorageRegion:
                    type:
                    - string
                    - 'null'
                  objectStoragePort:
                    type:
                    - number
                    - 'null'
                  objectStorageAccessKey:
                    type:
                    - string
                    - 'null'
                  objectStorageSecretKey:
                    type:
                    - string
                    - 'null'
                  objectStorageUseSSL:
                    type: boolean
                  objectStorageUseProxy:
                    type: boolean
                  objectStorageSetPublicRead:
                    type: boolean
                  enableIpLogging:
                    type: boolean
                  enableActiveEmailValidation:
                    type: boolean
                  enableVerifymailApi:
                    type: boolean
                  verifymailAuthKey:
                    type:
                    - string
                    - 'null'
                  enableTruemailApi:
                    type: boolean
                  truemailInstance:
                    type:
                    - string
                    - 'null'
                  truemailAuthKey:
                    type:
                    - string
                    - 'null'
                  enableChartsForRemoteUser:
                    type: boolean
                  enableChartsForFederatedInstances:
                    type: boolean
                  enableServerMachineStats:
                    type: boolean
                  enableIdenticonGeneration:
                    type: boolean
                  manifestJsonOverride:
                    type: string
                  policies:
                    type: object
                  enableFanoutTimeline:
                    type: boolean
                  enableFanoutTimelineDbFallback:
                    type: boolean
                  perLocalUserUserTimelineCacheMax:
                    type: number
                  perRemoteUserUserTimelineCacheMax:
                    type: number
                  perUserHomeTimelineCacheMax:
                    type: number
                  perUserListTimelineCacheMax:
                    type: number
                  notesPerOneAd:
                    type: number
                  wellKnownWebsites:
                    type: array
                    items:
                      type: string
                  urlPreviewDenyList:
                    type: array
                    items:
                      type: string
                  featuredGameChannels:
                    type: array
                    items:
                      type: string
                  backgroundImageUrl:
                    type:
                    - string
                    - 'null'
                  deeplAuthKey:
                    type:
                    - string
                    - 'null'
                  deeplIsPro:
                    type: boolean
                  defaultDarkTheme:
                    type:
                    - string
                    - 'null'
                  defaultLightTheme:
                    type:
                    - string
                    - 'null'
                  description:
                    type:
                    - string
                    - 'null'
                  dimensions:
                    type: number
                    minimum: 1
                  disableRegistration:
                    type: boolean
                  impressumUrl:
                    type:
                    - string
                    - 'null'
                  maintainerEmail:
                    type:
                    - string
                    - 'null'
                  maintainerName:
                    type:
                    - string
                    - 'null'
                  name:
                    type:
                    - string
                    - 'null'
                  shortName:
                    type:
                    - string
                    - 'null'
                  objectStorageS3ForcePathStyle:
                    type: boolean
                  privacyPolicyUrl:
                    type:
                    - string
                    - 'null'
                  repositoryUrl:
                    type:
                    - string
                    - 'null'
                  summalyProxy:
                    type:
                    - string
                    - 'null'
                    deprecated: true
                    description: '[Deprecated] Use "urlPreviewSummaryProxyUrl" instead.'
                  themeColor:
                    type:
                    - string
                    - 'null'
                  tosUrl:
                    type:
                    - string
                    - 'null'
                  uri:
                    type: string
                  version:
                    type: string
                  urlPreviewEnabled:
                    type: boolean
                  urlPreviewTimeout:
                    type: number
                  urlPreviewMaximumContentLength:
                    type: number
                  urlPreviewRequireContentLength:
                    type: boolean
                  urlPreviewUserAgent:
                    type:
                    - string
                    - 'null'
                  urlPreviewSummaryProxyUrl:
                    type:
                    - string
                    - 'null'
                  federation:
                    type: string
                    enum:
                    - all
                    - specified
                    - none
                  federationHosts:
                    type: array
                    items:
                      type: string
                  prohibitedWordsForNameOfUser:
                    type: array
                    items:
                      type: string
                  inquiryUrl:
                    type:
                    - string
                    - 'null'
                required:
                - cacheRemoteFiles
                - cacheRemoteSensitiveFiles
                - emailRequiredForSignup
                - enableHcaptcha
                - hcaptchaSiteKey
                - enableMcaptcha
                - mcaptchaSiteKey
                - mcaptchaInstanceUrl
                - enableRecaptcha
                - recaptchaSiteKey
                - enableTurnstile
                - turnstileSiteKey
                - googleAnalyticsId
                - swPublickey
                - mascotImageUrl
                - bannerUrl
                - serverErrorImageUrl
                - infoImageUrl
                - notFoundImageUrl
                - iconUrl
                - app192IconUrl
                - app512IconUrl
                - enableEmail
                - enableServiceWorker
                - translatorAvailable
                - pinnedUsers
                - hiddenTags
                - blockedHosts
                - blockedRemoteCustomEmojis
                - sensitiveWords
                - prohibitedWords
                - preservedUsernames
                - hcaptchaSecretKey
                - mcaptchaSecretKey
                - recaptchaSecretKey
                - turnstileSecretKey
                - sensitiveMediaDetection
                - sensitiveMediaDetectionSensitivity
                - setSensitiveFlagAutomatically
                - enableSensitiveMediaDetectionForVideos
                - proxyAccountId
                - email
                - smtpSecure
                - smtpHost
                - smtpPort
                - smtpUser
                - smtpPass
                - swPrivateKey
                - useObjectStorage
                - objectStorageBaseUrl
                - objectStorageBucket
                - objectStoragePrefix
                - objectStorageEndpoint
                - objectStorageRegion
                - objectStoragePort
                - objectStorageAccessKey
                - objectStorageSecretKey
                - objectStorageUseSSL
                - objectStorageUseProxy
                - objectStorageSetPublicRead
                - enableIpLogging
                - enableActiveEmailValidation
                - enableVerifymailApi
                - verifymailAuthKey
                - enableTruemailApi
                - truemailInstance
                - truemailAuthKey
                - enableChartsForRemoteUser
                - enableChartsForFederatedInstances
                - enableServerMachineStats
                - enableIdenticonGeneration
                - manifestJsonOverride
                - policies
                - enableFanoutTimeline
                - enableFanoutTimelineDbFallback
                - perLocalUserUserTimelineCacheMax
                - perRemoteUserUserTimelineCacheMax
                - perUserHomeTimelineCacheMax
                - perUserListTimelineCacheMax
                - notesPerOneAd
                - wellKnownWebsites
                - urlPreviewDenyList
                - featuredGameChannels
                - backgroundImageUrl
                - deeplAuthKey
                - deeplIsPro
                - defaultDarkTheme
                - defaultLightTheme
                - description
                - dimensions
                - disableRegistration
                - impressumUrl
                - maintainerEmail
                - maintainerName
                - name
                - shortName
                - objectStorageS3ForcePathStyle
                - privacyPolicyUrl
                - repositoryUrl
                - summalyProxy
                - themeColor
                - tosUrl
                - uri
                - version
                - urlPreviewEnabled
                - urlPreviewTimeout
                - urlPreviewMaximumContentLength
                - urlPreviewRequireContentLength
                - urlPreviewUserAgent
                - urlPreviewSummaryProxyUrl
                - federation
                - federationHosts
                - prohibitedWordsForNameOfUser
                - inquiryUrl
        '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
  /announcement:
    post:
      operationId: post___announcement
      summary: announcement
      description: 'No description provided.


        **Credential required**: *No*'
      externalDocs:
        description: Source code
        url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/announcement.ts
      tags:
      - meta
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                announcementId:
                  type: string
                  format: misskey:id
              required:
              - announcementId
      responses:
        '200':
          description: OK (with results)
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/Announcement'
        '400':
          description: Client error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                NO_SUCH_ANNOUNCEMENT:
                  value:
                    error:
                      message: No such announcement.
                      code: NO_SUCH_ANNOUNCEMENT
                      id: b57b5e1d-4f49-404a-9edb-46b00268f121
                INVALID_PARAM:
                  value:
                    error:
                      message: Invalid param.
                      code: INVALID_PARAM
                      id: 3d81ceae-475f-4600-b2a8-2bc116157532
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                CREDENTIAL_REQUIRED:
                  value:
                    error:
                      message: Credential required.
                      code: CREDENTIAL_REQUIRED
                      id: 1384574d-a912-4b81-8601-c7b1c4085df1
        '403':
          description: Forbidden error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                AUTHENTICATION_FAILED:
                  value:
                    error:
                      message: Authentication failed. Please ensure your token is correct.
                      code: AUTHENTICATION_FAILED
                      id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14
        '418':
          description: I'm Ai
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                I_AM_AI:
                  value:
                    error:
                      message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server.
                      code: I_AM_AI
                      id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                INTERNAL_ERROR:
                  value:
                    error:
                      message: Internal error occurred. Please contact us if the error persists.
                      code: INTERNAL_ERROR
                      id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac
  /announcements:
    post:
      operationId: post___announcements
      summary: announcements
      description: 'No description provided.


        **Credential required**: *No*'
      externalDocs:
        description: Source code
        url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/announcements.ts
      tags:
      - meta
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                limit:
                  type: integer
                  minimum: 1
                  maximum: 100
                  default: 10
                sinceId:
                  type: string
                  format: misskey:id
                untilId:
                  type: string
                  format: misskey:id
                offset:
                  type: integer
                  default: 0
                isActive:
                  type: boolean
                  default: true
      responses:
        '200':
          description: OK (with results)
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  $ref: '#/components/schemas/Announcement'
        '400':
          description: Client error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                INVALID_PARAM:
                  value:
                    error:
                      message: Invalid param.
                      code: INVALID_PARAM
                      id: 3d81ceae-475f-4600-b2a8-2bc116157532
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                CREDENTIAL_REQUIRED:
                  value:
                    error:
                      message: Credential required.
                      code: CREDENTIAL_REQUIRED
                      id: 1384574d-a912-4b81-8601-c7b1c4085df1
        '403':
          description: Forbidden error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                AUTHENTICATION_FAILED:
                  value:
                    error:
                      message: Authentication failed. Please ensure your token is correct.
                      code: AUTHENTICATION_FAILED
                      id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14
        '418':
          description: I'm Ai
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                I_AM_AI:
                  value:
                    error:
                      message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server.
                      code: I_AM_AI
                      id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                INTERNAL_ERROR:
                  value:
                    error:
                      message: Internal error occurred. Please contact us if the error persists.
                      code: INTERNAL_ERROR
                      id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac
  /announcements/show:
    post:
      operationId: post___announcements___show
      summary: announcements/show
      description: 'No description provided.


        **Credential required**: *No*'
      externalDocs:
        description: Source code
        url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/announcements/show.ts
      tags:
      - meta
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                announcementId:
                  type: string
                  format: misskey:id
              required:
              - announcementId
      responses:
        '200':
          description: OK (with results)
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/Announcement'
        '400':
          description: Client error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                NO_SUCH_ANNOUNCEMENT:
                  value:
                    error:
                      message: No such announcement.
                      code: NO_SUCH_ANNOUNCEMENT
                      id: b57b5e1d-4f49-404a-9edb-46b00268f121
                INVALID_PARAM:
                  value:
                    error:
                      message: Invalid param.
                      code: INVALID_PARAM
                      id: 3d81ceae-475f-4600-b2a8-2bc116157532
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                CREDENTIAL_REQUIRED:
                  value:
                    error:
                      message: Credential required.
                      code: CREDENTIAL_REQUIRED
                      id: 1384574d-a912-4b81-8601-c7b1c4085df1
        '403':
          description: Forbidden error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                AUTHENTICATION_FAILED:
                  value:
                    error:
                      message: Authentication failed. Please ensure your token is correct.
                      code: AUTHENTICATION_FAILED
                      id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14
        '418':
          description: I'm Ai
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                I_AM_AI:
                  value:
                    error:
                      message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server.
                      code: I_AM_AI
                      id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                INTERNAL_ERROR:
                  value:
                    error:
                      message: Internal error occurred. Please contact us if the error persists.
                      code: INTERNAL_ERROR
                      id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac
  /emoji:
    get:
      operationId: get___emoji
      summary: emoji
      description: 'No description provided.


        **Credential required**: *No*'
      externalDocs:
        description: Source code
        url: https://github.com/MisskeyIO/misskey/blob/io/packages/backend/src/server/api/endpoints/emoji.ts
      tags:
      - meta
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
              required:
              - name
      responses:
        '200':
          description: OK (with results)
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/EmojiDetailed'
        '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:
        

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