Skills

List skills

get
/v1/{workspace_id}/skills/

List skills for a workspace with pagination. Optionally filter by enabled status. Requires Skill.view permission.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Query parameters
enabledany ofOptional
booleanOptional
or
nullOptional
execution_tierany ofOptional
stringOptional
or
nullOptional
sort_byany ofOptional
stringOptional
or
nullOptional
limitinteger · max: 20OptionalDefault: 10
continuation_tokenintegerOptionalDefault: 0
Responses
chevron-right
200

Successful Response

application/json
has_morebooleanRequired
continuation_tokenany ofOptional
integerOptional
or
nullOptional
get
/v1/{workspace_id}/skills/

Create a skill

post
/v1/{workspace_id}/skills/

Create a new companion agent skill in a workspace. Requires Skill.create permission.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Body
slugstringRequired
namestring · min: 1Required
descriptionstring · min: 1Required
system_promptany ofOptional
string · min: 1Optional
or
nullOptional
result_schemaany ofOptional
or
nullOptional
modelstringOptionalDefault: claude-sonnet-4-6
max_tokensintegerOptionalDefault: 4096
max_result_charsintegerOptionalDefault: 2000
max_input_tokensany ofOptional
integerOptional
or
nullOptional
timeout_snumberOptionalDefault: 60
thinking_effortany ofOptional
string · enumOptionalPossible values:
or
nullOptional
enable_cachingbooleanOptionalDefault: true
enable_citationsbooleanOptionalDefault: false
use_structured_outputbooleanOptionalDefault: false
deliverystring · enumOptionalDefault: interruptPossible values:
urgency_keywordsstring[]OptionalDefault: []
enabledbooleanOptionalDefault: true
execution_tierstring · enumOptionalDefault: orchestratedPossible values:
max_agent_turnsintegerOptionalDefault: 20
checkpoint_enabledbooleanOptionalDefault: true
approval_requiredbooleanOptionalDefault: false
browser_start_urlany ofOptional
stringOptional
or
nullOptional
browser_allowed_domainsstring[]OptionalDefault: []
browser_auth_integrationany ofOptional
stringOptional
or
nullOptional
Responses
post
/v1/{workspace_id}/skills/

Get a skill

get
/v1/{workspace_id}/skills/{skill_id}

Retrieve a skill by ID. Requires Skill.view permission.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
skill_idstring · uuidRequired
Responses
chevron-right
200

Successful Response

application/json
idstringRequired
workspace_idstringRequired
slugstringRequired
namestringRequired
descriptionstringRequired
system_promptstringRequired
result_schemaany ofRequired
or
nullOptional
modelstringRequired
max_tokensintegerRequired
max_result_charsintegerRequired
max_input_tokensany ofRequired
integerOptional
or
nullOptional
timeout_snumberRequired
thinking_effortany ofRequired
string · enumOptionalPossible values:
or
nullOptional
enable_cachingbooleanRequired
enable_citationsbooleanRequired
use_structured_outputbooleanRequired
deliverystring · enumRequiredPossible values:
urgency_keywordsstring[]Required
enabledbooleanRequired
execution_tierstring · enumRequiredPossible values:
max_agent_turnsintegerRequired
checkpoint_enabledbooleanRequired
approval_requiredbooleanRequired
browser_start_urlany ofRequired
stringOptional
or
nullOptional
browser_allowed_domainsstring[]Required
browser_auth_integrationany ofRequired
stringOptional
or
nullOptional
versionintegerRequired
created_atstring · date-timeRequired
updated_atstring · date-timeRequired
get
/v1/{workspace_id}/skills/{skill_id}

Update a skill

put
/v1/{workspace_id}/skills/{skill_id}

