Create a Playbook
create_playbookBuilds a Playbook for one competitor: a written summary of its stored ads with ideas to try against them. When credits would be charged it takes two steps: without confirm it returns a cost preview (idempotency_key, max_credits) and changes nothing; the same call with confirm: true and those two values starts the analysis and returns a playbook_id. With nothing to charge, the first call starts the analysis, or returns the current Playbook instead of rebuilding it. The analysis runs in the background and get_playbook shows the result. Does not start tracking.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"competitor_id": "<competitor_id>"
},
"name": "create_playbook"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| confirm | No | true starts the paid work shown in the cost preview. Absent or false returns that preview and spends nothing when credits would be charged; an action that costs no credits runs on this call. | |
| max_credits | No | max_credits from the cost preview, sent unchanged with confirm: true as the approved credit ceiling. A higher current price needs a new preview. | |
| competitor_id | Yes | Competitor id from list_competitors. | |
| idempotency_key | No | idempotency_key from the cost preview, needed with confirm: true and valid for 15 minutes. A repeat with the same key returns the first result without a second charge. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | No | Current progress or delivery state. | |
| billing_url | No | billing url value in this response. | |
| max_credits | No | Explicit credit ceiling to echo after the user approves this quote. | |
| playbook_id | No | playbook id value in this response. | |
| cost_credits | No | Credits quoted or charged by this operation. | |
| what_happens | No | Plain explanation of the proposed work, confirmation steps and quote expiry. | |
| enough_credits | No | enough credits value in this response. | |
| balance_credits | No | balance credits value in this response. | |
| idempotency_key | No | Key binding confirmation to this preview and preventing duplicate work. | |
| confirmation_required | No | True for a cost preview awaiting explicit approval. | |
| tracking_enabled_by_this_call | No | tracking enabled by this call value in this response. |