### Start Misskey Servers for Federation Testing

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/test-federation/README.md

Execute these commands to start the Misskey servers required for federation testing. Ensure NODE_VERSION is set correctly.

```sh
bash ./setup.sh
NODE_VERSION=22 docker compose up --scale tester=0
```

--------------------------------

### Start Local Database with Docker Compose

Source: https://github.com/misskey-dev/misskey/blob/develop/CONTRIBUTING.md

Use this command to set up middleware containers for local development, including PostgreSQL and Redis.

```bash
docker compose -f $PROJECT_ROOT/compose.local-db.yml up -d
```

--------------------------------

### AP API

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Methods for interacting with the ActivityPub protocol, including getting and showing AP-related information.

```APIDOC
## AP API

### Description
Methods for interacting with ActivityPub.

### Methods
- `ApGetRequest`
- `ApGetResponse`
- `ApShowRequest`
- `ApShowResponse`
```

--------------------------------

### Build Project and Navigate to Test Directory

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/test-federation/README.md

Before running tests, build the project and change the working directory to the federation test package.

```sh
pnpm build
cd packages/backend/test-federation
```

--------------------------------

### chat___messages___show

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Retrieves details of a specific chat message. This endpoint is used to get information about a single message.

```APIDOC
## POST /api/chat/messages/show

### Description
Retrieves details of a specific chat message. This endpoint is used to get information about a single message.

### Method
POST

### Endpoint
/api/chat/messages/show

### Parameters
#### Request Body
- **messageId** (string) - Required - The ID of the message to retrieve.

### Request Example
{
  "messageId": "message1"
}

### Response
#### Success Response (200)
- **message** (object) - The chat message object.
  - **id** (string) - The message ID.
  - **userId** (string) - The ID of the user who sent the message.
  - **roomId** (string) - The ID of the room the message was sent in.
  - **text** (string) - The content of the message.
  - **createdAt** (string) - The timestamp when the message was created (ISO 8601 format).

#### Response Example
{
  "message": {
    "id": "message1",
    "userId": "user123",
    "roomId": "room456",
    "text": "Hello there!",
    "createdAt": "2023-10-27T10:00:00.000Z"
  }
}
```

--------------------------------

### Deploy PR to Preview Environment

Source: https://github.com/misskey-dev/misskey/blob/develop/CONTRIBUTING.md

Use the /deploy command in an issue comment to deploy a specific commit hash of a PR to a preview environment for testing federation.

```bash
/deploy sha=<commit hash>
```

--------------------------------

### Notes Show

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Retrieves details for a specific note. This endpoint is used to get the full information about a single note.

```APIDOC
## POST /api/notes/show

### Description
Retrieves details for a specific note.

### Method
POST

### Endpoint
/api/notes/show

### Request Body
- **(object)** - Required - The payload for fetching a single note. Structure depends on the `operations['notes___show']['requestBody']['content']['application/json']` definition.

### Response
#### Success Response (200)
- **(object)** - Details of the requested note. Structure depends on the `operations['notes___show']['responses']['200']['content']['application/json']` definition.
```

--------------------------------

### Federation Following

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Retrieves a list of instances that the specified instance is following.

```APIDOC
## POST /federation/following

### Description
Retrieves a list of instances that the specified instance is following.

### Method
POST

### Endpoint
/federation/following

### Parameters
#### Request Body
- **body** (FederationFollowingRequest) - Required - The request body containing parameters for fetching followed instances.

### Response
#### Success Response (200)
- **response** (FederationFollowingResponse) - The response containing the list of followed instances.
```

--------------------------------

### Gallery Posts Show

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Retrieves details for a specific gallery post. Use this to get information about a single post.

```APIDOC
## GET /gallery/posts/show

### Description
Retrieves details for a specific gallery post.

### Method
GET

### Endpoint
/gallery/posts/show

### Query Parameters
- **postId** (string) - Required - The ID of the post to retrieve.

### Response
#### Success Response (200)
- **post** (object) - The gallery post details.
```

--------------------------------

### Signup Endpoint

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Handles the user signup process, allowing new users to create an account.

```APIDOC
## POST /api/signup

### Description
Allows new users to register an account on the Misskey platform.

### Method
POST

### Endpoint
/api/signup

### Parameters
#### Request Body
- **SignupRequest** (object) - Required - The request payload for signup.
  - (Fields depend on SignupRequest type definition)

### Response
#### Success Response (200)
- **SignupResponse** (object) - The response payload after a successful signup.
  - (Fields depend on SignupResponse type definition)

### Request Example
// Example request body (structure depends on SignupRequest definition):
{
  "username": "newuser",
  "email": "newuser@example.com",
  "password": "securepassword"
}

### Response Example
// Example response body (structure depends on SignupResponse definition):
{
  "userCreated": true,
  "userId": "generated_user_id"
}
```

--------------------------------

### Get Online Users Count

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Retrieves the current count of online users. This provides real-time information about active users on the platform.

