SuperAPI AI Directory

apple-app-intents

Coding & development

View repository

Updated 11-05 21:04

About this skill

Apple App Intents

A collection of references and samples for Apple's App Intents framework (the Swift API that exposes app features and data to system experiences such as Siri, Shortcuts, Spotlight, Apple Intelligence, and Visual Intelligence).

Target version

  • Source: DocC JSON on developer.apple.com (/tutorials/data/documentation/<path>.json). Since the URL has no version, pinned at retrieval date 2026-10-16
  • Target SDK: iOS / iPadOS / macOS / tvOS / visionOS / watchOS 27.0 (Xcode 27.0).updates/appintents The latest section is June 2026. Of the 1258 JSON files retrieved, 0 have a beta flag
  • Framework introduction version
    • App Intents: iOS 16.0 / macOS 13.0 / watchOS 9.0 / visionOS 1.0
    • Visual Intelligence: iOS 26.0 / macOS 27.0
    • App Intents Testing: all OS 27.0
  • For the introduction version of an individual API, the description on each page takes precedence

Directory structure

skills/apple-app-intents/
  SKILL.md
  references/
    intents/                    # AppIntent 本体・実行制御・依存管理
      README.md
      appintent.md
      appintentsextension.md
      appintentspackage.md
      appdependency.md
      intentmodes.md
      longrunningintent.md
      ...
    intent-types/               # システム定義の Intent 種別 (OpenIntent / DeleteIntent / URLRepresentableIntent 等)
      README.md
      openintent.md
      customintentmigratedappintent.md
      ...
    entities/                   # AppEntity / AppEnum / EntityProperty / DisplayRepresentation
      README.md
      appentity.md
      appenum.md
      entityproperty.md
      indexedentity.md
      ...
    queries/                    # EntityQuery 系・ソート・比較演算子
      README.md
      entityquery.md
      entitypropertyquery.md
      ...
    parameters-results/         # IntentParameter / ParameterSummary / IntentResult / IntentDialog
      README.md
      intentparameter.md
      parametersummary.md
      intentresult.md
      ...
    data-types/                 # IntentFile / IntentPerson / IntentItemCollection / IntentValue 系
      README.md
      intentfile.md
      ...
    app-shortcuts/              # AppShortcut / AppShortcutsProvider / SiriTipView
      README.md
      appshortcut.md
      appshortcutsprovider.md
      ...
    app-schemas/                # App Schemas (AppIntent(schema:)) と各ドメイン
      README.md
      appintent-schema-macro.md
      app-schema-base-types.md
      domain-*.md
      ...
    shortcuts-schema-domains/   # Shortcuts 向け schema ドメイン (Books / Browser / Files 等)
      README.md
      domain-*.md
    system-integration/         # Spotlight・donation・snippet・UIKit/AppKit・シーン連携
      README.md
      intentdonationmanager.md
      snippetintent.md
      targetcontentprovidingintent.md
      ...
    feature-integrations/       # Widget / Control / Live Activity / Focus Filter / Workout
      README.md
      widgetconfigurationintent.md
      setfocusfilterintent.md
      ...
    visual-intelligence/        # Visual Intelligence 検索連携
      README.md
      intentvaluequery.md
      semanticcontentdescriptor.md
      ...
    testing/                    # App Intents Testing フレームワーク
      README.md
      appintentstesting-overview.md
      intentdefinitions.md
      ...
  samples/
    README.md
    create-first-app-intent.md
    define-app-entities.md
    adopt-app-schemas.md
    ...(19 件、索引は samples/README.md)

scripts/ does not exist.

Exploration procedure

Derive the category from the task, and identify the target page in the category's README.md.

  1. Find the category corresponding to the task in the mapping table below
  2. For that category, refer to references/{category}/README.md to identify the target page
  3. Read the target page's .md to check the details
  4. For typical implementation procedures, find the relevant sample in samples/README.md Find the corresponding sample from

Task → Category mapping

Task Category Reference README
Declare an AppIntent and implement perform(), configure execution mode, long-running execution, cancellation, and Undo intents references/intents/README.md
Register and inject dependencies (AppDependency), share across targets with AppIntentsPackage intents references/intents/README.md
Use system-defined Intent types such as OpenIntent / DeleteIntent / URLRepresentableIntent intent-types references/intent-types/README.md
Migrate from SiriKit custom Intents intent-types references/intent-types/README.md
Model app data as AppEntity / AppEnum entities references/entities/README.md
Define DisplayRepresentation, EntityProperty, ComputedProperty, and IndexedEntity for Spotlight entities references/entities/README.md
Search and enumerate Entities with EntityQuery, specify sorting and comparison operators queries references/queries/README.md
Define IntentParameter, ParameterSummary, IntentDialog, and IntentResult parameters-results references/parameters-results/README.md
Handle parameter resolution (Resolvers), confirmation, and dynamic options parameters-results references/parameters-results/README.md
Use value types such as IntentFile, IntentPerson, and IntentItemCollection data-types references/data-types/README.md
Provide App Shortcuts (AppShortcutsProvider, spoken phrases), display SiriTipView app-shortcuts references/app-shortcuts/README.md
Expose app features to Apple Intelligence and Siri with App Schemas app-schemas references/app-schemas/README.md
Check domain-specific schemas such as Mail, Photos, Messages, and Notes app-schemas references/app-schemas/README.md
Check schema domains for Shortcuts such as Browser, Document, Spreadsheet, and Whiteboard shortcuts-schema-domains references/shortcuts-schema-domains/README.md
Intent donation, suggesting related Intents, sharing on-screen Entities, snippet display system-integration references/system-integration/README.md
Direct an Intent to a specific scene, integrate UIKit / AppKit data sources system-integration references/system-integration/README.md
Implement Intents for Widget / Control / Live Activity / Focus Filter / Workout feature-integrations references/feature-integrations/README.md
Display app content in Visual Intelligence search results visual-intelligence references/visual-intelligence/README.md
Test App Intents, Entities, and Queries testing references/testing/README.md
Want to know typical usage samples samples/README.md