Public Api

作者 clay-run769514a3a236無授權條款130 個星標收錄於 2026年10月8日更新於 2026年10月8日儲存庫今天更新

Clay Public API — HTTP access for building services, apps, and integrations: GTM database search, structured table queries, and async routine and batch runs.

AI 產生的概覽

介紹 Clay 公開 API,用於建置 HTTP 整合:GTM 資料庫搜尋、資料表查詢,以及非同步例行與批次執行。

功能
此技能是 Clay 公開 API 的參考指南,該 API 透過 HTTP 存取,用於建置服務、應用程式與整合。它概述了 API 的主要能力:使用進階查詢在 Clay 的 GTM 資料庫中尋找人員或公司、對 Clay 資料表執行結構化查詢,以及觸發非同步例行與批次執行。它也說明了驗證方式,指出公開 API 需要自己的專用金鑰(透過 Clay CLI 建立),並指向外部開發者文件以取得確切的端點、請求與回應結構、分頁與速率限制。
適用情境
在建置透過 HTTP 呼叫 Clay 公開 API 的服務、應用程式或整合時使用此技能。它不適用於在 shell 中執行的一次性代理任務,此技能建議這類任務改用 CLI。
執行需求
需要專用的 Clay 公開 API 金鑰,該金鑰透過 Clay CLI 建立,並以 Bearer 權杖傳送至 Clay API 端點。需要存取 Clay API 與外部開發者文件的網路連線。此技能不含指令碼,僅為說明文件。

The Clay Public API

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).

What it offers

  • Search — find people or companies in Clay's GTM database with advanced queries: criteria from the fields catalog, cross-entity filters, and nested Boolean logic. See the searches skill for search behavior and the CLI equivalent. Prefer the CLI for one-off searches.
  • Tables — structured queries against Clay tables.
  • Routines / batches — async routine and batch runs.

Auth

The 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:

bash
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.

Reference

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.

來源與署名

來源:clay-run/agent-plugins位於clay/skills/public-api提交769514a

授權條款: 無授權條款

內容歸原作者所有。SourceWeft 從公開儲存庫中收錄這些內容。

檢舉或申請下架