```APIDOC
## GET /get-online-users-count

### Description
Retrieves the current count of online users.

### Method
GET

### Endpoint
/get-online-users-count

### Response
#### Success Response (200)
- **count** (integer) - The number of currently online users.
```

--------------------------------

### Federation Show Instance

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Retrieves detailed information about a specific instance.

```APIDOC
## POST /federation/show-instance

### Description
Retrieves detailed information about a specific instance.

### Method
POST

### Endpoint
/federation/show-instance

### Parameters
#### Request Body
- **body** (FederationShowInstanceRequest) - Required - The request body containing parameters for fetching instance details.

### Response
#### Success Response (200)
- **response** (FederationShowInstanceResponse) - The response containing detailed information about the instance.
```

--------------------------------

### Admin Server Information

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Retrieves general information about the Misskey server.

```APIDOC
## Admin Server Information

### Description
Gets information about the Misskey server.

### Method
- `admin_server_info(): AdminServerInfoResponse`

### Response
#### Success Response (200)
- `AdminServerInfoResponse`: Contains server details.
```

--------------------------------

### Get Avatar Decorations

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Retrieves available avatar decorations. This endpoint provides a list of cosmetic items that can be applied to user avatars.

```APIDOC
## GET /get-avatar-decorations

### Description
Retrieves available avatar decorations.

### Method
GET

### Endpoint
/get-avatar-decorations

### Response
#### Success Response (200)
- **decorations** (array) - A list of available avatar decorations.
```

--------------------------------

### Reversi Game Events

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Defines events related to a Reversi game, including starting, ending, cancellations, ready state changes, settings updates, and move logging.

```typescript
reversiGame: {
        params: {
            gameId: string;
        };
        events: {
            started: (payload: {
                game: ReversiGameDetailed;
            }) => void;
            ended: (payload: {
                winnerId: User['id'] | null;
                game: ReversiGameDetailed;
            }) => void;
            canceled: (payload: {
                userId: User['id'];
            }) => void;
            changeReadyStates: (payload: {
                user1: boolean;
                user2: boolean;
            }) => void;
            updateSettings: <K extends ReversiUpdateKey>(payload: {
                userId: User['id'];
                key: K;
                value: ReversiGameDetailed[K];
            }) => void;
            log: (payload: {
                time: number;
                player: boolean;
                operation: 'put';
                pos: number;
            } & {
                id: string | null;
            }) => void;
        };
        receives: {
            putStone: {
                pos: number;
                id: string;
            };
            ready: boolean;
            cancel: null | Record<string, never>;
            updateSettings: ReversiUpdateSettings<ReversiUpdateKey>;
            claimTimeIsUp: null | Record<string, never>;
        };
    };
```

--------------------------------

### Server Information

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Retrieves information about the Misskey server.

```APIDOC
## Server Information

Retrieves information about the Misskey server.

### `server-info`

#### Description
Gets general information about the Misskey server, including its version and features.

#### Method
GET

#### Endpoint
`/api/server-info`
```

--------------------------------

### Run All Federation Tests

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/test-federation/README.md

This command initiates all configured federation tests. It uses Docker Compose to run the tester service without depending on other services.

```sh
NODE_VERSION=22 docker compose run --no-deps --rm tester
```

--------------------------------

### chat___rooms___invitations___create

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Creates an invitation to a chat room. This allows users to invite others to join a room.

```APIDOC
## POST /api/chat/rooms/invitations/create

### Description
Creates an invitation to a chat room. This allows users to invite others to join a room.

### Method
POST

### Endpoint
/api/chat/rooms/invitations/create

### Parameters
#### Request Body
- **roomId** (string) - Required - The ID of the room to invite to.
- **userId** (string) - Required - The ID of the user to invite.

### Request Example
{
  "roomId": "room789",
  "userId": "user007"
}

### Response
#### Success Response (200)
- **invitation** (object) - The created invitation object.
  - **id** (string) - The invitation ID.
  - **roomId** (string) - The ID of the room.
  - **invitedById** (string) - The ID of the user who sent the invitation.
  - **invitedUserId** (string) - The ID of the user who was invited.
  - **createdAt** (string) - The timestamp when the invitation was created (ISO 8601 format).

#### Response Example
{
  "invitation": {
    "id": "invite123",
    "roomId": "room789",
    "invitedById": "user123",
    "invitedUserId": "user007",
    "createdAt": "2023-10-27T11:05:00.000Z"
  }
}
```

--------------------------------

### Federation Instances

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Retrieves a list of instances known to the Misskey federation.

```APIDOC
## POST /federation/instances

### Description
Retrieves a list of instances known to the Misskey federation.

### Method
POST

### Endpoint
/federation/instances

### Parameters
#### Request Body
- **body** (FederationInstancesRequest) - Required - The request body containing parameters for fetching instances.

### Response
#### Success Response (200)
- **response** (FederationInstancesResponse) - The response containing the list of instances.
```

--------------------------------

### Run Tests and Lint

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/docs/CONTRIBUTING.en.md

Execute the test suite and linter to ensure code quality before submitting changes. These commands are essential for maintaining the project's standards.

