Contents

App Intents

Make content and actions discoverable by Apple Intelligence and support system experiences like Siri, Spotlight, Shortcuts, and widgets.

Overview

Make your app’s actions and data available outside your app using the App Intents framework. Every app has code to perform specific actions, such as playing music or displaying photos. Apps also have data, such as songs or photos, that people might want to use outside your app.

[Image]

With App Intents, you express your app’s actions and data in a structured way that makes them discoverable by Apple Intelligence and provides deeper integration with system features people use frequently. For example:

  • People can interact with your app’s content through Siri.

  • Spotlight helps people navigate to your data directly from search results.

  • The Shortcuts app helps people configure workflows that include your app’s actions.

  • People can configure Apple Pencil or the Action button on iPhone to perform your app’s actions when pressed.

  • WidgetKit, Controls, and ActivityKit can use your app’s actions to perform relevant tasks.

  • You can define custom Focus modes, and respond to Focus changes.

Use this framework to declare the actions your app performs as one or more app intents. You can also create app entities and app enums to make your app’s key data types available to the system. For example, a music app might define entities for the songs and albums it manages, and define an app intent to play them. During compilation, the compiler generates information that Apple Intelligence, Siri, and other system features need to discover and use your intents, entities, and app enum types.

For design guidance on how to implement features that involve Widgets, Controls, App Shortcuts, Siri, or the Action button, see Human Interface Guidelines.

Topics

Essentials

App-specific content

System integration

Feature integration

Testing

Errors

Deprecated

Structures