Start with the right entrypoint
Start with the right entrypoint: Quickstart, Context API, Reference, or OpenAPI.
One technical story, three reading surfaces
- 2-call mental model
- Docs / Reference / OpenAPI separation
- Agent-first entrypoint
- Docs explain concepts, paths, and integration strategy.
- Reference shows exact endpoints, fields, and schemas.
- OpenAPI powers SDKs, agents, and automation.
Start from the task, not the nav tree
Developers move faster when docs start from jobs to be done instead of a deep navigation tree.
Quickstart
Use the shortest path to auth, Context API, and the first agent workflow.
Context API
Treat it as the default entrypoint. Pull aggregated context first, then expand only when needed.
Agent Guides
See recommended 2-call and 3-call flows instead of assembling your own chain from scratch.
Separate docs, contracts, and discovery
This lets the homepage route people instead of compressing every audience into one view.
Docs
Concepts, paths, and best practices.
Reference
Inspect endpoints, schemas, and examples precisely.
OpenAPI
The authoritative source for SDKs, contract tests, and automation.
llms.txt
A lighter discovery surface for agents and tooling.
A good developer experience is more than a schema
Auth, error types, retry guidance, and webhook semantics should be clear from the start.
Authentication
Bearer keys, permission boundaries, and setup order.
Errors
Branch on structured error types, not on human-readable strings.
Webhooks
Move into event-driven sync when your workflow requires it.
If you try one endpoint, start with Context API
It is the default aggregated entrypoint and the fastest way to test whether the career context layer improves your product or agent.
curl "https://api.profileclaw.com/api/v1/context" -H "Authorization: Bearer $PROFILECLAW_API_KEY"If you try one endpoint, start with Context API
It is the default aggregated entrypoint and the fastest way to test whether the career context layer improves your product or agent.