```bash
npm run test
```

```bash
npm run lint
```

--------------------------------

### Admin System Webhook Create

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Creates a new system-wide webhook for event notifications.

```APIDOC
## POST /api/admin/system-webhook/create

### Description
Creates a new system-wide webhook that can be triggered by various events within the Misskey instance.

### Method
POST

### Endpoint
/api/admin/system-webhook/create

### Parameters
#### Request Body
- **url** (string) - Required - The URL to which the webhook events will be sent.
- **name** (string) - Optional - A descriptive name for the webhook.
- **event** (string) - Required - The event that will trigger this webhook (e.g., 'follow', 'postCreate').
```

--------------------------------

### Signin With Passkey Endpoint

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Handles user sign-in using a passkey (e.g., FIDO2 authenticator).

```APIDOC
## POST /api/signin-with-passkey

### Description
Authenticates a user using a passkey, such as a hardware security key or device-bound credential.

### Method
POST

### Endpoint
/api/signin-with-passkey

### Parameters
#### Request Body
- **SigninWithPasskeyRequest** (object) - Required - The request payload for passkey authentication.
  - (Fields depend on SigninWithPasskeyRequest type definition)

### Response
#### Success Response (200)
- **$switch** (object) - A conditional response object based on the authentication outcome.
  - **$cases** (array) - An array of case conditions.
    - **[0]** (array) - If a context is provided:
      - **context** (string) - The context of the passkey operation.
      - **SigninWithPasskeyResponse** (object) - The response for a completed passkey sign-in.
    - **$default** (object) - If the initial passkey challenge is returned:
      - **SigninWithPasskeyInitResponse** (object) - The response for initiating the passkey sign-in.

### Request Example
// Example request body for initiation (structure depends on SigninWithPasskeyRequest definition):
{
  "username": "user_to_authenticate"
}

### Response Example
// Example response body for initiation (structure depends on SigninWithPasskeyInitResponse definition):
{
  "challenge": "generated_challenge_string",
  "timeout": 60000
}

// Example response body for completion (structure depends on SigninWithPasskeyResponse definition):
{
  "sessionToken": "user_session_token"
}
```

--------------------------------

### App API

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Methods for creating and showing application information.

```APIDOC
## App API

### Description
Methods for managing applications.

### Methods
- `AppCreateRequest`
- `AppCreateResponse`
- `AppShowRequest`
- `AppShowResponse`
```

--------------------------------

### Run Specific Federation Test File

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/backend/test-federation/README.md

To test a particular file, use this command with Docker Compose, specifying the test file path. It runs the test using pnpm.

```sh
NODE_VERSION=22 docker compose run --no-deps --rm tester -- pnpm -F backend test:fed packages/backend/test-federation/test/user.test.ts
```

--------------------------------

### Channels Create

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Creates a new channel.

```APIDOC
## POST /channels/create

### Description
Creates a new channel.

### Method
POST

### Endpoint
/channels/create

### Request Body
- **(ChannelsCreateRequest)**: The request body for creating a channel.
```

--------------------------------

### Application API

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Endpoints for managing applications registered with Misskey.

```APIDOC
## IAppsRequest

### Description
Represents a request related to applications.

## IAppsResponse

### Description
Represents the response structure for application information.

## IAuthorizedAppsRequest

### Description
Represents a request to list authorized applications.

## IAuthorizedAppsResponse

### Description
Represents the response structure for a list of authorized applications.
```

--------------------------------

### i___registry___get-all

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Defines the request and response types for retrieving all registry entries.

```APIDOC
## i___registry___get-all

### Description
Defines the request and response types for retrieving all registry entries.

### Method
Not specified (likely GET or POST)

### Endpoint
Not specified

### Parameters
#### Request Body
- **(type)** - Required - Type definition for the request body is `IRegistryGetAllRequest`.

### Response
#### Success Response (200)
- **(type)** - Description - Type definition for the response body is `IRegistryGetAllResponse`.
```

--------------------------------

### Admin System Webhook List

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Retrieves a list of all configured system-wide webhooks.

```APIDOC
## POST /api/admin/system-webhook/list

### Description
Retrieves a list of all system-wide webhooks configured on the Misskey instance.

### Method
POST

### Endpoint
/api/admin/system-webhook/list

### Parameters
#### Request Body
- **limit** (integer) - Optional - The maximum number of webhooks to return.
- **sinceId** (string) - Optional - Returns webhooks created after this ID.
- **untilId** (string) - Optional - Returns webhooks created before this ID.
```

--------------------------------

### My Apps

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Endpoints for managing and retrieving user's applications.

```APIDOC
## My Apps

### Description
Endpoints for managing user's applications.

### Endpoints
- `GET /api/my-apps`
```

--------------------------------

### Create User List from Public

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Creates a new user list from a collection of public users. This allows for organizing and managing groups of users.

