Flow API documentation

Hello!

I’m new to Sketch Plugin development and I want to work something out for the Prototyping Flow. I’ve noticed that in the API Reference the only part of Flow that is exposed is the navigation, so no actions whatsoever. Is this something that is only missing in the docs and could be accessible via the API or it’s not integrated at all?

I’m working with 2025.2.4.

Thanks!

1 Like

Hi Ricardo, welcome to the forum!

You’re quite right, Prototyping options are currently underrepresented in the API – it’s not just the documentation issue. That said, expanding the Prototyping features available via the API is in our immediate plans for the upcoming Sketch releases (maybe not for 2025.3, but, say, 2025.3.1).

In the meantime, could you please tell more about the prototyping workflow that you’re looking to automate with a plugin? Any details you can share will help us shape the API. Thanks!

1 Like

Hey! Thanks for the reply!

Awesome news, looking forward to work with it. My team uses Sketch MeaXure to export Dev specs and the MeaXure already supports the basic prototype navigation export and we’d like to extend the functionality to include the events, mainly hover to show frames. We often have to send our prototypes to users validation and we cannot use the cloud feature due our NDA so we heavily rely on plugins for that

1 Like

Hi,

I found this post since I seem to have a similar use-case: We can’t share/embed the prototypes into our documentation since anyone can just remove the query parameters and then navigate the whole sketch project. Therefore we’re also looking for a way to statically export the prototypes to .html files which currently falls due to not having enough exposed flow APIs.

Will there be an update on this? The API does not seem to have changed with the mentioned releases yet.

Thank you!
Christoph

Hey there!

What a happy coincidence: Sketch Cloud just got Previews that allow you to limit which parts of your project are accessible via prototypes in particular:

With previews, you can share specific pages or prototypes while keeping the rest of the document hidden. This helps you avoid creating separate presentation-ready files and keeps unfinished work out of sight.

As for the JS API improvements – this is still a work in progress and we’d love to hear your thoughts about what this new API should look like and what features should be available :raising_hands: