Skip to content

Skills

List Skills

List skills in the organization.

Omit limit to get every skill; total is the full count either way.

Parameters

NameInTypeRequiredDescription
limitqueryintegernoMax rows to return (1-100). Omit to return every row.
offsetqueryintegernoRows to skip — pass the previous response’s next_offset.
org_idpathstring (uuid)yes
project_idquerystringnoFilter by project id, or ‘none’ for uncategorized skills.

Responses

StatusDescriptionBody
200Successful ResponsePage_SkillResponse_
422Validation ErrorHTTPValidationError

Create Skill

Create a new skill. Requires admin/owner role.

Parameters

NameInTypeRequiredDescription
org_idpathstring (uuid)yes

Request body (required)

FieldTypeRequiredDescription
descriptionstringno
instructionsstringyes
namestringyes
reference_materialstringno
slugstringno
tool_slugsstring[]no

Responses

StatusDescriptionBody
201Successful ResponseSkillResponse
422Validation ErrorHTTPValidationError

GET /api/orgs/{org_id}/skills/{id_or_slug}

Section titled “GET /api/orgs/{org_id}/skills/{id_or_slug}”

Get Skill

Get a skill by ID or slug, including active and draft revisions.

Parameters

NameInTypeRequiredDescription
id_or_slugpathstringyes
org_idpathstring (uuid)yes

Responses

StatusDescriptionBody
200Successful ResponseSkillResponse
422Validation ErrorHTTPValidationError

Update Skill

Update a skill. name/description update the parent; instructions/tool_slugs/reference_material go to a draft revision. Requires admin/owner role.

Parameters

NameInTypeRequiredDescription
org_idpathstring (uuid)yes
skill_idpathstring (uuid)yes

Request body (required)

FieldTypeRequiredDescription
descriptionstringno
instructionsstringno
namestringno
reference_materialstringno
tool_slugsstring[]no

Responses

StatusDescriptionBody
200Successful ResponseSkillResponse
422Validation ErrorHTTPValidationError

DELETE /api/orgs/{org_id}/skills/{skill_id}

Section titled “DELETE /api/orgs/{org_id}/skills/{skill_id}”

Delete Skill

Soft-delete a skill. Requires admin/owner role.

Parameters

NameInTypeRequiredDescription
org_idpathstring (uuid)yes
skill_idpathstring (uuid)yes

Responses

StatusDescriptionBody
204Successful Response
422Validation ErrorHTTPValidationError

POST /api/orgs/{org_id}/skills/{skill_id}/deploy

Section titled “POST /api/orgs/{org_id}/skills/{skill_id}/deploy”

Deploy Skill

Promote the draft revision to active. Requires admin/owner role.

Parameters

NameInTypeRequiredDescription
org_idpathstring (uuid)yes
skill_idpathstring (uuid)yes

Responses

StatusDescriptionBody
200Successful ResponseSkillResponse
422Validation ErrorHTTPValidationError

DELETE /api/orgs/{org_id}/skills/{skill_id}/draft

Section titled “DELETE /api/orgs/{org_id}/skills/{skill_id}/draft”

Discard Skill Draft

Discard the draft revision for a skill. Requires admin/owner role.

Parameters

NameInTypeRequiredDescription
org_idpathstring (uuid)yes
skill_idpathstring (uuid)yes

Responses

StatusDescriptionBody
200Successful ResponseSkillResponse
422Validation ErrorHTTPValidationError

GET /api/orgs/{org_id}/skills/{skill_id}/revisions

Section titled “GET /api/orgs/{org_id}/skills/{skill_id}/revisions”

List Skill Revisions

List all revisions for a skill, newest first.

Parameters

NameInTypeRequiredDescription
org_idpathstring (uuid)yes
skill_idpathstring (uuid)yes

Responses

StatusDescriptionBody
200Successful ResponseSkillRevisionResponse[]
422Validation ErrorHTTPValidationError

GET /api/orgs/{org_id}/skills/{skill_id}/usage

Section titled “GET /api/orgs/{org_id}/skills/{skill_id}/usage”

Get Skill Usage

List activation records for a skill, newest first.

Parameters

NameInTypeRequiredDescription
limitqueryintegerno
org_idpathstring (uuid)yes
skill_idpathstring (uuid)yes

Responses

StatusDescriptionBody
200Successful ResponseSkillActivationRecordResponse[]
422Validation ErrorHTTPValidationError