Probably
Start free
Docs

Set a body's format

set_body_format, in Changes: A connection or key that may make changes. None spends credits; prepare_* and stage tools (research, brainstorm, write_script, review, generate_clip, voice, storyboard) prepare paid work for confirm_spend.

POST
/api/v1/tools/set_body_format

Choose the built-in format a segment's body follows in a batch still being planned; its openings keep it. Testimonial unless changed.

Authorization

apiKey
headerAuthorizationBearer <token>

An API key (prb_…) from Settings → Connections.

Request Body

application/json
  1. body
batchId*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
segmentRecordId*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
format*string
Value in"testimonial""try-on""unboxing""tutorial""get-ready""before-after""demo""street-interview""jumpcuts""greenscreen""montage""what-if""game-ad""software-ad""showcase"

Response Body

The tool's answer.

application/json
  1. response
batchId*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
curl -X POST 'https://studio.probably.co/api/v1/tools/set_body_format' \  -H "Authorization: Bearer $PROBABLY_API_KEY" \  -H 'Content-Type: application/json' \  -d '{  "batchId": "5579c111-9c50-47e2-af92-f16d52e63189",  "segmentRecordId": "7c9e4c93-9d9c-4ce1-9332-2ecfa0336ccf",  "format": "testimonial"}'
{  "batchId": "5579c111-9c50-47e2-af92-f16d52e63189"}