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 从公开仓库中收录这些内容。

举报或申请下架