Developer API
A read-only JSON catalog of every orb — param schema, colours, state presets, install command — for tools and agents. No authentication. Version 1.0.0, URL-prefixed at /api/v1/.
Endpoints
| Path | Summary | operationId |
|---|---|---|
| /api/v1/health | Health check | getHealth |
| /api/v1/components | List every orb | listComponents |
| /api/v1/components/{slug} | One orb with its full param schema and presets | getComponent |
| /llms.txt | Overview, chooser, props, catalog | getLlmsTxt |
| /agents.md | Agents page as markdown | getAgentsMd |
| /skill.md | Agent skill file | getSkill |
| /skill/recipes.md | Skill recipes | getSkillRecipes |
| /r/{name}.json | shadcn registry item | getRegistryItem |
| /r/registry.json | shadcn registry index | getRegistryIndex |
| /openapi.json | This OpenAPI document | getOpenApi |
The full contract is the OpenAPI document. Every response is JSON except the markdown files, which are text/markdown.
One orb
The per-orb document carries everything an agent needs to pass params, colors, statePresets and stateColorscorrectly: each param's key, range, step, default and whether it is a rate.
curl https://orbkit.zzzzshawn.cloud/api/v1/components/shdr-11
{
"slug": "shdr-11",
"name": "Shdr11",
"install": "npx shadcn@latest add @orbkit/shdr-11",
"params": [
{ "key": "speed", "label": "…", "min": 0.015, "max": 10, "step": 0.05, "default": 0.5, "integrate": true },
…
],
"colors": [ { "key": "…", "label": "…", "default": "#…" } ],
"statePresets": { "idle": { … }, "thinking": { … }, "speaking": { … } },
"stateColors": { … }
}Versioning
Version 1 lives under /api/v1/. Fields are only ever added; a breaking change would ship as /api/v2/ with the old version kept alive alongside it. The shadcn registry under /r/ is independent of the API and follows the shadcn registry schema.