Skip to main content
PATCH
Update a skill

Authorizations

Authorization
string
header
required

A Parley API key.

Path Parameters

slug
string
required

The skill's slug.

Maximum string length: 64
Pattern: ^[a-z0-9][a-z0-9-]*$

Body

application/json
content
string

The skill's SKILL.md, which replaces the current one and keeps the bundled documents: YAML frontmatter with a name (up to 120 characters) and a description (up to 2,000), then the instructions in markdown, 100,000 characters in all. For an auto skill, the description is what the assistant matches tasks against, so say when to use it. Refer to a bundled document by its path, such as references/engagement-letter.docx.

Maximum string length: 100000
uploadId
string

The id of an upload, once its bytes have been PUT to its url, holding the whole skill, which replaces everything it holds: a .skill or .zip archive with SKILL.md at its root or inside one top-level folder, plus any documents under references/ (pdf, doc, docx, md, txt, json, csv, html, pptx, xls, xlsx; up to 100 files and 25 MB), or a single .md file used as SKILL.md. A manifest.yaml in the archive is ignored.

Minimum string length: 1
activation
enum<string>

When the skill is used. auto: Parley's assistant uses it whenever its description fits the task. on-demand: only when someone runs it, from a project's Run Skill list or by typing / in a message.

Available options:
auto,
on-demand
enabled
boolean

Turn the skill on or off.

Response

OK

id
string
required

The skill ID.

Minimum string length: 1
slug
string
required

The skill's folder name, chosen when the skill is created. It is how the skill is addressed, and the name the assistant loads it by.

name
string
required

The skill name, from its SKILL.md.

description
string
required

What the skill is for, from its SKILL.md.

scope
enum<string>
required

Who can use the skill. organization: everyone in the organization. personal: only the person who created it.

Available options:
organization,
personal
activation
enum<string>
required

When the skill is used. auto: Parley's assistant uses it whenever its description fits the task. on-demand: only when someone runs it, from a project's Run Skill list or by typing / in a message.

Available options:
auto,
on-demand
enabled
boolean
required

Whether the skill is on. Parley never uses a skill that is off.

createdAt
string<date-time>
required

When the skill was created.

updatedAt
string<date-time>
required

When the skill was last changed.