Skills

A Skill is a server-side function that runs against your EDM data and returns structured output. Skills handle common enterprise analysis tasks — access certification, licence waste detection, risk scoring — so you don’t have to build the logic yourself. Custom skills can also be registered and called the same way.

Skills run asynchronously. Every run call returns a Job handle; use sdk.jobs.wait() to retrieve the result.

List Available Skills

import { CpodClient } from '@cpod/sdk'
const sdk = CpodClient.fromEnv()
 
const skills = await sdk.skills.list()
for (const skill of skills.items) {
  console.log(skill.name, skill.description, skill.category)
}

from cpod import CpodClient
sdk = CpodClient.from_env()
 
skills = await sdk.skills.list()
for skill in skills.items:
    print(skill.name, skill.description, skill.category)

import "github.com/cpod-ai/cpod-sdk-go/skills"
 
client := cpod.New(os.Getenv("CPOD_API_KEY"))
 
result, err := client.Skills.List(ctx, nil)
for _, s := range result.Items {
    fmt.Println(s.Name, s.Description)
}

Get a Skill

// Get the schema + description for a skill before running it
const skill = await sdk.skills.get('access-review')
console.log(skill.inputSchema)   // JSON Schema for allowed inputs
console.log(skill.outputSchema)  // JSON Schema for the output

skill = await sdk.skills.get("access-review")
print(skill.input_schema)
print(skill.output_schema)

skill, err := client.Skills.Get(ctx, "access-review")
fmt.Println(skill.InputSchema)

Run a Skill

// Run the built-in access-review skill for an engineering group
const job = await sdk.skills.run('access-review', {
  groupId: 'grp-engineering',
  lookbackDays: 90,
})
// job.id     → "job-01HXYZ..."
// job.status → "queued"
 
// Wait for the result (blocks until done or timeout)
const result = await sdk.jobs.wait(job.id, { timeoutMs: 60_000 })
 
if (result.status === 'completed') {
  const output = result.output
  // output.unusedEntitlements → AccessEntitlement[]
  // output.riskySpreads       → { personId, entitlementCount }[]
  console.log(`Found ${output.unusedEntitlements.length} unused entitlements`)
}
 
// Run licence optimisation
const licJob = await sdk.skills.run('license-optimisation', {
  licenseId: 'lic-abc123',
})
const licResult = await sdk.jobs.wait(licJob.id)
// licResult.output.reclaimableSeats → number
// licResult.output.candidates       → Person[]

job = await sdk.skills.run("access-review", {
    "group_id": "grp-engineering",
    "lookback_days": 90,
})
 
result = await sdk.jobs.wait(job.id, timeout_ms=60_000)
 
if result.status == "completed":
    print(f"Found {len(result.output['unused_entitlements'])} unused entitlements")
 
lic_job = await sdk.skills.run("license-optimisation", {"license_id": "lic-abc123"})
lic_result = await sdk.jobs.wait(lic_job.id)

job, err := client.Skills.Run(ctx, "access-review", map[string]any{
    "groupId":      "grp-engineering",
    "lookbackDays": 90,
})
 
result, err := client.Jobs.Wait(ctx, job.ID, 60000)
if result.Status == "completed" {
    fmt.Printf("Output: %v\n", result.Output)
}

Get Skill Results

If you don’t want to block on jobs.wait(), poll the job directly:

const job = await sdk.jobs.get('job-01HXYZ')
// job.status → "queued" | "running" | "completed" | "failed"
// job.progress → 0–100
 
if (job.status === 'completed') {
  console.log(job.output)
} else if (job.status === 'failed') {
  console.error(job.error)
}

job = await sdk.jobs.get("job-01HXYZ")
 
if job.status == "completed":
    print(job.output)
elif job.status == "failed":
    print(job.error)

job, err := client.Jobs.Get(ctx, "job-01HXYZ")
if job.Status == "completed" {
    fmt.Println(job.Output)
}

Skill results are retained for 7 days. After that, jobs.get() returns 404. Store results you need long-term in sdk.storage.db or your own system.

Overview Workflows