```APIDOC
## POST /api/users/lists/create-from-public

### Description
Creates a user list from public users.

### Method
POST

### Endpoint
/api/users/lists/create-from-public

### Parameters
#### Request Body
- **name** (string) - Required - The name of the new user list.
- **public** (boolean) - Required - Whether the list should be public.
- **userIds** (array) - Required - An array of user IDs to include in the list.

### Response
#### Success Response (200)
- **list** (object) - The created user list object.
```

--------------------------------

### Meta

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Endpoints for retrieving server meta information.

```APIDOC
## Meta

### Description
Endpoints for retrieving server meta information.

### Endpoints
- `GET /api/meta`
```

--------------------------------

### My Apps

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Retrieves a list of applications associated with the current user.

```APIDOC
## My Apps

### Get My Apps

Retrieves a list of applications authorized by the current user.

### Method
POST

### Endpoint
/api/my/apps

### Parameters
#### Request Body
- **limit** (integer) - Optional - The maximum number of results to return.
- **sinceId** (string) - Optional - The ID of the last item to fetch.
- **untilId** (string) - Optional - The ID of the first item to fetch.
```

--------------------------------

### 2FA Key Done Endpoint

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Completes the process of setting up a security key for two-factor authentication.

```APIDOC
## POST /api/i/2fa/key-done

### Description
Finalizes the setup of a security key for two-factor authentication after initial registration.

### Method
POST

### Endpoint
/api/i/2fa/key-done

### Parameters
#### Request Body
- **I2faKeyDoneRequest** (object) - Required - The request payload to complete the 2FA key setup.
  - (Fields depend on I2faKeyDoneRequest_2 type definition, aliased as I2faKeyDoneRequest)

### Response
#### Success Response (200)
- **I2faKeyDoneResponse** (object) - The response payload indicating the completion of the 2FA key setup.
  - (Fields depend on I2faKeyDoneResponse type definition)

### Request Example
// Example request body (structure depends on I2faKeyDoneRequest_2 definition):
{
  "challengeResponse": "challenge_response_string"
}

### Response Example
// Example response body (structure depends on I2faKeyDoneResponse definition):
{
  "status": "completed"
}
```

--------------------------------

### i___registry___get

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Defines the request and response types for retrieving a registry entry.

```APIDOC
## i___registry___get

### Description
Defines the request and response types for retrieving a registry entry.

### Method
Not specified (likely GET or POST)

### Endpoint
Not specified

### Parameters
#### Request Body
- **(type)** - Required - Type definition for the request body is `IRegistryGetRequest`.

### Response
#### Success Response (200)
- **(type)** - Description - Type definition for the response body is `IRegistryGetResponse`.
```

--------------------------------

### Clips Create

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Creates a new clip.

```APIDOC
## POST /clips/create

### Description
Creates a new clip, which is a collection of videos.

### Method
POST

### Endpoint
/clips/create

### Parameters
#### Request Body
- **title** (string) - Required - The title for the new clip.
- **videoIds** (string[]) - Required - An array of video IDs to include in the clip.
- **public** (boolean) - Optional - Whether the clip should be public (defaults to false).
- **description** (string) - Optional - A description for the clip.

### Response
#### Success Response (200)
- **clip** (object) - The newly created clip object.
  - **id** (string) - The ID of the clip.
  - **title** (string) - The title of the clip.
  - **userId** (string) - The ID of the user who created the clip.
  - **public** (boolean) - Whether the clip is public.
  - **folders** (array) - An array of folder IDs the clip belongs to.
  - **createdAt** (string) - The timestamp when the clip was created.
  - **updatedAt** (string | null) - The timestamp when the clip was last updated, or null.
  - **lastNoteUpdatedAt** (string | null) - The timestamp when the last note was added/updated, or null.
  - **description** (string | null) - The description of the clip.
  - **notes** (string | null) - The notes associated with the clip.
  - **visibility** (string) - The visibility setting of the clip ('public', 'private', 'unlisted').
  - **favoritedCount** (number) - The number of users who have favorited this clip.
  - **myFavoritedAt** (string | null) - The timestamp when the current user favorited the clip, or null.
  - **coverUrl** (string | null) - The URL of the clip's cover image, or null.
  - **videosCount** (number) - The number of videos in the clip.
  - **firstVideoCreatedAt** (string) - The creation timestamp of the first video in the clip.
  - **lastVideoCreatedAt** (string) - The creation timestamp of the last video in the clip.

### Response Example
```json
{
  "clip": {
    "id": "clip-id-new",
    "title": "New Clip Title",
    "userId": "user-id-1",
    "public": false,
    "folders": [],
    "createdAt": "2023-10-27T14:00:00Z",
    "updatedAt": null,
    "lastNoteUpdatedAt": null,
    "description": "A collection of recent videos.",
    "notes": null,
    "visibility": "private",
    "favoritedCount": 0,
    "myFavoritedAt": null,
    "coverUrl": null,
    "videosCount": 3,
    "firstVideoCreatedAt": "2023-10-25T09:00:00Z",
    "lastVideoCreatedAt": "2023-10-27T13:50:00Z"
  }
}
```
```

--------------------------------

### Admin Meta

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Endpoints for managing server meta information.

