Skip to main content
POST
/
api
/
files
/
v1
/
filesets
/
{fileSetId}
/
query
Query FileSet for File Contents
curl --request POST \
  --url https://{subdomain}.domo.com/api/files/v1/filesets/{fileSetId}/query \
  --header 'Content-Type: application/json' \
  --header 'X-DOMO-Developer-Token: <api-key>' \
  --data '
{
  "query": "benefit",
  "pathPrefixFilter": "sample/directory/path",
  "topK": 2
}
'
{
  "matches": [
    {
      "content": {
        "text": "# Paid Time Off (PTO) Policy\n\n## Overview\nOur PTO policy is designed to provide...(924 characters omitted for brevity)",
        "type": "TEXT"
      },
      "metadata": {
        "fileId": "7150e608-c3a9-4b40-ac2d-eb182cc98c6f",
        "path": "sample/directory/path/PaidTimeOffPolicy.pdf"
      },
      "score": 0.41046342
    },
    {
      "content": {
        "uri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgA...(4777 characters omitted for brevity)",
        "type": "IMAGE"
      },
      "metadata": {
        "fileId": "7150e608-c3a9-4b40-ac2d-eb182cc98c6f",
        "path": "sample/directory/path/PaidTimeOffPolicy.pdf"
      },
      "score": 0.43281752
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://domoinc-openapi-sync-documents.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-DOMO-Developer-Token
string
header
required

Path Parameters

​
fileSetId
string
required

The ID of the FileSet to query.

Body

application/json

The request object containing query criteria.

Used to query a file set for the top K results based on the provided query.

​
query
string
required

The query string to match against file contents within the file set.

​
topK
integer<int32>

The number of top results to return based on the query match. Defaults to 1.

​
pathPrefixFilter
string

An optional prefix filter for the file paths to narrow down the search results.

Response

Query results retrieved successfully

Response object containing a list of matches for a file set query.

​
matches
object[]

A list of matching content found relating to files withing the file set.