> ## Documentation Index
> Fetch the complete documentation index at: https://www.canva.dev/docs/apps/llms.txt
> Use this file to discover all available pages before exploring further.

# openDesign

API reference for the openDesign method.

Reads (and optionally updates) a specified part of the user's design.

<Tabs>
  <Tab name="DesignOpenCurrentPageOptions">
    Reads (and optionally updates) the current page of the user's design.

    ## Usage: Read the current page

    ```typescript
    import { openDesign } from "@canva/design";

    await openDesign({ type: 'current_page' }, async (session) => {
      // Do something with session.page
      await session.sync();
    });
    ```

    ## Parameters

    <Prop.List>
      <Prop name="options" required type="DesignOpenCurrentPageOptions" sourceLineNumbers={[4783]}>
        Options for configuring how the current page is read.

        <PillAccordion defaultExpanded={true} title={<>Properties of <strong>options</strong></>}>
          <Prop.List>
            <Prop name="type" required type="string" sourceLineNumbers={[3275]}>
              The type of context.

              The only valid value is `"current_page"`.
            </Prop>
          </Prop.List>
        </PillAccordion>
      </Prop>

      <Prop name="callback" required type="DesignOpenCurrentPageCallback" sourceLineNumbers={[4783]}>
        A callback for operating on the current page.

        **Parameters**

        <Prop.List>
          <Prop name="session" required type="DesignEditing.CurrentPageSession" sourceLineNumbers={[3265]}>
            Session received by the `openDesign` callback when opening the current page.

            <PillAccordion defaultExpanded={false} title={<>Properties of <strong>session</strong></>}>
              <Prop.List>
                <Prop name="page" required type="DesignEditing.Page" sourceLineNumbers={[2134]}>
                  The current page of the design.

                  <Tabs>
                    <Tab name="AbsolutePage">
                      A page with either fixed or unbounded dimensions.

                      For more information, see [AbsolutePage](/docs/apps/api/latest/design-types-absolute-page/).
                    </Tab>

                    <Tab name="Unsupported">
                      Represents design content that the SDK doesn't support.

                      <Prop.List>
                        <Prop name="type" required readonly type="string" sourceLineNumbers={[2400]}>
                          The only valid value is `"unsupported"`.
                        </Prop>
                      </Prop.List>
                    </Tab>
                  </Tabs>
                </Prop>

                <Prop name="helpers" required type="DesignEditing.PageHelpers" sourceLineNumbers={[2138]}>
                  These are various utilities that allow apps to do more complex operations on the page.

                  For more information, see [PageHelpers](/docs/apps/api/latest/design-types-page-helpers/).
                </Prop>

                <Prop name="sync" required type="function" sourceLineNumbers={[2146]}>
                  Saves any changes made during the session while keeping the session open.

                  * Any changes in the session are only reflected in the design after this method is called.
                  * Once this method is called, further changes in the session can still be made.

                  **Returns**

                  `Promise<void>`
                </Prop>
              </Prop.List>
            </PillAccordion>
          </Prop>
        </Prop.List>

        **Returns**

        `Promise<void>`
      </Prop>
    </Prop.List>

    ## Returns

    `Promise<void>`
  </Tab>

  <Tab name="DesignOpenAllPagesOptions">
    Reads (and optionally updates) all pages of the user's design.

    ## Usage: Read all pages

    ```typescript
    import { openDesign } from "@canva/design";

    await openDesign({ type: 'all_pages' }, async (session) => {
      // Do something with session.pageRefs
      await session.sync();
    });
    ```

    ## Parameters

    <Prop.List>
      <Prop name="options" required type="DesignOpenAllPagesOptions" sourceLineNumbers={[4800]}>
        Options for configuring how all pages are read.

        <PillAccordion defaultExpanded={true} title={<>Properties of <strong>options</strong></>}>
          <Prop.List>
            <Prop name="type" required type="string" sourceLineNumbers={[3250]}>
              The type of context.

              The only valid value is `"all_pages"`.
            </Prop>
          </Prop.List>
        </PillAccordion>
      </Prop>

      <Prop name="callback" required type="DesignOpenAllPagesCallback" sourceLineNumbers={[4800]}>
        A callback for operating on all pages.

        **Parameters**

        <Prop.List>
          <Prop name="session" required type="DesignEditing.AllPagesSession" sourceLineNumbers={[3240]}>
            Session received by the `openDesign` callback when opening all pages.

            <PillAccordion defaultExpanded={false} title={<>Properties of <strong>session</strong></>}>
              <Prop.List>
                <Prop name="pageRefs" required type="DesignEditing.PageRefList" sourceLineNumbers={[2202]}>
                  References to all pages of the design.

                  For more information, see [PageRefList](/docs/apps/api/latest/design-types-page-ref-list/).
                </Prop>

                <Prop name="helpers" required type="DesignEditing.AllPagesHelpers" sourceLineNumbers={[2206]}>
                  These are various utilities that allow apps to do more complex operations on the page.

                  For more information, see [AllPagesHelpers](/docs/apps/api/latest/design-types-all-pages-helpers/).
                </Prop>

                <Prop name="sync" required type="function" sourceLineNumbers={[2214]}>
                  Saves any changes made during the session while keeping the session open.

                  * Any changes in the session are only reflected in the design after this method is called.
                  * Once this method is called, further changes in the session can still be made.

                  **Returns**

                  `Promise<void>`
                </Prop>
              </Prop.List>
            </PillAccordion>
          </Prop>
        </Prop.List>

        **Returns**

        `Promise<void>`
      </Prop>
    </Prop.List>

    ## Returns

    `Promise<void>`
  </Tab>
</Tabs>

## Permissions

To use this method, the following permissions must be enabled for the app:

* `canva:design:content:read`, to read the design
* `canva:design:content:write`, if the app calls the `sync` method

To learn more, see [Permissions](https://www.canva.dev/docs/apps/configuring-intents-permissions/).

## Rate limit

This method has the following rate limits:

* Opening the design: 10 requests every 10 seconds
* Calling the `sync` method: 10 requests every 10 seconds