playbooks

Update Playbook

Update a playbook by creating a new version.

The current version is deactivated, and a new version is created with the updated fields. Unchanged fields carry over.

put/api/v1/playbooks/{playbook_id}

Request

  • Base URL: https://api.badgeia.com
  • URL: https://api.badgeia.com/api/v1/playbooks/{playbook_id}
  • Auth: none declared

Path parameters

playbook_idstring uuid required

Request body

namestring nullable
playbook_type'zero_shot' | 'few_shot' | 'chain_of_thought' | 'react' | 'custom'

Playbook archetypes for agent configuration.

system_promptstring nullable
modelstring nullable
temperaturenumber nullable
max_tokensinteger nullable
top_pnumber nullable
few_shot_examplesobject[] nullable
tools_configobject nullable
notesstring nullable
descriptionstring nullable
is_publicboolean nullable
pricing_model'free' | 'one_time'

How a Playbook is monetized in the Recruiting marketplace.

price_usd_centsinteger nullable

Response

Successful Response

idstring uuid required
agent_idstring uuid required
namestring required
versioninteger required
parent_idstring uuid nullable required
is_activeboolean required
is_defaultboolean required
is_publicboolean required
playbook_typestring required
system_promptstring nullable required
modelstring required
temperaturenumber required
max_tokensinteger required
top_pnumber required
few_shot_examplesobject[] nullable required
tools_configobject nullable required
notesstring nullable required
descriptionstring nullable
created_atstring date-time required
pricing_modelstring
price_usd_centsinteger
total_clonesinteger
total_revenue_usd_centsinteger
already_hiredboolean

Changes

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