{"openapi":"3.1.0","info":{"title":"Orbkit API","summary":"Every orb's param schema, colours and state presets, for agents that install and tune them.","description":"Public read API. Version 1 is URL-prefixed at /api/v1/. No authentication. Orb source files are copied with the shadcn CLI; this API describes them, it does not install them.","version":"1.0.0","license":{"name":"MIT","url":"https://github.com/zzzzshawn/orbkit/blob/main/LICENSE"},"contact":{"name":"zzzzshawn","url":"https://x.com/zzzzshawn/"}},"servers":[{"url":"https://orbkit.zzzzshawn.cloud","description":"Production"}],"tags":[{"name":"meta","description":"Health and API index."},{"name":"catalog","description":"Orb list and one orb."},{"name":"machine","description":"Skill, llms.txt, registry, OpenAPI."}],"paths":{"/api/v1":{"get":{"operationId":"getApiIndex","tags":["meta"],"summary":"API index","responses":{"200":{"description":"API index.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiIndex"}}}}}}},"/api/v1/health":{"get":{"operationId":"getHealth","tags":["meta"],"summary":"Health check","responses":{"200":{"description":"Healthy.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Health"}}}}}}},"/api/v1/components":{"get":{"operationId":"listComponents","tags":["catalog"],"summary":"List every orb","responses":{"200":{"description":"Every orb, summarized.","content":{"application/json":{"schema":{"type":"object","required":["components"],"properties":{"components":{"type":"array","items":{"$ref":"#/components/schemas/ComponentSummary"}}}}}}}}}},"/api/v1/components/{slug}":{"get":{"operationId":"getComponent","tags":["catalog"],"summary":"One orb with its full param schema and presets","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","example":"shdr-11"}}],"responses":{"200":{"description":"The orb.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Component"}}}},"404":{"description":"No such orb.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/llms.txt":{"get":{"operationId":"getLlmsTxt","tags":["machine"],"summary":"Overview, chooser, props, catalog","responses":{"200":{"description":"Markdown.","content":{"text/markdown":{"schema":{"type":"string"}}}}}}},"/agents.md":{"get":{"operationId":"getAgentsMd","tags":["machine"],"summary":"Agents page as markdown","responses":{"200":{"description":"Markdown.","content":{"text/markdown":{"schema":{"type":"string"}}}}}}},"/skill.md":{"get":{"operationId":"getSkill","tags":["machine"],"summary":"Agent skill file","responses":{"200":{"description":"Markdown with YAML frontmatter.","content":{"text/markdown":{"schema":{"type":"string"}}}}}}},"/skill/recipes.md":{"get":{"operationId":"getSkillRecipes","tags":["machine"],"summary":"Skill recipes","responses":{"200":{"description":"Markdown.","content":{"text/markdown":{"schema":{"type":"string"}}}}}}},"/r/{name}.json":{"get":{"operationId":"getRegistryItem","tags":["machine"],"summary":"shadcn registry item","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","example":"shdr-11"},"description":"An orb slug, `orbkit-core`, or `all`."}],"responses":{"200":{"description":"shadcn registry item JSON, including the source files.","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/openapi.json":{"get":{"operationId":"getOpenApi","tags":["machine"],"summary":"This document","responses":{"200":{"description":"OpenAPI 3.1.","content":{"application/json":{"schema":{"type":"object"}}}}}}}},"components":{"schemas":{"ApiIndex":{"type":"object","properties":{"version":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"openapi":{"type":"string","format":"uri"},"endpoints":{"type":"array","items":{"type":"object","properties":{"method":{"type":"string"},"path":{"type":"string"},"summary":{"type":"string"},"operationId":{"type":"string"}}}}}},"Health":{"type":"object","required":["status","version"],"properties":{"status":{"type":"string","enum":["ok"]},"version":{"type":"string"},"orbs":{"type":"integer"}}},"Param":{"type":"object","required":["key","label","min","max","step","default","integrate"],"properties":{"key":{"type":"string","description":"Pass this key through `params` or a `statePresets` entry."},"label":{"type":"string"},"min":{"type":"number"},"max":{"type":"number"},"step":{"type":"number"},"default":{"type":"number"},"integrate":{"type":"boolean","description":"A rate. The engine integrates it into a clock, so it sets speed, not phase."}}},"Color":{"type":"object","required":["key","label","default"],"properties":{"key":{"type":"string","description":"Pass this key through `colors` or a `stateColors` entry."},"label":{"type":"string"},"default":{"type":"string","description":"Hex colour."}}},"ComponentSummary":{"type":"object","required":["slug","name","title","note","description","docs","registry","install","paramCount","colorCount"],"properties":{"slug":{"type":"string","example":"shdr-11"},"name":{"type":"string","description":"React component name.","example":"Shdr11"},"title":{"type":"string"},"note":{"type":"string","description":"One-line look, lowercase."},"description":{"type":"string"},"docs":{"type":"string","format":"uri"},"registry":{"type":"string","format":"uri","description":"The shadcn registry item."},"install":{"type":"string","description":"shadcn CLI command."},"paramCount":{"type":"integer"},"colorCount":{"type":"integer"}}},"Component":{"allOf":[{"type":"object","required":["slug","name","title","note","description","docs","registry","install","paramCount","colorCount"],"properties":{"slug":{"type":"string","example":"shdr-11"},"name":{"type":"string","description":"React component name.","example":"Shdr11"},"title":{"type":"string"},"note":{"type":"string","description":"One-line look, lowercase."},"description":{"type":"string"},"docs":{"type":"string","format":"uri"},"registry":{"type":"string","format":"uri","description":"The shadcn registry item."},"install":{"type":"string","description":"shadcn CLI command."},"paramCount":{"type":"integer"},"colorCount":{"type":"integer"}}},{"type":"object","required":["installByUrl","file","importPath","dependencies","params","colors","statePresets","stateColors"],"properties":{"playground":{"type":"string","format":"uri"},"installByUrl":{"type":"string","description":"shadcn CLI command that needs no registry alias."},"file":{"type":"string","description":"Where the orb lands in the consumer project."},"importPath":{"type":"string"},"dependencies":{"type":"array","items":{"type":"string"}},"params":{"type":"array","items":{"$ref":"#/components/schemas/Param"}},"colors":{"type":"array","items":{"$ref":"#/components/schemas/Color"}},"statePresets":{"type":"object","description":"Per-state param targets the orb ships with, keyed idle / thinking / speaking.","additionalProperties":{"type":"object","additionalProperties":{"type":"number"}}},"stateColors":{"type":"object","description":"Per-state colours the orb ships with.","additionalProperties":{"type":"object","additionalProperties":{"type":"string"}}}}}]},"Problem":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"}}}}}}