Skip to navigation

Replace skill bundle

View as Markdown

Replaces a Skill’s bundle with a newly uploaded one and returns the updated Skill.

Upload the new bundle with Upload file first. file_id is the only field you can change: to change the description or surfaces, edit SKILL.md and upload a new bundle. The replacement must name the same Skill.

Replacing a bundle with identical contents changes nothing and returns the current Skill, so a retry is safe. version.num is checked before the bundle is replaced, but two replacements sent at the same moment with the same num can both succeed, and the later one is stored.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequiredformat: "uuid"

The id of the Skill, as returned when it was registered or listed.

Request

This endpoint expects an object.
versionobjectRequired
Document version. On update, send back the num from your last read.
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.

Response

The updated Skill, at its new version
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
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error