菜单
Clay Public API — HTTP access for building services, apps, and integrations: structured-filter search over Clay's GTM database, structured table queries, and async routine and batch runs.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Clay — start here. A table of contents for working with Clay and which skill to use for each thing — search (find people/companies), routines (run Clay-managed and custom functions), tables (query/export data), the CLI (ephemeral programmatic access), the Public API (build services on Clay), workflows (build automations, Alpha), and feedback. Read this first to answer "what can I do with Clay?"
Clay search — find people or companies in Clay's GTM database from structured filters, and page through the matches. Use when the user wants to search Clay for prospects/accounts, not query an existing table.
Clay setup — authenticate both the `clay` CLI and the Clay MCP server (both are required to use the plugin). Use when `clay` is not found on PATH or the `clay` found in the PATH is the wrong version, `clay whoami` fails, the MCP tools (`read`, `edit_node`) error on auth or don't appear at all despite a Connected server, the CLI isn't signed in, the Cursor plugin never appears after a local install, or the user wants to configure Clay.
Clay tables — analyze what a table does: reconstruct the column DAG, stage it, and narrate the workflow encoded in its columns. Use when the user asks "what does this table do?", "explain the {table} workflow", "walk me through this table", or "what's set up here?".
Clay tables — locate a record by identifier and snapshot its state: which table(s) hold it and each cell's status. Use when the user has an id and asks "trace {id}", "where is {id}?", "what enrichments ran for this lead?", or "is this record done?".
Clay workflows — simplify a workflow: merge redundant nodes, cut unnecessary complexity, and replace LLM nodes with deterministic alternatives where possible.
| name | public-api |
| description | Clay Public API — HTTP access for building services, apps, and integrations: structured-filter search over Clay's GTM database, structured table queries, and async routine and batch runs. |
Beyond the CLI, Clay exposes a Public API you can develop against directly over HTTP.
Reach for it when building a service, app, or integration — not for one-off agent tasks
in a shell (use the cli skill for those).
GET /searches/fields?source_type=people (or companies), start a search with
POST /searches, then page with POST /searches/{search_id}/next. The CLI
equivalent is clay search — see the search skill. Prefer the CLI for one-off searchesThe public API needs its own key — the credential from clay login is not
scoped for it. Issue a dedicated public-API key with the CLI:
clay api-keys create --name "<name>" # → { ..., "apiKey": "<secret>" }
CLI-created keys are always scoped to the public API. The apiKey secret is returned
only once, at creation — store it immediately; it can't be retrieved later. Send it
as a Bearer token against https://api.clay.com/public/v0. Manage existing keys with
clay api-keys list | update | delete.
Full developer documentation — Public API reference, CLI reference, concepts, and the OpenAPI spec — lives at:
Fetch that first to get exact endpoints, request/response shapes, pagination, and rate limits before writing integration code.