OpenAPI Reference
Playbooks
The skills and custom node prompts this space already defines for a job. Call `POST /api/v1/playbooks/search` first on every instruction with a few phrasings of the intent; open a hit with `GET /api/v1/playbooks/{kind}/{nodeId}` and follow it.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/api/v1/playbooks/search" \ -H "Content-Type: application/json" \ -d '{}'{ "items": [ { "kind": "skill", "nodeId": "string", "nodeType": "string", "nodeName": "string", "nodeSlug": "string", "path": [ "string" ], "key": "string", "label": "string", "intent": "read-only", "name": "string", "description": "string", "matchedOn": [ "name" ], "score": 0, "updatedAt": "string" } ], "total": -9007199254740991, "truncated": true, "coverage": { "skillsScanned": -9007199254740991, "promptNodesScanned": -9007199254740991 }}Path Parameters
kind*string
Value in
- "skill"
- "prompt"
nodeId*string
Length
1 <= lengthQuery Parameters
key?string
Required for a prompt: the key from playbooks.search.
Length
1 <= lengthlocale?string
Locale for the prompt label and rendered body, e.g. "en" or "zh-CN" — pass the user's. Without one (or with a locale the dashboard does not speak) the body is rendered in English and its footer says "Reply in the user's language." instead of naming a language.
Length
1 <= length <= 20Response Body
application/json
curl -X GET "https://example.com/api/v1/playbooks/skill/string"{ "kind": "skill", "nodeId": "string", "nodeType": "string", "nodeName": "string", "nodeSlug": "string", "path": [ "string" ], "content": "string", "key": "string", "label": "string", "intent": "read-only", "locale": "string", "name": "string", "description": "string", "files": [ { "path": "string", "size": 0, "mimeType": "string" } ]}