ProfileClaw
Developer Docs

不要先记端点,先理解接入路径

ProfileClaw 文档首页的任务,不是把所有内容堆出来,而是让开发者第一时间知道从哪里开始:Quickstart、Context API、Reference,还是 OpenAPI。

一个技术故事,三种阅读表面

  • 2-call 心智模型
  • Docs / Reference / OpenAPI 分层
  • Agent-first 入口
  • Docs:解释概念、推荐路径与集成策略。
  • Reference:给人类精确查看契约和字段。
  • OpenAPI:给 SDK、agents 和自动化消费。
Start By Job

按任务开始,而不是按目录开始

开发者更容易从「我现在要做什么」开始,而不是从一棵很深的文档树开始。

Quickstart

用最短路径跑通认证、Context API 与第一个 agent 调用。

Context API

把它当成默认入口。先获取聚合上下文,再按需展开。

Agent Guides

看推荐的 2-call/3-call 工作流,而不是自己从零拼调用链。

Discovery Surfaces

把给人看的文档、给机器看的契约和给 agent 的发现入口拆开

这样首页的工作是分流,而不是把所有内容压成一个页面。

Docs

概念、路径、最佳实践。

Reference

精确查看端点、schema 与示例。

OpenAPI

自动化消费、SDK 生成与契约测试的权威源。

llms.txt

给 agent 和工具链一个更轻量的发现入口。

Reliability

稳定的开发者体验,不只是一份 schema

鉴权、错误类型、重试策略和 webhook 语义也应该一开始就被说明白。

Authentication

Bearer key、权限边界与接入顺序。

Errors

按 error type 分支,而不是依赖人类可读文本。

Webhooks

在需要事件驱动同步时进入 webhook 层。

如果你只试一个入口,就先试 Context API

它是默认聚合入口,最适合验证「职业上下文层」是否真的能提升你的产品或 agent。

Context API
1curl "https://api.profileclaw.com/api/v1/context" -H "Authorization: Bearer $PROFILECLAW_API_KEY"

如果你只试一个入口,就先试 Context API

它是默认聚合入口,最适合验证「职业上下文层」是否真的能提升你的产品或 agent。