Clay Enterprise: Clay Create Filters

Start a Clay search from a source type and structured filters, returning a search ID for fetching the results.

Tool ID: clay_create_filters

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(
  'clay_create_filters',
  {
    "filters": {},
    "source_type": "people"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute clay_create_filters --input '{
  "filters": {},
  "source_type": "people"
}' --json

Example response

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

{
  "data": {
    "search_id": "search_123"
  }
}

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

Input reference

Starts a new Clay search from a source type and structured filter fields.

Name	Type	Required	Default	Details
`payload.filters`	`record`	Yes	—	—
`payload.source_type`	`"people" \| "companies"`	Yes	—	Allowed: `people`, `companies`.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.search_id`	`string`	Yes	—	—
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

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