HTTP API reference
Every endpoint of Probably's HTTP API, generated from its OpenAPI document: the permission each needs, its input fields and its answer.
Every tool is POST /api/v1/tools/ and its name, with the tool's input as a JSON body and an API key as a Bearer token (see Authentication). The answer is the tool's output as JSON, with status 200; a refusal answers with the status its outcome means and a body naming the outcome (see Errors). Events are GET /api/v1/events.
This reference is generated from the API's OpenAPI 3.1 document, the same contract the API serves, so it lists exactly the fields each endpoint takes and answers with. A key is offered only the tools its permissions cover; any other reads as 404.
Reads
Any connection or key may call these.
- This connection
POST /api/v1/tools/get_connection - List Spaces
POST /api/v1/tools/list_spaces - List videos
POST /api/v1/tools/list_videos - Get a delivered video's links
POST /api/v1/tools/get_media - Credit balance
POST /api/v1/tools/get_credits - Get a video
POST /api/v1/tools/get_video - Wait for a video to change
POST /api/v1/tools/wait_for_video - List formats
POST /api/v1/tools/list_formats - List personas
POST /api/v1/tools/list_personas - List products
POST /api/v1/tools/list_products - Get audience research
POST /api/v1/tools/get_audience_research - List segments
POST /api/v1/tools/list_segments - List campaigns
POST /api/v1/tools/list_campaigns - Get a campaign
POST /api/v1/tools/get_campaign - List library media
POST /api/v1/tools/list_assets - Read a pasted post
POST /api/v1/tools/read_link - Read a stage
POST /api/v1/tools/get_stage - List events
GET /api/v1/events
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.
- Create a Space
POST /api/v1/tools/create_space - Save a persona
POST /api/v1/tools/save_persona - Save a product
POST /api/v1/tools/save_product - Prepare audience research
POST /api/v1/tools/prepare_audience_research - Save segments
POST /api/v1/tools/save_segments - Plan a campaign
POST /api/v1/tools/plan_campaign - Change a campaign ad
POST /api/v1/tools/change_campaign_ad - Set a body's format
POST /api/v1/tools/set_body_format - Prepare a campaign batch
POST /api/v1/tools/prepare_campaign_batch - Prepare a segment's openings
POST /api/v1/tools/prepare_campaign_openings - Begin a results upload
POST /api/v1/tools/begin_results_upload - Import ad results
POST /api/v1/tools/import_ad_results - Save or discard a learning
POST /api/v1/tools/decide_learning - Plan the next batch
POST /api/v1/tools/plan_next_batch - Begin an upload
POST /api/v1/tools/begin_upload - Complete an upload
POST /api/v1/tools/complete_upload - Withdraw a queued instruction
POST /api/v1/tools/withdraw_instruction - Send a queued instruction now
POST /api/v1/tools/send_instruction_now - Stop a video
POST /api/v1/tools/stop_video - Approve a delivery
POST /api/v1/tools/approve_delivery - Discard a proposed change
POST /api/v1/tools/discard_change - Approve a video's voice
POST /api/v1/tools/approve_listen - Skip listening to a video's voice
POST /api/v1/tools/skip_listen - Keep a flagged word as it sounds
POST /api/v1/tools/keep_word - Approve a video's storyboard
POST /api/v1/tools/approve_storyboard - Skip a video's storyboard
POST /api/v1/tools/skip_storyboard - Message Looky
POST /api/v1/tools/send_message - Prepare a new video
POST /api/v1/tools/prepare_video - Prepare a new version
POST /api/v1/tools/prepare_regenerate - Prepare variants
POST /api/v1/tools/prepare_variants - Prepare to apply a change
POST /api/v1/tools/prepare_apply_change - Prepare research
POST /api/v1/tools/research - Prepare a brainstorm
POST /api/v1/tools/brainstorm - Prepare a script
POST /api/v1/tools/write_script - Prepare a review
POST /api/v1/tools/review - Prepare a clip
POST /api/v1/tools/generate_clip - Prepare recordings
POST /api/v1/tools/voice - Prepare a storyboard
POST /api/v1/tools/storyboard
Spending
A connection or key that may start paid work it prepared.
- Fix how a word is said
POST /api/v1/tools/fix_word - Confirm a spend
POST /api/v1/tools/confirm_spend