Run a routine

Run a routine

Runs a Clay-managed function such as Work Email or Company Domain, or a team's own function, on 1 to 100 records and returns a run id to poll for results.

Note: List routines first for the id and input schema; the managed Work Email routine needs a full name, company name and company domain. Poll GET /routines/run/{routine_run_id}/results until the run is complete.

Set up

Use the first option your agent supports.

CLI (official)

Install the command and sign in with it, then confirm it runs.

npm install --global @clay-run/cli
clay --version

Run clay routines runs start.

API (official)

• Base URL: https://api.clay.com/public/v0
• Endpoint: POST /routines/{routine_id}/run
• Auth: send the header clay-api-key: $CLAY_PUBLIC_API_KEY
• Get a key: https://app.clay.com/workspaces/~/settings/account?accountTab=api-keys-beta
• Docs: https://developers.clay.com/public-api/authentication

Before anything else, confirm access with the cheapest read-only call, like a list or a search. Never send or change anything to test access.

Rules

• Ask the user before anything that sends messages, costs money, or changes data, and say how many records it touches. One approval covers a batch the user has seen.
• Never print API keys.