Skillset Ability

Execute a skillset ability

Executes a specific ability from a skillset with the provided input. This endpoint processes the ability's instruction template using the given input and returns the execution result along with usage statistics. The response is streamed as JSON lines (JSONL) to support real-time progress updates during execution.

post/skillset/{skillsetId}/ability/{abilityId}/execute

Request

  • Base URL: https://api.chatbotkit.com/api/v1
  • URL: https://api.chatbotkit.com/api/v1/skillset/{skillsetId}/ability/{abilityId}/execute
  • Auth: HTTP bearer

Path parameters

skillsetIdstring required

The ID of the skillset containing the ability

abilityIdstring required

The ID of the ability to execute

Request body

inputstring

The input to process with the ability. This can be structured text such as JSON or YAML for precise parameter control, or unstructured natural language text. When unstructured text is provided, the system will automatically detect and extract the relevant parameters from the input.

contactIdstring

The ID of the contact to associate with the execution

Response

The ability was executed successfully

errorstring

Error message if execution failed

resultunknown

Changes

No recorded changes to this operation across all 1 revision of this API.