Skills

Get a skill

Get a skill by slug, including its SKILL.md and the paths of its bundled documents.

get/skills/{slug}

Request

  • Base URL
    https://api.parley.so/v1
  • URL
    https://api.parley.so/v1/skills/{slug}
  • Auth
    HTTP bearer

Path parameters

slugstring required

The skill's slug.

Response

OK

idstring required

The skill ID.

slugstring 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.

namestring required

The skill name, from its SKILL.md.

descriptionstring required

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

scope'organization' | 'personal' required

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

activation'auto' | 'on-demand' 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 /<slug> in a message.

enabledboolean required

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

createdAtstring date-time required

When the skill was created.

updatedAtstring date-time required

When the skill was last changed.

contentstring required

The skill's SKILL.md: YAML frontmatter with its name and description, then the instructions.

filesstring[] required

The documents bundled with the skill, as paths from its folder, such as references/engagement-letter.docx. The skill's .skill archive holds them.

Changes

No recorded changes to this operation across all 2 revisions of this API.