Forest Admin - API reference
    Preparing search index...

    Interface UploadStorage

    Storage backend for the action file upload side-channel. See the README for the flow.

    interface UploadStorage {
        createUploadUrl(
            params: {
                expiresInSeconds: number;
                key: string;
                mimeType: string;
                sha256?: string;
            },
        ): Promise<
            { headers?: Record<string, string>; method?: string; url: string },
        >;
        download(key: string): Promise<Buffer>;
        getSize(key: string): Promise<number>;
    }
    Index

    Methods

    createUploadUrl download getSize

    Methods

    • The URL must be reachable by the MCP client, which is what uploads the bytes.

      Parameters

      • params: { expiresInSeconds: number; key: string; mimeType: string; sha256?: string }
        • expiresInSeconds: number
        • key: string
        • mimeType: string
        • Optionalsha256?: string

          Advisory: the server re-verifies the digest after download regardless.

      Returns Promise<{ headers?: Record<string, string>; method?: string; url: string }>

    • Size of the uploaded object, used to reject oversized uploads before downloading them. Return undefined when the backend cannot report it cheaply — maxBytes is then only enforced after the bytes are in memory, so the process holds the whole object either way.

      Rejecting is fine when the object is absent — reading its metadata is how most backends answer this, and a missing object is the likeliest outcome of the whole flow, the upload having been blocked. The rejection is reported to the caller with the field name and the message, so it does not have to be distinguished from an unreadable one here.

      Parameters

      • key: string

      Returns Promise<number>

    Settings

    Member Visibility

    On This Page

    Methods