World Chat

Share a message through World Chat using the unified MiniKit API.

Use MiniKit.chat() to open World Chat with a prefilled message.

Availability

• Works natively in World App
• Supports a custom fallback outside World App

Basic Usage

import { MiniKit } from "@worldcoin/minikit-js";
import type {
  CommandResultByVia,
  MiniAppChatSuccessPayload,
  MiniKitChatOptions,
} from "@worldcoin/minikit-js/commands";

export async function shareToChat() {
  const input = {
    message: "Check out this mini app",
    to: ["andy"],
  } satisfies MiniKitChatOptions;

  const result: CommandResultByVia<
    MiniAppChatSuccessPayload,
    MiniAppChatSuccessPayload,
    "minikit"
  > = await MiniKit.chat(input);

  console.log(result.data.count);
}

Result

Type

type ChatResponse =
  | {
      executedWith: "minikit";
      data: {
        status: "success";
        version: number;
        count: number;
        timestamp: string;
      };
    }
  | {
      executedWith: "fallback";
      data: unknown;
    };

Fallback Behavior

Use a custom fallback if you want equivalent sharing behavior outside World App.

Error Codes

Code	Meaning
user_rejected	The user rejected the request
send_failed	Sending the message failed
generic_error	Unexpected failure

Preview