```APIDOC
## Admin Meta

### Description
Endpoints for managing server meta information.

### Endpoints
- `AdminMetaResponse`
- `AdminUpdateMetaRequest`
```

--------------------------------

### Antennas Create

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Creates a new antenna for tracking specific notes.

```APIDOC
## POST /api/antennas/create

### Description
Creates a new antenna, which is a custom feed that aggregates notes based on specified criteria.

### Method
POST

### Endpoint
/api/antennas/create

### Parameters
#### Request Body
- **name** (string) - Required - The name of the antenna.
- **keywords** (array) - Optional - An array of keywords to filter notes.
- **excludeKeywords** (array) - Optional - An array of keywords to exclude from notes.
- **users** (array) - Optional - An array of user IDs to track.
- **userGroups** (array) - Optional - An array of user group IDs to track.
- **like** (boolean) - Optional - Whether to include notes liked by tracked users.
- **followed** (boolean) - Optional - Whether to include notes from followed users.
```

--------------------------------

### FollowingCreate

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Creates a new following relationship. This is a type definition for the request body.

```APIDOC
## FollowingCreate

### Description
Type definition for the request body of the following-create operation.

### Parameters
This type is derived from `operations['following___create']['requestBody']['content']['application/json']` and its specific fields are not detailed here.
```

--------------------------------

### chat___rooms___create

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Creates a new chat room. This endpoint allows users to initiate new group conversations.

```APIDOC
## POST /api/chat/rooms/create

### Description
Creates a new chat room. This endpoint allows users to initiate new group conversations.

### Method
POST

### Endpoint
/api/chat/rooms/create

### Parameters
#### Request Body
- **name** (string) - Optional - The name of the chat room.
- **members** (string[]) - Optional - An array of user IDs to include in the room.

### Request Example
{
  "name": "Project Discussion",
  "members": ["user123", "user789", "user007"]
}

### Response
#### Success Response (200)
- **room** (object) - The created chat room object.
  - **id** (string) - The room ID.
  - **name** (string) - The name of the room.
  - **createdAt** (string) - The timestamp when the room was created (ISO 8601 format).

#### Response Example
{
  "room": {
    "id": "room789",
    "name": "Project Discussion",
    "createdAt": "2023-10-27T11:00:00.000Z"
  }
}
```

--------------------------------

### Admin System Webhooks

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Endpoints for managing system webhooks.

```APIDOC
## Admin System Webhooks

### Description
Endpoints for managing system webhooks.

### Endpoints
- `AdminSystemWebhookCreateRequest`
- `AdminSystemWebhookCreateResponse`
- `AdminSystemWebhookDeleteRequest`
- `AdminSystemWebhookListRequest`
- `AdminSystemWebhookListResponse`
- `AdminSystemWebhookShowRequest`
- `AdminSystemWebhookShowResponse`
- `AdminSystemWebhookTestRequest`
- `AdminSystemWebhookUpdateRequest`
- `AdminSystemWebhookUpdateResponse`
```

--------------------------------

### Admin Drive Management

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Endpoints for managing files within the Misskey drive.

```APIDOC
## Admin Drive Management

### List Drive Files

**Description**: Retrieves a list of files in the drive.

**Method**: GET (assumed)

**Endpoint**: `/admin/drive/files`

#### Query Parameters

- **limit** (number) - Optional - The maximum number of files to return.
- **sinceId** (string) - Optional - Returns files created since this ID.
- **untilId** (string) - Optional - Returns files created until this ID.

### Show Drive File

**Description**: Retrieves details of a specific file in the drive.

**Method**: GET (assumed)

**Endpoint**: `/admin/drive/show-file`

#### Query Parameters

- **fileId** (string) - Required - The ID of the file to retrieve.
```

--------------------------------

### General API

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

General endpoints for retrieving system information and user-specific data.

```APIDOC
## GetAvatarDecorationsResponse

### Description
Represents the response structure for retrieving avatar decorations.

## GetOnlineUsersCountResponse

### Description
Represents the response structure for the count of online users.

## IResponse

### Description
Represents a generic response structure for API calls.
```

--------------------------------

### Reversi Module

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Handles the Reversi game logic, including matching, invitations, and game state updates.

```APIDOC
## Reversi Module

### Description
Handles the Reversi game logic, including matching, invitations, and game state updates.

### Events
- **matched**: Emitted when a Reversi game is successfully matched.
  - **payload** (ReversiGameDetailed): Detailed information about the matched game.
- **invited**: Emitted when a user is invited to a Reversi game.
  - **payload** (User): Information about the user who sent the invitation.
```

--------------------------------

### invite___create

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Defines the response type for creating an invite.

```APIDOC
## invite___create

### Description
Defines the response type for creating an invite.

### Method
Not specified (likely POST)

### Endpoint
Not specified

### Response
#### Success Response (200)
- **(type)** - Description - Type definition for the response body is `InviteCreateResponse`.
```

--------------------------------

### Gallery Posts Create

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Creates a new post in the gallery. Users can upload and share their content through this endpoint.

