Search Content on External Storage Action

Searches content stored in files, including images, audio recordings, video footage, and PDF documents that are stored in external storage systems, and returns matching files with specific citations.

This action is available in API version 68.0 and later.

This action searches files by meaning, not just exact keywords. For example, a query for "fled" can also return files that mention "absconded" or a video where someone says "ran away." Use it from a flow, an Agentforce agent, or REST API. The Search Files agent action calls this invocable action. For the related Connect REST API, see Search External Storage (POST).

Special Access Rules

To access the Search Content on External Storage action, External Storage Search must be enabled in your org, and the user must have the Search Files in Amazon S3 system permission. For details, see External Storage Search Prerequisites.

Supported REST HTTP Methods

URI
/services/data/v68.0/actions/standard/invocableCallContentSearch
Formats
JSON
HTTP Methods
GET, POST
Authentication
Authorization: Bearer token

Inputs

Input Details
recordId
Type
ID
Description

Required.

The ID of the Salesforce record that scopes the search to associated files, such as a case, complaint, or inspection.
relevanceScore
Type
Double
Description
The minimum relevance score used to filter results, from 0.0 to 1.0, where 1.0 is the most relevant.
searchQuery
Type
String
Description

Required.

The natural-language search query to run against files stored in Amazon S3. Must contain 1 to 4,096 characters and can't be empty.

Outputs

Output Details
hasMore
Type
Boolean
Description
Indicates whether more pages of results are available beyond the current page.
nextSearchHandle
Type
String
Description
Opaque pagination token from the current page of results. Use this value to retrieve the next page of results.
results
Type
String
Description
JSON string that contains the matching files for the current page, ordered by relevance. Each result can include the document title, excerpt, relevance score, source URL, content type, associated ContentDocument IDs, page number, and media timestamps. For the result structure, see External Storage Search Result.
totalResults
Type
Integer
Description
Total number of matching documents across all pages.

Example

GET
This example shows how to get the details of the Search Content on External Storage action type.
POST
Here’s a request for the Search Content on External Storage action.
Here’s a response for the Search Content on External Storage action.