Skills
8 methods on the Skills resource.
8 methods · 0 available to app tokens36 pages in SDK Reference
import { Compozy } from "@compozy/client";8 of 8
disableSkill
Disable one skill
compozy.skills.disableSkill({ path, query }) → Promise<SkillActionResponse>
Options
- namestringpathrequired
- Skill name
- workspacestringquery
- Workspace id or path for resolution context
- profilestringquery
- Exact profile name
- for_agentstringquery
- Logical agent name for agent-local resolution
POST /api/skills/{name}/disableapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.skills.disableSkill({ path: { "name": "name" } });enableSkill
Enable one skill
compozy.skills.enableSkill({ path, query }) → Promise<SkillActionResponse>
Options
- namestringpathrequired
- Skill name
- workspacestringquery
- Workspace id or path for resolution context
- profilestringquery
- Exact profile name
- for_agentstringquery
- Logical agent name for agent-local resolution
POST /api/skills/{name}/enableapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.skills.enableSkill({ path: { "name": "name" } });exposeSkill
Expose one user- or workspace-owned skill to provider roots
compozy.skills.exposeSkill({ path, query, body }) → Promise<SkillExposeResponse>
Options
- namestringpathrequired
- Skill name
- profilestringquery
- Exact acting profile name
- for_agentstringquery
- Logical agent name for agent-local resolution
Request bodySkillExposureRequest
POST /api/skills/{name}/exposeapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.skills.exposeSkill({ path: { "name": "name" }, body: { /* request fields */ } });getSkill
Get one skill definition
compozy.skills.getSkill({ path, query }) → Promise<SkillResponse>
Options
- namestringpathrequired
- Skill name
- workspace_idstringquery
- Canonical workspace id for resolution context
- profilestringquery
- Exact profile name
- for_agentstringquery
- Logical agent name for agent-local resolution
GET /api/skills/{name}app tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.skills.getSkill({ path: { "name": "name" } });getSkillContent
Get the raw content for one skill
compozy.skills.getSkillContent({ path, query }) → Promise<SkillContentResponse>
Options
- namestringpathrequired
- Skill name
- workspacestringquery
- Workspace id or path for resolution context
- profilestringquery
- Exact profile name
- for_agentstringquery
- Logical agent name for agent-local resolution
GET /api/skills/{name}/contentapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.skills.getSkillContent({ path: { "name": "name" } });getSkillShadows
Get resolver provenance and shadow declarations for one skill
compozy.skills.getSkillShadows({ path, query }) → Promise<SkillShadowsResponse>
Options
- namestringpathrequired
- Skill name
- workspacestringquery
- Workspace id or path for resolution context
- profilestringquery
- Exact profile name
- for_agentstringquery
- Logical agent name for agent-local resolution
GET /api/skills/{name}/shadowsapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.skills.getSkillShadows({ path: { "name": "name" } });listSkills
List effective skills for the selected global, workspace, or agent scope
compozy.skills.listSkills({ query }) → Promise<SkillsResponse>
Options
- workspacestringquery
- Workspace id or path for resolution context
- profilestringquery
- Exact profile name
- for_agentstringquery
- Logical agent name for agent-local resolution
GET /api/skillsapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.skills.listSkills();unexposeSkill
Remove owned provider-root links for one skill
compozy.skills.unexposeSkill({ path, query, body }) → Promise<SkillUnexposeResponse>
Options
- namestringpathrequired
- Skill name
- profilestringquery
- Exact acting profile name
- for_agentstringquery
- Logical agent name for agent-local resolution
Request bodySkillExposureRequest
POST /api/skills/{name}/unexposeapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.skills.unexposeSkill({ path: { "name": "name" }, body: { /* request fields */ } });