```APIDOC
## POST /gallery/posts/create

### Description
Creates a new post in the gallery.

### Method
POST

### Endpoint
/gallery/posts/create

### Request Body
- **file** (object) - Required - The file to upload.
  - **id** (string) - Required - The ID of the file.
- **title** (string) - Optional - The title of the gallery post.
- **summary** (string) - Optional - A summary or description for the post.
- **tags** (array) - Optional - An array of tags associated with the post.
  - **name** (string) - Required - The tag name.

### Response
#### Success Response (200)
- **post** (object) - The created gallery post.
  - **id** (string) - The ID of the post.
  - **title** (string) - The title of the post.
  - **summary** (string) - The summary of the post.
  - **tags** (array) - The tags associated with the post.
```

--------------------------------

### Notes Global Timeline

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Fetches notes from the global timeline. This provides a view of all public notes across the Misskey instance.

```APIDOC
## POST /api/notes/global-timeline

### Description
Fetches notes from the global timeline.

### Method
POST

### Endpoint
/api/notes/global-timeline

### Request Body
- **(object)** - Required - The payload for fetching the global timeline. Structure depends on the `operations['notes___global-timeline']['requestBody']['content']['application/json']` definition.

### Response
#### Success Response (200)
- **(object)** - Notes from the global timeline. Structure depends on the `operations['notes___global-timeline']['responses']['200']['content']['application/json']` definition.
```

--------------------------------

### Promo

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Endpoint for reading promotional content.

```APIDOC
## Promo

### Description
Endpoint for reading promotional content.

### Endpoint
- `GET /api/promo/read`
```

--------------------------------

### i___registry___get-detail

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Defines the request and response types for retrieving a specific registry entry detail.

```APIDOC
## i___registry___get-detail

### Description
Defines the request and response types for retrieving a specific registry entry detail.

### Method
Not specified (likely GET or POST)

### Endpoint
Not specified

### Parameters
#### Request Body
- **(type)** - Required - Type definition for the request body is `IRegistryGetDetailRequest`.

### Response
#### Success Response (200)
- **(type)** - Description - Type definition for the response body is `IRegistryGetDetailResponse`.
```

--------------------------------

### Admin System Webhook Show

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Retrieves details for a specific system-wide webhook.

```APIDOC
## POST /api/admin/system-webhook/show

### Description
Retrieves detailed information about a specific system-wide webhook.

### Method
POST

### Endpoint
/api/admin/system-webhook/show

### Parameters
#### Request Body
- **id** (string) - Required - The ID of the webhook to retrieve.
```

--------------------------------

### Reversi Game Module

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Manages individual Reversi game instances, allowing players to make moves, update settings, and track game progress.

```APIDOC
## Reversi Game Module

### Description
Manages individual Reversi game instances, allowing players to make moves, update settings, and track game progress.

### Parameters
- **gameId** (string): The unique identifier for the Reversi game.

### Events
- **started**: Emitted when a Reversi game begins.
  - **payload** (object): Contains detailed information about the started game.
    - **game** (ReversiGameDetailed): The detailed game object.
- **ended**: Emitted when a Reversi game concludes.
  - **payload** (object): Contains information about the game's end.
    - **winnerId** (string | null): The ID of the winning player, or null if it was a draw.
    - **game** (ReversiGameDetailed): The detailed game object.
- **canceled**: Emitted when a Reversi game is canceled.
  - **payload** (object): Contains information about the cancellation.
    - **userId** (string): The ID of the user who canceled the game.
- **changeReadyStates**: Emitted when the ready states of players change.
  - **payload** (object): Contains the new ready states.
    - **user1** (boolean): The ready state of the first user.
    - **user2** (boolean): The ready state of the second user.
- **updateSettings**: Emitted when Reversi game settings are updated.
  - **payload** (object): Contains the updated setting.
    - **userId** (string): The ID of the user who updated the settings.
    - **key** (ReversiUpdateKey): The key of the setting that was updated.
    - **value** (any): The new value of the setting.
- **log**: Emitted to log game actions.
  - **payload** (object): Contains log details.
    - **time** (number): The timestamp of the action.
    - **player** (boolean): Indicates the player associated with the action.
    - **operation** (string): The type of operation performed (e.g., 'put').
    - **pos** (number): The position of the action.
    - **id** (string | null): An optional identifier for the log entry.

### Receives
- **putStone**: Request to place a stone on the board.
  - **pos** (number): The position where the stone is placed.
  - **id** (string): The ID of the move.
- **ready**: Signal that a player is ready.
- **cancel**: Request to cancel the game.
- **updateSettings**: Request to update game settings.
  - **(ReversiUpdateSettings<ReversiUpdateKey>)**: The settings to update.
- **claimTimeIsUp**: Signal that a player's time has run out.
```

--------------------------------

### i___move

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Defines the request and response types for moving resources.

