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

Files API id of the uploaded .zip or .skill bundle (purpose CONFIGURATIONS_ASSISTANT_SKILL). Required on create; on update it replaces the bundle. Write-only: the staged upload is consumed on registration and expires, so reads never return a file_id.

versionobjectRequired
Document version. On update, send back the num from your last read.

Response

The registered Skill
idstringOptionalRead-only
Unique identifier of this skill, assigned by the server.
file_idstringOptional>=1 character

Files API id of the uploaded .zip or .skill bundle (purpose CONFIGURATIONS_ASSISTANT_SKILL). Required on create; on update it replaces the bundle. Write-only: the staged upload is consumed on registration and expires, so reads never return a file_id.

namestringOptionalRead-only
Skill name from the bundle's SKILL.md. Unique within the organization and fixed after creation.
descriptionstringOptionalRead-only
Skill description from the bundle's SKILL.md.
surfaceslist of stringsOptionalRead-only

Surfaces the skill is available on, from the bundle’s SKILL.md (e.g. slack, movewebchat:assistant). Empty means every surface.

updated_timedatetimeOptionalRead-only
When the skill was last updated.
updated_bystringOptionalRead-only
Who last updated the skill.
versionobjectOptional
Document version. On update, send back the num from your last read.

Errors

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