@adcp/sdk API Reference - v7.9.0
    Preparing search index...

    Variable RenderConst

    Render: {
        url: (
            fields: Omit<UrlRender, "output_format">,
        ) => Tagged<
            {
                render_id: string;
                output_format: "url";
                preview_url: string;
                role: string;
                dimensions?: { width: number; height: number };
                embedding?: {
                    recommended_sandbox?: string;
                    requires_https?: boolean;
                    supports_fullscreen?: boolean;
                    csp_policy?: string;
                };
            },
            "url",
        >;
        html: (
            fields: Omit<HtmlRender, "output_format">,
        ) => Tagged<
            {
                render_id: string;
                output_format: "html";
                preview_html: string;
                role: string;
                dimensions?: { width: number; height: number };
                embedding?: {
                    recommended_sandbox?: string;
                    requires_https?: boolean;
                    supports_fullscreen?: boolean;
                    csp_policy?: string;
                };
            },
            "html",
        >;
        both: (
            fields: Omit<BothRender, "output_format">,
        ) => Tagged<
            {
                render_id: string;
                output_format: "both";
                preview_url: string;
                preview_html: string;
                role: string;
                dimensions?: { width: number; height: number };
                embedding?: {
                    recommended_sandbox?: string;
                    requires_https?: boolean;
                    supports_fullscreen?: boolean;
                    csp_policy?: string;
                };
            },
            "both",
        >;
    } = ...

    Grouped namespace over the same helpers, useful when constructing a renders[] that mixes variants. Prefer the named exports at single call sites; use Render.url({...}) when building several types together.

    Type Declaration

    • Readonlyurl: (
          fields: Omit<UrlRender, "output_format">,
      ) => Tagged<
          {
              render_id: string;
              output_format: "url";
              preview_url: string;
              role: string;
              dimensions?: { width: number; height: number };
              embedding?: {
                  recommended_sandbox?: string;
                  requires_https?: boolean;
                  supports_fullscreen?: boolean;
                  csp_policy?: string;
              };
          },
          "url",
      >
    • Readonlyhtml: (
          fields: Omit<HtmlRender, "output_format">,
      ) => Tagged<
          {
              render_id: string;
              output_format: "html";
              preview_html: string;
              role: string;
              dimensions?: { width: number; height: number };
              embedding?: {
                  recommended_sandbox?: string;
                  requires_https?: boolean;
                  supports_fullscreen?: boolean;
                  csp_policy?: string;
              };
          },
          "html",
      >
    • Readonlyboth: (
          fields: Omit<BothRender, "output_format">,
      ) => Tagged<
          {
              render_id: string;
              output_format: "both";
              preview_url: string;
              preview_html: string;
              role: string;
              dimensions?: { width: number; height: number };
              embedding?: {
                  recommended_sandbox?: string;
                  requires_https?: boolean;
                  supports_fullscreen?: boolean;
                  csp_policy?: string;
              };
          },
          "both",
      >

    Settings

    Member Visibility