```APIDOC
## i___move

### Description
Defines the request and response types for moving resources.

### Method
Not specified (likely POST)

### Endpoint
Not specified

### Parameters
#### Request Body
- **(type)** - Required - Type definition for the request body is `IMoveRequest`.

### Response
#### Success Response (200)
- **(type)** - Description - Type definition for the response body is `IMoveResponse`.
```

--------------------------------

### Following API

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Endpoints for managing follow relationships between users.

```APIDOC
## FollowingCreateRequest

### Description
Represents the request structure for creating a follow relationship.

## FollowingCreateResponse

### Description
Represents the response structure for creating a follow relationship.

## FollowingDeleteRequest

### Description
Represents the request structure for deleting a follow relationship.

## FollowingInvalidateRequest

### Description
Represents a request to invalidate follow relationships.

## FollowingInvalidateResponse

### Description
Represents the response structure for invalidating follow relationships.

## FollowingListRequest

### Description
Represents a request to list users being followed.

## FollowingListResponse

### Description
Represents the response structure for a list of followed users.

## FollowingRequestsAcceptRequest

### Description
Represents a request to accept a follow request.

## FollowingRequestsCancelRequest

### Description
Represents a request to cancel a follow request.

## FollowingRequestsCancelResponse

### Description
Represents the response structure for canceling a follow request.

## FollowingRequestsListRequest

### Description
Represents a request to list pending follow requests.

## FollowingRequestsListResponse

### Description
Represents the response structure for a list of follow requests.

## FollowingRequestsRejectRequest

### Description
Represents a request to reject a follow request.

## FollowingRequestsSentRequest

### Description
Represents a request to list follow requests sent by the user.

## FollowingRequestsSentResponse

### Description
Represents the response structure for sent follow requests.

## FollowingUpdateRequest

### Description
Represents the request structure for updating a follow relationship.

## FollowingUpdateResponse

### Description
Represents the response structure for updating a follow relationship.

## FollowingUpdateAllRequest

### Description
Represents a request to update all follow relationships.
```

--------------------------------

### Admin Server Info

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Endpoints for retrieving server information.

```APIDOC
## Admin Server Info

### Description
Endpoints for retrieving server information.

### Endpoints
- `AdminServerInfoResponse`
```

--------------------------------

### Registry API

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Endpoints for interacting with the Misskey registry, a key-value store.

```APIDOC
## IRegistryGetRequest

### Description
Represents the request structure for getting a registry value.

## IRegistryGetResponse

### Description
Represents the response structure for a registry value.

## IRegistryGetAllRequest

### Description
Represents the request structure for getting all registry values.

## IRegistryGetAllResponse

### Description
Represents the response structure for all registry values.

## IRegistryGetDetailRequest

### Description
Represents the request structure for getting detailed registry information.

## IRegistryGetDetailResponse

### Description
Represents the response structure for detailed registry information.

## IRegistryKeysRequest

### Description
Represents a request to list registry keys.

## IRegistryKeysResponse

### Description
Represents the response structure for a list of registry keys.

## IRegistryKeysWithTypeRequest

### Description
Represents a request to list registry keys of a specific type.

## IRegistryKeysWithTypeResponse

### Description
Represents the response structure for a list of registry keys of a specific type.
```

--------------------------------

### invite___list

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Defines the request and response types for listing invites.

```APIDOC
## invite___list

### Description
Defines the request and response types for listing invites.

### Method
Not specified (likely GET or POST)

### Endpoint
Not specified

### Parameters
#### Request Body
- **(type)** - Required - Type definition for the request body is `InviteListRequest`.

### Response
#### Success Response (200)
- **(type)** - Description - Type definition for the response body is `InviteListResponse`.
```

--------------------------------

### APIClient Class

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

The APIClient class is the primary interface for interacting with the Misskey API. It handles authentication, request origin, and fetching data.

```APIDOC
## class APIClient

### Description
The APIClient class is used to interact with the Misskey API. It manages the API origin, credentials, and the fetch implementation.

### Constructor
```typescript
constructor(opts: {
    origin: APIClient['origin'];
    credential?: APIClient['credential'];
    fetch?: APIClient['fetch'] | null | undefined;
});
```

### Properties
- **credential**: `string | null | undefined` - The authentication credential for API requests.
- **fetch**: `FetchLike` - The fetch implementation to use for making API requests.
- **origin**: `string` - The base URL of the Misskey API endpoint.
```

--------------------------------

### Chat Rooms Joining

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Allows a user to join a chat room.

```APIDOC
## POST /chat/rooms/joining

### Description
Allows a user to join a specified chat room.

### Method
POST

### Endpoint
/chat/rooms/joining

### Parameters
#### Request Body
- **roomId** (string) - Required - The ID of the room to join.

### Response
#### Success Response (200)
- **room** (object) - Details of the joined room.
  - **id** (string) - The ID of the room.
  - **name** (string) - The name of the room.
  - **usersCount** (number) - The number of users in the room.
  - **lastMessage** (object | null) - The last message in the room, or null if none.
    - **id** (string) - The ID of the last message.
    - **userId** (string) - The ID of the user who sent the last message.
    - **username** (string) - The username of the sender.
    - **name** (string) - The display name of the sender.
    - **avatarUrl** (string | null) - The URL of the sender's avatar, or null.
    - **message** (string) - The content of the last message.
    - **createdAt** (string) - The timestamp when the last message was created.

### Response Example
```json
{
  "room": {
    "id": "room-id-789",
    "name": "General Discussion",
    "usersCount": 6,
    "lastMessage": {
      "id": "msg-abc",
      "userId": "user-id-1",
      "username": "alice",
      "name": "Alice",
      "avatarUrl": "https://example.com/avatar.jpg",
      "message": "Hello everyone!",
      "createdAt": "2023-10-27T09:55:00Z"
    }
  }
}
```
```

