Clay
Connect to Clay to run GTM routines, batch enrichments, structured searches, and table queries through the Clay Public API.
Authentication
| Method | Kind | Status | Details |
|---|---|---|---|
| API Key | api_key | available | — |
Call a tool
import { createClient } from "@open-connector/sdk";const oc = createClient({ baseUrl: "https://api.openconnector.dev", apiKey: process.env.OPEN_CONNECTOR_API_KEY!,});const result = await oc.executeTool({ slug: "CLAY_CREATE_FILTERS", connectedAccountId: "conn_...", arguments: { /* match this tool's input schema */ },});import Composio from "@composio/client";const composio = new Composio({ baseURL: "https://api.openconnector.dev/composio", apiKey: process.env.OPEN_CONNECTOR_API_KEY!,});const result = await composio.tools.execute("CLAY_CREATE_FILTERS", { connected_account_id: "conn_...", arguments: { /* match this tool's input schema */ },});oc tools execute CLAY_CREATE_FILTERS --data '{ }'Tool catalog
Available tools
10 callable operations
Create a search from structured filtersCLAY_CREATE_FILTERSStarts a new Clay search from a source type and structured filter fields.Connection
Starts a new Clay search from a source type and structured filter fields.
Authentication
Connected account requiredTags
List the filter fields available for a search source typeCLAY_FIELDSReturns every filter field accepted by POST /search/filters-mode for the given source type, including each field's type, description, allowed values, and usage guidance. Call this before creating a search to build valid filters.Connection
Returns every filter field accepted by POST /search/filters-mode for the given source type, including each field's type, description, allowed values, and usage guidance. Call this before creating a search to build valid filters.
Authentication
Connected account requiredTags
Get the authenticated userCLAY_GET_PUBLIC_API_MEReturns the Clay user and workspace associated with the API key.Connection
Returns the Clay user and workspace associated with the API key.
Authentication
Connected account requiredTags
Fetch progress and results for a batch runCLAY_GET_ROUTINE_RUN_BATCH_RESULTSReturns current status and results for an asynchronous batch routine run.Connection
Returns current status and results for an asynchronous batch routine run.
Authentication
Connected account requiredTags
Fetch progress and results for a routine runCLAY_GET_RUN_RESULTSReturns current status and paginated results for an asynchronous routine run.Connection
Returns current status and paginated results for an asynchronous routine run.
Authentication
Connected account requiredTags
Run a structured query across one or more tablesCLAY_QUERYRuns a structured query against Clay table data and returns records with field metadata.Connection
Runs a structured query against Clay table data and returns records with field metadata.
Authentication
Connected account requiredTags
Run the search iterator and return the next page of resultsCLAY_RUNReturns the next page of records for an existing filter-mode search.Connection
Returns the next page of records for an existing filter-mode search.
Authentication
Connected account requiredTags
Execute a routine against 1-100 itemsCLAY_RUN_ROUTINEStarts an asynchronous routine run for up to 100 input items.Connection
Starts an asynchronous routine run for up to 100 input items.
Authentication
Connected account requiredTags
Issue a presigned PUT URL for uploading a batch input JSONLCLAY_RUN_ROUTINE_BATCH_UPLOAD_URLCreates a presigned URL for uploading a JSONL file used by a batch routine run.Connection
Creates a presigned URL for uploading a JSONL file used by a batch routine run.
Authentication
Connected account requiredTags
Start an async routine run-batch over an uploaded JSONL fileCLAY_START_ROUTINE_RUN_BATCHStarts an asynchronous batch routine run over a previously uploaded JSONL file.Connection
Starts an asynchronous batch routine run over a previously uploaded JSONL file.
Authentication
Connected account requiredTags