Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Path Parameters

id
string
required

Agent id.

Minimum string length: 1
skillId
string
required

Stable skill id returned by the skills API.

Minimum string length: 1

Body

application/json
name
string

Human-readable name for the skill. Longer input is truncated to 120 characters and saved, not rejected. Whitespace is trimmed first, so a whitespace-only name is rejected as empty.

Required string length: 1 - 120
Pattern: \S
whenToUse
string
default:""

Plain-English trigger: when the agent should reach for this. Longer input is truncated to 300 characters and saved, not rejected.

Maximum string length: 300
enabled
boolean
default:true

Whether the skill is active on the agent. A disabled skill is kept but its tool is not installed.

instructions
string
Required string length: 1 - 12000
zips
string
Required string length: 1 - 4000
outOfAreaResponse
string
Maximum string length: 400
transferNumber
string
Required string length: 1 - 40
tags
string
Required string length: 1 - 1500
checkingMessage
string
Maximum string length: 200
expectedVersion
integer
Required range: x >= 0

Response

Skill updated.

success
boolean
required
version
integer
required
Required range: x >= 0
skill
Custom instruction skill · object
required

A plain-English playbook that teaches the agent when and how to handle a use case.

partialFailures
string[]

Background synchronization work that did not finish. The skill change was still saved.