--------------------------------

### Following Requests List

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Retrieves a list of pending follow requests. This endpoint is useful for users who want to manage incoming follow requests.

```APIDOC
## GET /following/requests/list

### Description
Retrieves a list of pending follow requests.

### Method
GET

### Endpoint
/following/requests/list

### Response
#### Success Response (200)
- **requests** (array) - A list of follow requests.
  - **id** (string) - The ID of the request.
  - **user** (object) - Information about the user who sent the request.
    - **id** (string) - User ID.
    - **username** (string) - Username.
    - **name** (string) - Display name.
    - **avatarUrl** (string) - URL of the user's avatar.
    - **isBot** (boolean) - Whether the user is a bot.
    - **isFollower** (boolean) - Whether the current user is following this user.
    - **isFollowing** (boolean) - Whether this user is following the current user.
```

--------------------------------

### Channels Follow

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Follows a channel.

```APIDOC
## POST /channels/follow

### Description
Follows a channel.

### Method
POST

### Endpoint
/channels/follow

### Request Body
- **(ChannelsFollowRequest)**: The request body for following a channel.
```

--------------------------------

### Ping

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Endpoint for checking server liveness.

```APIDOC
## Ping

### Description
Endpoint for checking server liveness.

### Endpoint
- `GET /api/ping`
```

--------------------------------

### Signin Flow Endpoint

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Initiates or continues the sign-in flow for a user.

```APIDOC
## POST /api/signin-flow

### Description
Initiates or manages the multi-step sign-in process for users.

### Method
POST

### Endpoint
/api/signin-flow

### Parameters
#### Request Body
- **SigninFlowRequest** (object) - Required - The request payload to start or continue the sign-in flow.
  - (Fields depend on SigninFlowRequest type definition)

### Response
#### Success Response (200)
- **SigninFlowResponse** (object) - The response payload containing information about the current state of the sign-in flow.
  - (Fields depend on SigninFlowResponse type definition)

### Request Example
// Example request body (structure depends on SigninFlowRequest definition):
{
  "identifier": "username_or_email"
}

### Response Example
// Example response body (structure depends on SigninFlowResponse definition):
{
  "flowType": "password",
  "challengeRequired": true
}
```

--------------------------------

### Admin Avatar Decorations

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Endpoints for managing avatar decorations in Misskey. This includes creating, deleting, listing, and updating decorations.

```APIDOC
## Admin Avatar Decorations

### Create Avatar Decoration

**Description**: Creates a new avatar decoration.

**Method**: POST (assumed)

**Endpoint**: `/admin/avatar-decorations/create`

#### Request Body

- **...decoration fields** - Fields required to create an avatar decoration.

### Delete Avatar Decoration

**Description**: Deletes an existing avatar decoration.

**Method**: POST (assumed)

**Endpoint**: `/admin/avatar-decorations/delete`

#### Request Body

- **decorationId** (string) - Required - The ID of the decoration to delete.

### List Avatar Decorations

**Description**: Retrieves a list of available avatar decorations.

**Method**: GET (assumed)

**Endpoint**: `/admin/avatar-decorations/list`

### Update Avatar Decoration

**Description**: Updates an existing avatar decoration.

**Method**: POST (assumed)

**Endpoint**: `/admin/avatar-decorations/update`

#### Request Body

- **decorationId** (string) - Required - The ID of the decoration to update.
- **...other fields** - Fields to update for the decoration.
```

--------------------------------

### Notes Local Timeline

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Fetches notes from the local timeline. This view typically shows notes from users on the same instance.

```APIDOC
## POST /api/notes/local-timeline

### Description
Fetches notes from the local timeline.

### Method
POST

### Endpoint
/api/notes/local-timeline

### Request Body
- **(object)** - Required - The payload for fetching the local timeline. Structure depends on the `operations['notes___local-timeline']['requestBody']['content']['application/json']` definition.

### Response
#### Success Response (200)
- **(object)** - Notes from the local timeline. Structure depends on the `operations['notes___local-timeline']['responses']['200']['content']['application/json']` definition.
```

--------------------------------

### Server Info

Source: https://github.com/misskey-dev/misskey/blob/develop/packages/misskey-js/etc/misskey-js.api.md

Endpoint for retrieving server information.

```APIDOC
## Server Info

### Description
Endpoint for retrieving server information.

### Endpoint
- `GET /api/server/info`
```