Skills

Workspace API

---

Workspace API / models/Skills

models/Skills

Interfaces

SkillVersionSummary

Defined in: models/Skills.ts:296

Properties

skill_version_id

skill_version_id: string

Defined in: models/Skills.ts:297

version

version: string

Defined in: models/Skills.ts:298

status

status: string

Defined in: models/Skills.ts:299

is_active

is_active: boolean

Defined in: models/Skills.ts:300

---

CreateWorkflowRunParams

Defined in: models/Skills.ts:499

Parameters for creating a workflow run

Properties

runId

runId: string

Defined in: models/Skills.ts:500

traceId

traceId: string

Defined in: models/Skills.ts:501

organizationId

organizationId: string

Defined in: models/Skills.ts:502

userId

userId: string

Defined in: models/Skills.ts:503

conversationId?

optional conversationId: string

Defined in: models/Skills.ts:504

skillId

skillId: string

Defined in: models/Skills.ts:505

skillVersionId

skillVersionId: string

Defined in: models/Skills.ts:506

manifestHash

manifestHash: string

Defined in: models/Skills.ts:507

idempotencyKey

idempotencyKey: string

Defined in: models/Skills.ts:508

inputs

inputs: Record<string, unknown>

Defined in: models/Skills.ts:509

inputHash

inputHash: string

Defined in: models/Skills.ts:510

---

CreateStepRunParams

Defined in: models/Skills.ts:681

Parameters for creating a workflow step run

Properties

runId

runId: string

Defined in: models/Skills.ts:682

stepIndex

stepIndex: number

Defined in: models/Skills.ts:683

stepKey

stepKey: string

Defined in: models/Skills.ts:684

stepType

stepType: WorkflowStepType

Defined in: models/Skills.ts:685

---

CreateAuditLogParams

Defined in: models/Skills.ts:756

Parameters for creating an audit log entry

Properties

auditId

auditId: string

Defined in: models/Skills.ts:757

traceId

traceId: string

Defined in: models/Skills.ts:758

runId

runId: string

Defined in: models/Skills.ts:759

organizationId

organizationId: string

Defined in: models/Skills.ts:760

userId

userId: string

Defined in: models/Skills.ts:761

skillId

skillId: string

Defined in: models/Skills.ts:762

skillVersionId

skillVersionId: string

Defined in: models/Skills.ts:763

manifestHash

manifestHash: string

Defined in: models/Skills.ts:764

approvalTimestamp

approvalTimestamp: Date

Defined in: models/Skills.ts:765

inputHash

inputHash: string

Defined in: models/Skills.ts:766

outputHash?

optional outputHash: string

Defined in: models/Skills.ts:767

stepHashes?

optional stepHashes: object[]

Defined in: models/Skills.ts:768

step_index

step_index: number

output_hash

output_hash: string

toolCalls?

optional toolCalls: object[]

Defined in: models/Skills.ts:769

tool

tool: string

args_hash

args_hash: string

result_hash

result_hash: string

finalStatus

finalStatus: WorkflowStatus

Defined in: models/Skills.ts:770

errorCode?

optional errorCode: string

Defined in: models/Skills.ts:771

totalDurationMs?

optional totalDurationMs: number

Defined in: models/Skills.ts:772

---

WorkflowRunRecord

Defined in: models/Skills.ts:832

Properties

runId

runId: string

Defined in: models/Skills.ts:833

traceId

traceId: string

Defined in: models/Skills.ts:834

organizationId

organizationId: string

Defined in: models/Skills.ts:835

userId

userId: string

Defined in: models/Skills.ts:836

conversationId?

optional conversationId: string

Defined in: models/Skills.ts:837

skillId

skillId: string

Defined in: models/Skills.ts:838

skillVersionId

skillVersionId: string

Defined in: models/Skills.ts:839

manifestHash

manifestHash: string

Defined in: models/Skills.ts:840

idempotencyKey

idempotencyKey: string

Defined in: models/Skills.ts:841

status

status: WorkflowStatus

Defined in: models/Skills.ts:842

currentStepIndex

currentStepIndex: number

Defined in: models/Skills.ts:843

inputs

inputs: Record<string, unknown>

Defined in: models/Skills.ts:844

inputHash

inputHash: string

Defined in: models/Skills.ts:845

outputs?

optional outputs: Record<string, unknown>

Defined in: models/Skills.ts:846

outputHash?

optional outputHash: string

Defined in: models/Skills.ts:847

approvalTimestamp?

optional approvalTimestamp: Date

Defined in: models/Skills.ts:848

errorCode?

optional errorCode: string

Defined in: models/Skills.ts:849

errorMessage?

optional errorMessage: string

Defined in: models/Skills.ts:850

errorStepKey?

optional errorStepKey: string

Defined in: models/Skills.ts:851

isRetryable

isRetryable: boolean

Defined in: models/Skills.ts:852

stepCount

stepCount: number

Defined in: models/Skills.ts:853

toolCallCount

toolCallCount: number

Defined in: models/Skills.ts:854

totalDurationMs?

optional totalDurationMs: number

Defined in: models/Skills.ts:855

