Clay

Plain-language query over accounts, contacts, or deals, auto-detecting which. The only source of the numeric entity IDs the next tool needs.

• query
• audienceName
• onlyMine
• limit
• offset

Analytical question against one to ten named accounts. Reads their contacts, opportunities, Gong calls, and emails.

• accountIds
• question

Resolve one company by domain or LinkedIn URL, returning firmographics plus associated contacts. Names alone fail. Creates a new task.

• companyIdentifier
• companyDataPoints

Find types of people at one company, filtered by title, profile keyword, school, certification, language, location, or tenure. Always scoped to a named company.

• companyIdentifier
• contactFilters
• dataPoints

Resolve specific named people. The only tool that builds a row set spanning more than one company.

• contactIdentifiers
• dataPoints

Append company columns to an existing task. Omitting entityIds enriches every company in it.

• taskId
• dataPoints
• entityIds

The same for contacts.

• taskId
• dataPoints
• entityIds

Lists the workspace functions and their inputs. Its own description is templated with the live list, so it differs per workspace.

Fetch the dropdown options for an input with a configured options source.

• subroutine_id
• inputName

Run a function over entities in an existing task. You author the mapping as { entityField: subroutineInput }.

• subroutine_id
• taskId
• entityIds
• fieldMapping

The same run with the backend generating the field mapping. Supersedes run_subroutine.

• subroutine_id
• taskId
• entityIds
• inputs

Run on raw values with no existing task, up to 1,000 input sets. Preferred when you have concrete inputs. Bills per input set.

• subroutine_id
• inputs

The read path. Returns every entity plus enrichment values and per-enrichment state (completed, in-progress, error). The only way to see enrichment results. Free and idempotent.

• taskId
• entityIds
• page

Task status and results. Documented as a private tool the widget uses for polling, so prefer get-task-context.

• taskId
• page

Returns workspaceName, workspaceId, and workspaceUrl. The connection is pinned to one workspace at auth time.

Booleans only: hasWorkspaceCredits, hasSalesRepCredits, hasBudgetCredits. No numeric balance.

Writes an analytics event into Clay telemetry. Not for model use.

• eventName
• properties

Read a workflow graph, or one node with its prompt, code, tools, edges, and config. Caches to the sandbox filesystem so you can grep it.

• workflowId
• nodeId
• mode

Create, update, or delete a workflow node. Omit nodeId to create, pass it to update, pass it with delete to remove.

• workflowId
• nodeId
• delete
• nodeType
• name
• description
• agentName
• agentPrompt
• agentPrompt__replace
• agentModel
• code
• code__replace
• codeTimeoutMs
• tools
• inputSchema
• outputSchema
• recentOutputPaths
• conditionalConfig
• incomingEdges
• outgoingEdges
• id
• position
• retryConfig
• batchRunSettings

Check a workflow's structure and execution-readiness. Passing prettier auto-cleans and re-lays-out the graph.

• workflowId
• prettier

Run a single Clay action to see its raw output. For testing an action before wiring it into a node, not for production runs.

• actionPackageId
• actionKey
• inputs

Run Python in a sandbox to test logic before it goes in a code node. Must define handler(context) returning a dict.

• code
• inputs

List resources of a type. Returns items, total, and hasMore.

• resourceType
• limit
• offset
• search

Read one trigger, table, or function by ID.

• resourceType
• resourceId

Create, update, or delete a trigger. Which trigger.* fields matter depends on triggerType, which spans manual, webhook, scheduled, CSV upload, Clay table, and three audience flavors.

• resourceId
• delete
• trigger.workflowId
• trigger.triggerType
• trigger.inputSchema
• trigger.segmentId
• trigger.entityType
• trigger.signalId
• trigger.triggerTableId
• trigger.triggerFieldId
• trigger.scheduleConfig
• trigger.snapshotId
• trigger.workflowNodeId
• trigger.createTriggerNode

In schema mode returns columns, types, and row counts; in query mode searches rows in natural language, which needs taskDescription in practice.

• tableId
• mode
• taskDescription