Skip to main content
Human guide: work with your agent → Inspect one Clay Enterprise action before starting provider-backed work. Your first result is a verified input and output contract.

​
Provider-specific requirements

Use Clay only with the workspace’s own API key. Start with clay_get_public_api_me to confirm the user and workspace. For structured search, call clay_fields before clay_create_filters, then page with clay_run. For advanced query mode, read clay_query_mode_reference, create the search with clay_create_query_mode, then page with clay_run_query_mode. Routine runs are asynchronous. Call clay_run_routine, then poll clay_get_run_results with the returned routine_run_id. For large JSONL inputs, first request an upload URL, upload the file directly to that URL, start the batch with clay_start_routine_run_batch, and poll clay_get_routine_run_batch_results. clay_query reads existing Clay table data and is available only on eligible enterprise Clay plans. Deepline does not bill for Clay usage. Clay account limits and charges still apply.

​
Find an applicable action

Confirm your effective workspace, then search the live catalog:
Search returns candidates. Check the returned provider and operation rather than selecting a similar title automatically.

​
Inspect the selected contract

Replace <returned-tool-id> with the identifier returned by discovery:
These commands do not execute the selected provider action. Read its required inputs, supported access mode, pricing unit, outputs, and limits. A connection does not establish that every action supports BYOK. Follow the provider-specific requirements above and the live action contract.

​
Prepare one reviewed input

Use one authorized record that matches the inspected schema. Preserve its source identity and define the result you will accept. Open the action reference for its payload and response shape. Provider-backed execution can incur usage or external effects. For reusable logic, follow Write Plays. For direct-call recovery, use Tool execution recovery.
Continue only when the workspace, provider, required fields, acceptance rule, and applicable price are understood. Keep unavailable access separate from no-result evidence.