playbooks

Create Playbook

Create a new playbook for an agent (v1).

post/api/v1/playbooks

Request

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

Request body

agent_idstring uuid required
namestring required
playbook_type'zero_shot' | 'few_shot' | 'chain_of_thought' | 'react' | 'custom'

Playbook archetypes for agent configuration.

system_promptstring nullable
modelstring
temperaturenumber
max_tokensinteger
top_pnumber
few_shot_examplesobject[] nullable
tools_configobject nullable
notesstring nullable
descriptionstring nullable

Public listing blurb shown on marketplace cards. REQUIRED (non-empty) when is_public=True — see routers/playbooks.py.

is_publicboolean
pricing_model'free' | 'one_time'

How a Playbook is monetized in the Recruiting marketplace.

price_usd_centsinteger

Hire price in USD cents. 0 == free. Max $100k. Integer only — money is NEVER Float.

Example request

{
  "name": "CoT-v1"
}

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.