Skip to content
OpenGTM

Patch Playbook

PATCH
/api/research-playbooks/{playbook_id}
curl --request PATCH \
  --url http://localhost:8000/api/research-playbooks/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "cell_budget_usd": 1, "description": "example", "enabled": true, "max_steps": 1, "name": "example", "output_format": "example", "prompt_template": "example", "schedule_audience_id": "example", "schedule_interval_minutes": 1, "steps": [ { "key": "example", "name": "example", "output_format": "text", "prompt_template": "example" } ] }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
playbook_id
required
Playbook Id
string

Header Parameters

Section titled “Header Parameters”
x-workspace-id
Any of:
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
PlaybookPatch
object
cell_budget_usd
Any of:
number
> 0 <= 5
description
Any of:
string
<= 2000 characters
enabled
Any of:
boolean
max_steps
Any of:
integer
>= 1 <= 8
name
Any of:
string
>= 1 characters <= 200 characters
output_format
Any of:
string
prompt_template
Any of:
string
>= 10 characters <= 20000 characters
schedule_audience_id
Any of:
string
schedule_interval_minutes
Any of:
integer
>= 15 <= 10080
steps
Any of:
Array<object>
<= 8 items
PlaybookStep
object
key
required
Key
string
/^[a-z][a-z0-9_]{0,39}$/
name
required
Name
string
>= 1 characters <= 100 characters
output_format
Output Format
string
default: text
prompt_template
required
Prompt Template
string
>= 10 characters <= 20000 characters

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Examplegenerated
example

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}