Skip to navigation

Register skill

View as Markdown

Registers a new Skill from an uploaded bundle and returns it with its id.

Upload the .zip or .skill bundle first with Upload file, using purpose CONFIGURATIONS_ASSISTANT_SKILL, then send the returned file id here as file_id within 24 hours. The Skill’s name, description and surfaces come from the bundle’s SKILL.md, so you don’t send them.

The bundle must meet the Skill bundle requirements.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Request

This endpoint expects an object.
file_idstringRequired>=1 character

The Files API id of a .zip or .skill bundle uploaded with purpose CONFIGURATIONS_ASSISTANT_SKILL. See Upload file. The upload is consumed when the Skill is registered, so responses never include file_id.

versionobjectRequired

The note to record with the new document. Don’t send num on create.

Response headers

x-trace-idstringOptional
A unique identifier used to trace your request within the Moveworks system

Response

The registered Skill
idstringRead-onlyformat: "uuid"

Unique identifier of the Skill, assigned by the server. Use it in a productivity assistant’s skill_ids.

namestringRead-only

Skill name from the bundle’s SKILL.md. Unique in your organization, and fixed once the Skill is created.

versionobject
The version of a stored document.
descriptionstringOptionalRead-only

Skill description from the bundle’s SKILL.md.

surfaceslist of stringsOptionalRead-only

Where the Skill is available, from the surfaces list in the bundle’s SKILL.md, for example slack. An empty list means everywhere.

updated_timedatetimeOptionalRead-only
When the Skill was last updated.
updated_bystringOptionalRead-only
Who last updated the Skill.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error