Update a skill's configuration. Increments version and creates an audit trail snapshot. Requires Skill.update permission.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
skill_idstring · uuidRequired
Body
nameany ofOptional
string · min: 1Optional
or
nullOptional
descriptionany ofOptional
string · min: 1Optional
or
nullOptional
system_promptany ofOptional
string · min: 1Optional
or
nullOptional
input_schemaany ofOptional
or
nullOptional
result_schemaany ofOptional
or
nullOptional
modelany ofOptional
stringOptional
or
nullOptional
max_tokensany ofOptional
integerOptional
or
nullOptional
max_result_charsany ofOptional
integerOptional
or
nullOptional
max_input_tokensany ofOptional
integerOptional
or
nullOptional
timeout_sany ofOptional
numberOptional
or
nullOptional
thinking_effortany ofOptional
string · enumOptionalPossible values:
or
nullOptional
enable_cachingany ofOptional
booleanOptional
or
nullOptional
enable_citationsany ofOptional
booleanOptional
or
nullOptional
use_structured_outputany ofOptional
booleanOptional
or
nullOptional
integration_toolsany ofOptional
or
nullOptional
static_toolsany ofOptional
or
nullOptional
deliveryany ofOptional
string · enumOptionalPossible values:
or
nullOptional
urgency_keywordsany ofOptional
string[]Optional
or
nullOptional
enabledany ofOptional
booleanOptional
or
nullOptional
execution_tierany ofOptional
string · enumOptionalPossible values:
or
nullOptional
max_agent_turnsany ofOptional
integerOptional
or
nullOptional
checkpoint_enabledany ofOptional
booleanOptional
or
nullOptional
approval_requiredany ofOptional
booleanOptional
or
nullOptional
browser_start_urlany ofOptional
stringOptional
or
nullOptional
browser_allowed_domainsany ofOptional
string[]Optional
or
nullOptional
browser_auth_integrationany ofOptional
stringOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
idstringRequired
workspace_idstringRequired
slugstringRequired
namestringRequired
descriptionstringRequired
system_promptstringRequired
result_schemaany ofRequired
or
nullOptional
modelstringRequired
max_tokensintegerRequired
max_result_charsintegerRequired
max_input_tokensany ofRequired
integerOptional
or
nullOptional
timeout_snumberRequired
thinking_effortany ofRequired
string · enumOptionalPossible values:
or
nullOptional
enable_cachingbooleanRequired
enable_citationsbooleanRequired
use_structured_outputbooleanRequired
deliverystring · enumRequiredPossible values:
urgency_keywordsstring[]Required
enabledbooleanRequired
execution_tierstring · enumRequiredPossible values:
max_agent_turnsintegerRequired
checkpoint_enabledbooleanRequired
approval_requiredbooleanRequired
browser_start_urlany ofRequired
stringOptional
or
nullOptional
browser_allowed_domainsstring[]Required
browser_auth_integrationany ofRequired
stringOptional
or
nullOptional
versionintegerRequired
created_atstring · date-timeRequired
updated_atstring · date-timeRequired
put
/v1/{workspace_id}/skills/{skill_id}

Delete a skill

delete
/v1/{workspace_id}/skills/{skill_id}

Delete a skill. SkillVersion audit trail is retained. Requires Skill.delete permission.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
skill_idstring · uuidRequired
Responses
delete
/v1/{workspace_id}/skills/{skill_id}

No content

Get skill references

get
/v1/{workspace_id}/skills/{skill_id}/references

Find all HSMs and services that reference this skill's slug in their latest version's tool_call_specs. Requires Skill.view permission.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
skill_idstring · uuidRequired
Responses
chevron-right
200

Successful Response

application/json
skill_idstringRequired
skill_slugstringRequired
service_referencesstring[]Required
get
/v1/{workspace_id}/skills/{skill_id}/references

Test a skill

post
/v1/{workspace_id}/skills/{skill_id}/test

Execute a skill in isolation with the given input.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
skill_idstring · uuidRequired
Body
Responses
chevron-right
200

Successful Response

application/json
resultstringRequired
duration_msnumberRequired
input_tokensintegerRequired
output_tokensintegerRequired
cached_tokensintegerRequired
roundsintegerRequired
errorany ofOptional
stringOptional
or
nullOptional
post
/v1/{workspace_id}/skills/{skill_id}/test

Last updated

Was this helpful?