Misskey

Misskey app API

The app API from Misskey — 2 operation(s) for app.

GitHub OpenAPI

Documentation

📖
Documentation
https://misskey-hub.net/en/docs/for-developers/api/
📖
Authentication
https://misskey-hub.net/en/docs/for-developers/api/token/
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/misskey/refs/heads/main/rate-limits/misskey-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/misskey/refs/heads/main/openapi/misskey-app-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/misskey-dev/misskey

Other Resources

🔗
SDKs
https://github.com/misskey-dev/misskey.js
🔗
Plans
https://raw.githubusercontent.com/api-evangelist/misskey/refs/heads/main/plans/misskey-plans-pricing.yml
🔗
FinOps
https://raw.githubusercontent.com/api-evangelist/misskey/refs/heads/main/finops/misskey-finops.yml
🔗
JSONLDContext
https://raw.githubusercontent.com/api-evangelist/misskey/refs/heads/main/json-ld/misskey-context.jsonld
🔗
JSONLDDescription
https://raw.githubusercontent.com/api-evangelist/misskey/refs/heads/main/json-ld/misskey-api.jsonld
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/misskey/refs/heads/main/vocabulary/misskey-vocabulary.json
🔗
Tags
https://raw.githubusercontent.com/api-evangelist/misskey/refs/heads/main/vocabulary/misskey-tags.json

OpenAPI Specification

misskey-app-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  version: 2025.4.1-io.12b-fb6fbea074
  title: Misskey account app API
servers:
- url: https://misskey.io/api
tags:
- name: app
paths:
  /app/create:
    post:
      operationId: post___app___create
      summary: app/create
      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/app/create.ts
      tags:
      - app
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                description:
                  type: string
                permission:
                  type: array
                  uniqueItems: true
                  items:
                    type: string
                callbackUrl:
                  type:
                  - string
                  - 'null'
              required:
              - name
              - description
              - permission
      responses:
        '200':
          description: OK (with results)
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/App'
        '400':
          description: Client error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                INVALID_PARAM:
                  value:
                    error:
                      message: Invalid param.
                      code: INVALID_PARAM
                      id: 3d81ceae-475f-4600-b2a8-2bc116157532
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                CREDENTIAL_REQUIRED:
                  value:
                    error:
                      message: Credential required.
                      code: CREDENTIAL_REQUIRED
                      id: 1384574d-a912-4b81-8601-c7b1c4085df1
        '403':
          description: Forbidden error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                AUTHENTICATION_FAILED:
                  value:
                    error:
                      message: Authentication failed. Please ensure your token is correct.
                      code: AUTHENTICATION_FAILED
                      id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14
        '418':
          description: I'm Ai
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                I_AM_AI:
                  value:
                    error:
                      message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server.
                      code: I_AM_AI
                      id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                INTERNAL_ERROR:
                  value:
                    error:
                      message: Internal error occurred. Please contact us if the error persists.
                      code: INTERNAL_ERROR
                      id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac
  /app/show:
    post:
      operationId: post___app___show
      summary: app/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/app/show.ts
      tags:
      - app
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                appId:
                  type: string
                  format: misskey:id
              required:
              - appId
      responses:
        '200':
          description: OK (with results)
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/App'
        '400':
          description: Client error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                NO_SUCH_APP:
                  value:
                    error:
                      message: No such app.
                      code: NO_SUCH_APP
                      id: dce83913-2dc6-4093-8a7b-71dbb11718a3
                INVALID_PARAM:
                  value:
                    error:
                      message: Invalid param.
                      code: INVALID_PARAM
                      id: 3d81ceae-475f-4600-b2a8-2bc116157532
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                CREDENTIAL_REQUIRED:
                  value:
                    error:
                      message: Credential required.
                      code: CREDENTIAL_REQUIRED
                      id: 1384574d-a912-4b81-8601-c7b1c4085df1
        '403':
          description: Forbidden error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                AUTHENTICATION_FAILED:
                  value:
                    error:
                      message: Authentication failed. Please ensure your token is correct.
                      code: AUTHENTICATION_FAILED
                      id: b0a7f5f8-dc2f-4171-b91f-de88ad238e14
        '418':
          description: I'm Ai
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                I_AM_AI:
                  value:
                    error:
                      message: You sent a request to Ai-chan, Misskey's showgirl, instead of the server.
                      code: I_AM_AI
                      id: 60c46cd1-f23a-46b1-bebe-5d2b73951a84
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                INTERNAL_ERROR:
                  value:
                    error:
                      message: Internal error occurred. Please contact us if the error persists.
                      code: INTERNAL_ERROR
                      id: 5d37dbcb-891e-41ca-a3d6-e690c97775ac
components:
  schemas:
    App:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        callbackUrl:
          type:
          - string
          - 'null'
        permission:
          type: array
          items:
            type: string
        secret:
          type: string
        isAuthorized:
          type: boolean
      required:
      - id
      - name
      - callbackUrl
      - permission
    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