Skip to main content
POST
Run a skill

Authorizations

api_key
string
header
required

Path Parameters

key
string
required

The skill: a workspace skill's oId (skl_ prefix) or a catalog skill's name (deal-coach, meeting-prep, abm, …).

Required string length: 1 - 64
Example:

"deal-coach"

Body

application/json
request
string
default:""

What you want from the skill, in words: who or what it is about and any options. The skill's agent interprets it; for items, it applies to each.

Maximum string length: 8000
items
string[]

Run once per item (at most 200): each a line naming what that run is for ("acme.com", "jane@acme.com", "Acme renewal, crmo_…").

Required array length: 1 - 200 elements
Required string length: 1 - 2000
delivery
object

Where results go besides the callback: a Slack channel and/or an https webhook, as one digest when the run finishes or per item.

callbackUrl
string<uri>

POSTed the finished run (status, counts, credits, every item) once its last item settles.

idempotencyKey
string

A key for this run: a second call with it returns the same run.

Required string length: 1 - 120

Response

The run, queued

_metadata
object
required
run
object
required
started
boolean
required

False when an earlier run with the same idempotencyKey was returned instead of starting another.