createdAt

createdAt: Date

Defined in: models/Skills.ts:856

startedAt?

optional startedAt: Date

Defined in: models/Skills.ts:857

completedAt?

optional completedAt: Date

Defined in: models/Skills.ts:858

Functions

getDomainPacks()

getDomainPacks(userId, organizationId): Promise<DomainPack[]>

Defined in: models/Skills.ts:29

Get all active domain packs for an organization (including system packs)

Parameters

userId

string

organizationId

string

Returns

Promise<DomainPack[]>

---

getDomainPackByKey()

getDomainPackByKey(userId, domainKey, organizationId): Promise<DomainPack | null>

Defined in: models/Skills.ts:58

Get a domain pack by key

Parameters

userId

string

domainKey

string

organizationId

string

Returns

Promise<DomainPack | null>

---

getSkills()

getSkills(userId, organizationId): Promise<Skill[]>

Defined in: models/Skills.ts:96

Get all active skills for an organization

Parameters

userId

string

organizationId

string

Returns

Promise<Skill[]>

---

getSkillByKey()

getSkillByKey(userId, skillKey, organizationId): Promise<Skill | null>

Defined in: models/Skills.ts:125

Get a skill by key

Parameters

userId

string

skillKey

string

organizationId

string

Returns

Promise<Skill | null>

---

getSkillById()

getSkillById(userId, organizationId, skillId): Promise<Skill | null>

Defined in: models/Skills.ts:159

Get a skill by ID

Parameters

userId

string

organizationId

string

skillId

string

Returns

Promise<Skill | null>

---

getSkillsByOrganization()

getSkillsByOrganization(userId, organizationId, options?): Promise<Skill & object[]>

Defined in: models/Skills.ts:192

Get skills by organization with optional filters

Parameters

userId

string

organizationId

string

options?

domainKey?

string

status?

string

Returns

Promise<Skill & object[]>

---

getSkillVersionsBySkillId()

getSkillVersionsBySkillId(userId, organizationId, skillId, status?): Promise<SkillVersion[]>

Defined in: models/Skills.ts:306

Get skill versions by skill ID

Parameters

userId

string

organizationId

string

skillId

string

status?

string

Returns

Promise<SkillVersion[]>

---

getActiveSkillVersion()

getActiveSkillVersion(skillKey, userId, organizationId): Promise<SkillVersion | null>

Defined in: models/Skills.ts:364

Get the active version of a skill

Parameters

skillKey

string

userId

string

organizationId

string

Returns

Promise<SkillVersion | null>

---

getSkillVersionById()

getSkillVersionById(userId, organizationId, skillVersionId): Promise<SkillVersion | null>

Defined in: models/Skills.ts:412

Get a skill version by ID

Parameters

userId

string

organizationId

string

skillVersionId

string

Returns

Promise<SkillVersion | null>

---

getSkillVersions()

getSkillVersions(userId, organizationId, skillId): Promise<SkillVersion[]>

Defined in: models/Skills.ts:455

Get all versions of a skill

Parameters

userId

string

organizationId

string

skillId

string

Returns

Promise<SkillVersion[]>

---

createWorkflowRun()

createWorkflowRun(params): Promise<{ runId: string; created: boolean; }>

Defined in: models/Skills.ts:516

Create a new workflow run

Parameters

params

CreateWorkflowRunParams

Returns

Promise<{ runId: string; created: boolean; }>

---

updateWorkflowRunStatus()

updateWorkflowRunStatus(userId, organizationId, runId, status, updates?): Promise<void>

Defined in: models/Skills.ts:568

Update workflow run status

Parameters

userId

string

organizationId

string

runId

string

status

WorkflowStatus

updates?

currentStepIndex?

number

outputs?

Record<string, unknown>

outputHash?

string

errorCode?

string

errorMessage?

string

errorStepKey?

string

isRetryable?

boolean

stepCount?

number

toolCallCount?

number

totalDurationMs?

number

Returns

Promise<void>

---

getWorkflowRun()

getWorkflowRun(userId, organizationId, runId): Promise<WorkflowRunRecord | null>

Defined in: models/Skills.ts:662

Get workflow run by ID

Parameters

userId

string

organizationId

string

runId

string

Returns

Promise<WorkflowRunRecord | null>

---

createStepRun()

createStepRun(userId, organizationId, params): Promise<string>

Defined in: models/Skills.ts:691

Create a step run record

Parameters

userId

string

organizationId

string

params

CreateStepRunParams

Returns

Promise<string>

---

updateStepRunCompleted()

updateStepRunCompleted(userId, organizationId, stepRunId, updates): Promise<void>

Defined in: models/Skills.ts:711

Update step run completion

Parameters

userId

string

organizationId

string

stepRunId

string

updates

status

WorkflowStatus

outputKey?

string

outputPreview?

string

outputHash?

string

durationMs?

number

errorCode?

string

errorMessage?

string

Returns

Promise<void>

---

createAuditLog()

createAuditLog(params): Promise<void>

Defined in: models/Skills.ts:778

Create audit log entry

Parameters

params

CreateAuditLogParams

Returns

Promise<void>