Skip to content
Integration Hub spokes › Build integrations › Integration Hub › Workflow Data Fabric
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

AI Search Spoke

Store data from the required third-party application in the AI Search server through Workflow Studio. Access data through the AI Search portal.

Request apps on the Store

Visit the ServiceNow Store to view all the available apps, and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes.

Integration Hub subscription

This spoke requires an Integration Hub subscription. For more information, see Legal schedules - IntegrationHub overview.

Spoke version

AI Search spoke v2.0.3 is the latest version.

Spoke dependencies

If you’re having trouble installing the app, ensure that these dependent plugins are activated:

  • AI Search (com.glide.ais)
  • External Content for AI Search (com.glide.ais.external_content)

Note: Some of these plugins are licensable features and require appropriate licenses, if used outside the spoke implementation.

Spoke actions

The AI Search spoke provides actions to automate tasks when events occur in your ServiceNow instance. Available actions include:

ActionDescription
Commit IndexCommits queued documents in the batcher and indexes them. Synchronously returns feedback about the indexed content.
Delete DocumentDeletes a record from the AI Search content index.
Delete DocumentsDeletes all records that use a specified external content schema table from the AI Search content index. You can optionally specify a Glide query to limit the set of documents deleted from the specified schema table.
Get Max File SizeRetrieves the maximum file size which can be ingested into AI Search.
Ingest DocumentIngests properties of the specified document into the batcher. In releases starting with Rome, you can optionally specify security principal access permissions for the document. Specify the document's properties as name-value pairs in a JSON object formatted as in the following example: 
{
  "title": "Report 2021-02-26",
  "author": "Abel Tuter",
  "url": "http://example.com/reports/2021/02/26/"
}
You can specify the document's security principal access permissions as name-value pairs in a JSON object formatted as in the following example: 
{
  "everyone": false,
  "groups.deny": [
    "report-users",
    "hr-users"
  ],
  "groups.read": [
    "report-admins",
    "hr-admins"
  ],
  "none": false,
  "users.deny": [
    "ad\bow-ruggeri",
    "don_goodliffe"
  ],
  "users.read": [
    "ad\beth-anglin",
    "ad\abel-tuter",
    "carol.coughlin@sharepoint"
  ]
}
For more details on security principal access permissions, see External content access permissions.
Ingest Document Using Download URL

Downloads a document from a URL and ingests it into the batcher. In releases starting with Rome, you can optionally specify security principal access permissions for the document.

Add the URL's domain to the AI Search spoke's list of trusted domains before you specify this action's Download URL input. For details on modifying the spoke's list of trusted domains, see Set up the AI Search spoke.

This action doesn't support authentication session IDs or cookies, so the document URL must allow unauthenticated access.

Specify the document's properties as name-value pairs in a JSON object formatted as in the following example:

{
  "title": "Report 2021-02-26",
  "author": "Abel Tuter"
}

The document's url property is automatically populated with the value of the Download URL input.

You can specify the document's security principal access permissions as name-value pairs in a JSON object formatted as in the following example:

{
  "everyone": false,
  "groups.deny": [
    "report-users",
    "hr-users"
  ],
  "groups.read": [
    "report-admins",
    "hr-admins"
  ],
  "none": false,
  "users.deny": [
    "ad\bow-ruggeri",
    "don_goodliffe"
  ],
  "users.read": [
    "ad\beth-anglin",
    "ad\abel-tuter",
    "carol.coughlin@sharepoint"
  ]
}

For more details on security principal access permissions, see External content access permissions.

Initialize BatcherInitializes a new batcher to queue documents for indexing.
Is AIS Available For IngestionChecks whether AI Search is available for ingestion.
Look up Supported File ExtensionsRetrieves file extensions supported by AI Search.
Release BatcherReleases a used batcher from pool.
Update By QueryUpdates all the records in the AI Search content index that match the specified query.

See Set up the AI Search spoke for information about setting up the AI Search spoke.