trickroom / Docs
Sign in
API reference/skills

Edit a skill using its current version

Editing an approved skill adds a new approved revision and archives the old one; editing a proposed skill changes it in place. Stale versions return 409 skill_changed.

PUT/v1/applications/{id}/skills/{skillId}

Authorization

Authorizationstringrequired

Bearer tak_… — an application API key. Keep it on your backend; all resources are scoped to that application.

Create an application key →

Path parameters

idstringrequired

Min length: 1

skillIdstringrequired

Min length: 1

Body application/json

namestringrequired

Max length: 64 · Pattern: ^[a-z0-9]+(-[a-z0-9]+)*$

descriptionstringrequired

Min length: 1 · Max length: 1024

bodystringrequired

Min length: 1 · Max length: 20000

settingsobject

Default: {"connectors":{"required":[],"optional":[]},"approvals":[],"triggers":[]}

Object fields
connectorsobject

Default: {"required":[],"optional":[]}

Object fields
requiredarray<string | "computer">

Default: [] · Max items: 8

optionalarray<string | "computer">

Default: [] · Max items: 8

approvalsarray<string>

Default: [] · Max items: 12

triggersarray<object>

Default: [] · Max items: 5

Item fields
schedulestring

Max length: 100

eventstring

Max length: 100

descriptionstringrequired

Min length: 1 · Max length: 200

versionintegerrequired

Maximum: 9007199254740991

Response

200Edit a skill using its current version
X-Request-Idstring

Server-generated request identifier for logs and support.

application/json

idstringrequired

Min length: 1

application_idstringrequired

Min length: 1

namestringrequired
descriptionstringrequired
bodystring
settings_jsonobjectrequired
Object fields
connectorsobject

Default: {"required":[],"optional":[]}

Object fields
requiredarray<string | "computer">

Default: [] · Max items: 8

optionalarray<string | "computer">

Default: [] · Max items: 8

approvalsarray<string>

Default: [] · Max items: 12

triggersarray<object>

Default: [] · Max items: 5

Item fields
schedulestring

Max length: 100

eventstring

Max length: 100

descriptionstringrequired

Min length: 1 · Max length: 200

sourcestringrequired

Allowed: "pack""manual""reflection"

pack_idstring | nullrequired
statusstringrequired

Allowed: "proposed""approved""rejected""archived"

revision_ofstring | nullrequired
source_job_idstring | nullrequired
versionintegerrequired

Minimum: -9007199254740991 · Maximum: 9007199254740991

reviewed_atstring | nullrequired
created_atstringrequired

Format: date-time · Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

updated_atstringrequired

Format: date-time · Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

4XX400 invalid input; 401 missing/revoked credentials; 403 disallowed operation/application; 404 missing or inaccessible resource; 409 conflicting submission/version/state; 413 body too large; 415 unsupported content type. Inspect error.code, not message text.
X-Request-Idstring

Server-generated request identifier for logs and support.

application/json

errorobjectrequired
Object fields
codestringrequired
messagestringrequired
request_idstringrequired

Additional keys: any

5XX500 unexpected failure or 503 unavailable dependency. A failed response does not prove that a submission was not committed. Retry job/flow admission with the same key and body.
X-Request-Idstring

Server-generated request identifier for logs and support.

application/json

errorobjectrequired
Object fields
codestringrequired
messagestringrequired
request_idstringrequired

Additional keys: any