Affinity: V2 Files Search Post

Search files stored in Affinity by keyword, optionally limited to one company or specific files.

Tool ID: affinity_v2_files_search_post

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'affinity_v2_files_search_post',
  {
    "prompt": "example"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute affinity_v2_files_search_post --input '{
  "prompt": "example"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "data": [
      {
        "file": {
          "id": 123,
          "name": "Example"
        },
        "pageNumber": 1,
        "preview": "example"
      }
    ]
  }
}

Use deepline describe affinity_v2_files_search_post --json for the latest machine-readable contract.

Input reference

Search files by keyword. The scope of the search is controlled by the request body: - Provide fileIds to limit the search to specific files. - Provide companyId to limit the search to files associated with a specific company. - Omit both to search across your entire account. fileIds and companyId are mutually exclusive. Returns up to limit files ordered by relevance. Prompts with no strong matches may still return low-relevance results. Each result contains a matched file and a single representative excerpt (a matching passage from that file). Even if a file contains multiple matching passages, it appears exactly once in the response with one excerpt.

Name	Type	Required	Default	Details
`payload.prompt`	`string`	Yes	—	The search query. Returns up to `limit` files ordered by relevance. Prompts with no strong matches may still return low-relevance results. Minimum length: 3. Maximum length: 500.
`payload.fileIds`	`array`	No	—	Limit search to these specific files. Omit for org-wide search. Maximum items: 100.
`payload.limit`	`integer`	No	`20`	Maximum number of files to return. Format: `int32`. Minimum: 1. Maximum: 100.
`payload.companyId`	`integer`	No	—	Restrict search to files associated with this company. Format: `int64`. Minimum: 1. Maximum: 9007199254740991.

Output reference

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	—
`result.data.data`	`array`	Yes	—	Maximum items: 100.
`result.data.data[].file`	`object`	Yes	—	—
`result.data.data[].file.id`	`integer`	Yes	—	Format: `int32`. Minimum: 1. Maximum: 2147483647.
`result.data.data[].file.name`	`string`	Yes	—	—
`result.data.data[].pageNumber`	`integer \| null`	Yes	—	Format: `int32`. Minimum: 1. Maximum: 10000.
`result.data.data[].preview`	`string`	Yes	—	Maximum length: 2000.
`result.meta`	`object`	No	—	—

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation