igpapi — Instagram private API Simulator for Node.js (API reference) 4.14.0
    Preparing search index...

    Interface DirectImagineCreationActions

    The actions of DirectImagineCreationScreen: the methods you call on its handle while the flow is open.

    interface DirectImagineCreationActions {
        generate: (
            ...args: [prompt: string],
        ) => Effect<
            Bloks.BloksResponse[] & { raw: ActionRaw },

                | IgApiError
                | RequestError
                | ParseError
                | TransportError
                | ScreenEnterConcurrentError,
            never,
        >;
        send: (
            ...args: [input: { file: Buffer }],
        ) => Effect<
            {
                action: string;
                client_context: string;
                message_metadata: DirectBroadcastResponseMessageMetadata[];
                payload: DirectBroadcastResponsePayload;
                status: string;
                status_code: string;
            } & { raw: ActionRaw },

                | IgApiError
                | RequestError
                | ParseError
                | TransportError
                | MessengerMediaUploadMalformedError
                | MessengerMediaUploadHttpError
                | ScreenEnterConcurrentError,
            never,
        >;
    }
    Index

    Properties

    Properties

    generate: (
        ...args: [prompt: string],
    ) => Effect<
        Bloks.BloksResponse[] & { raw: ActionRaw },

            | IgApiError
            | RequestError
            | ParseError
            | TransportError
            | ScreenEnterConcurrentError,
        never,
    >

    The prompt the person typed: six generations at once, then the edit suggestions of the first generated image. The generated entity the suggestions name comes from the generation answer's own id, which the Simulator reads from the flow's answer (never a constant).

    send: (
        ...args: [input: { file: Buffer }],
    ) => Effect<
        {
            action: string;
            client_context: string;
            message_metadata: DirectBroadcastResponseMessageMetadata[];
            payload: DirectBroadcastResponsePayload;
            status: string;
            status_code: string;
        } & { raw: ActionRaw },

            | IgApiError
            | RequestError
            | ParseError
            | TransportError
            | MessengerMediaUploadMalformedError
            | MessengerMediaUploadHttpError
            | ScreenEnterConcurrentError,
        never,
    >

    The generated image the person sends: the photo upload and the composer's broadcast, from the conversation (the flow is popped first, as the app's chain shows: the send's chain is the inbox and the thread).