<!--
{
  "availability" : [
    "iOS: 10.0.0 -",
    "iPadOS: 10.0.0 -",
    "macOS: 12.0.0 -",
    "macCatalyst: 13.0.0 -",
    "tvOS: 14.0.0 -",
    "watchOS: 3.2.0 -",
    "visionOS: 1.0.0 -"
  ],
  "documentType" : "article",
  "framework" : "SiriKit",
  "identifier" : "/documentation/SiriKit",
  "metadataVersion" : "0.1.0",
  "role" : "collection",
  "title" : "SiriKit"
}
-->

# SiriKit

Empower users to interact with their devices through voice, intelligent suggestions, and personalized workflows.

## Discussion> Note: SiriKit and the Intents and IntentsUI frameworks offer legacy support for Siri interactions, Shortcuts actions, and widget configuration. To implement modern support
> for these features, including support for Apple Intelligence, use the <doc://com.apple.documentation/documentation/AppIntents> framework instead.

For SiriKit, use the standard intents that the system provides to empower actions users already ask Siri to do, such as playing music or sending a text message. You can also offer your app’s unique capabilities throughout the system by designing custom intents. For more details about defining custom intents, see <doc://com.apple.documentation/documentation/SiriKit/adding-user-interactivity-with-siri-shortcuts-and-the-shortcuts-app>.

![A collection of devices, including a MacBook Air, an iPhone, an Apple Watch, and a HomePod mini. The devices display user interactions that SiriKit enables. On the MacBook Air, the Shortcuts app is open with a collection of shortcuts in the All Shortcuts section. The iPhone displays a Siri Suggestion with the Maps icon. The Apple Watch displays the Siri animation and the words “What can I help you with?”](images/com.apple.sirikit/media-3849683@2x.png)

You can process intents directly in your app, or in an Intents app extension. For guidance on setting up an app extension and sharing information between your app and extension, see <doc://com.apple.documentation/documentation/SiriKit/structuring-your-code-to-support-app-extensions>.

To display branding or other customized content in Siri and Maps after you fulfill a user request, create a custom view controller in an IntentsUI app extension. See <doc://com.apple.sirikit/documentation/SiriKit/creating-an-intents-ui-extension> for more details.

> Important:
> With a person’s permission, an installed health research app that uses <doc://com.apple.documentation/documentation/SensorKit> entitlements may collect Face Metrics data while your SiriKit app is in use. To prevent SensorKit from collecting Face Metrics data while your app is in use, you can set the <doc://com.apple.documentation/documentation/BundleResources/Information-Property-List/SRResearchDataGeneration> information property list key to `NO`.

## Topics

### Frameworks

Reference the API that compose SiriKit

[`Intents`](/documentation/Intents)

Empower people to customize interactions for your app on their device.

[`IntentsUI`](/documentation/IntentsUI)

Customize content in the interface for Siri and Maps.

### Sample code

Browse sample code that walks through specific Intents and IntentsUI workflows.

  <doc://com.apple.sirikit/documentation/SiriKit/adding-shortcuts-for-wind-down>

  <doc://com.apple.sirikit/documentation/SiriKit/booking-rides-with-sirikit>

  <doc://com.apple.sirikit/documentation/SiriKit/handling-payment-requests-with-sirikit>

  <doc://com.apple.sirikit/documentation/SiriKit/handling-workout-requests-with-sirikit>

  <doc://com.apple.sirikit/documentation/SiriKit/integrating-your-app-with-siri-event-suggestions>

  <doc://com.apple.sirikit/documentation/SiriKit/managing-audio-with-sirikit>

  <doc://com.apple.sirikit/documentation/SiriKit/providing-hands-free-app-control-with-intents>

  <doc://com.apple.sirikit/documentation/SiriKit/soup-chef-accelerating-app-interactions-with-shortcuts>

  <doc://com.apple.sirikit/documentation/SiriKit/soup-chef-with-app-intents-migrating-custom-intents>

### Articles

Browse articles that cover high-level Intents and IntentsUI tasks.

  <doc://com.apple.sirikit/documentation/SiriKit/adding-user-interactivity-with-siri-shortcuts-and-the-shortcuts-app>

  <doc://com.apple.sirikit/documentation/SiriKit/defining-relevant-shortcuts-for-the-siri-watch-face>

  <doc://com.apple.sirikit/documentation/SiriKit/deleting-donated-shortcuts>

  <doc://com.apple.sirikit/documentation/SiriKit/dispatching-intents-to-handlers>

  <doc://com.apple.sirikit/documentation/SiriKit/improving-siri-media-interactions-and-app-selection>

  <doc://com.apple.sirikit/documentation/SiriKit/improving-interactions-between-siri-and-your-messaging-app>

  <doc://com.apple.sirikit/documentation/SiriKit/registering-custom-vocabulary-with-sirikit>

  <doc://com.apple.sirikit/documentation/SiriKit/confirming-the-details-of-an-intent>

  <doc://com.apple.sirikit/documentation/SiriKit/handling-an-intent>

  <doc://com.apple.sirikit/documentation/SiriKit/resolving-the-parameters-of-an-intent>

  <doc://com.apple.sirikit/documentation/SiriKit/generating-a-list-of-ride-options>

  <doc://com.apple.sirikit/documentation/SiriKit/handling-the-ride-booking-intents>

  <doc://com.apple.sirikit/documentation/SiriKit/donating-reservations>

  <doc://com.apple.sirikit/documentation/SiriKit/specifying-synonyms-for-your-app-name>

  <doc://com.apple.sirikit/documentation/SiriKit/intent-phrases>

  <doc://com.apple.sirikit/documentation/SiriKit/localizing-your-vocabulary-for-chinese-dialects>

  <doc://com.apple.sirikit/documentation/SiriKit/parameter-vocabularies>

  <doc://com.apple.sirikit/documentation/SiriKit/offering-actions-in-the-shortcuts-app>

  <doc://com.apple.sirikit/documentation/SiriKit/creating-an-intents-app-extension>

  <doc://com.apple.sirikit/documentation/SiriKit/requesting-authorization-to-use-siri>

  <doc://com.apple.sirikit/documentation/SiriKit/structuring-your-code-to-support-app-extensions>

  <doc://com.apple.sirikit/documentation/SiriKit/providing-live-status-updates>

  <doc://com.apple.sirikit/documentation/SiriKit/donating-shortcuts>

  <doc://com.apple.sirikit/documentation/SiriKit/configuring-the-view-controller-for-your-custom-interface>

  <doc://com.apple.sirikit/documentation/SiriKit/configuring-your-intents-ui-app-extension-target>


---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)