Skip to main content
Glama

Purchase Captions

purchase_captions
Destructive

Buy English captions for a Wistia media item using the account's saved credit card; confirm to place the order.

Instructions

This method is for purchasing English captions for a media. The request will charge the credit card on the account if successful. A saved credit card is required to use this endpoint.

Requires api token with one of the following permissions

Read, update & delete anything

Tokens with the "Act with a team member's permissions" permission (all:delegate_to_contact_permissions scope) can also be used. Requests made with such a token are authorized using the permissions of the contact assigned to the token. Requires confirm=true for the requested mutation. May share access, notify people or incur provider charges.

Input Schema

NameRequiredDescriptionDefault
rushNo
accountNoNamed private Wistia account; selects credentials, not a remote account ID.
confirmNoSet true only when the user asked for exactly this action.
payloadNoComplete JSON request body instead of body flags. Supports current nested customization, caption and nullable values.
automatedNo
payload_fileNoRegular local JSON body file, at most 5 MB. Cannot be mixed with body flags or payload.
media_hashed_idYesUnique identifier for the media.
automatically_enableNoAutomatically enable captions for the media once the order is ready or hold the captions for review before manually enabling.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed18 schema fields changedv3.0.0
    • addedInput schema / $defs
      Added value: +{
      +  "automated": {
      +    "default": false,
      +    "description": "Order computer-generated captions or human-reviewed ones. What each costs depends on the account's plan and billing settings; computer-generated captions are included at no cost on some plans and billed per minute on others.",
      +    "type": "boolean"
      +  },
      +  "rush": {
      +    "default": true,
      +    "description": "Enable rush order for one business day turnaround instead of the standard four, for human-reviewed captions only. Rush bills at the account's higher per-minute rate.",
      +    "type": "boolean"
      +  }
      +}
    • addedInput schema / properties / automated / $ref
      Added value: +"#/$defs/automated"
    • removedInput schema / properties / automated / default
      Removed value: -false
    • removedInput schema / properties / automated / description
      Removed value: -"Order computer-generated captions or human-reviewed ones. What each costs depends on the account's plan and billing settings; computer-generated captions are included at no cost on some plans and billed per minute on others."
    • removedInput schema / properties / automated / type
      Removed value: -"boolean"
    • changedInput schema / properties / confirm / description
      Previous value: -"Must be true for the specific user-requested write."New value: +"Set true only when the user asked for exactly this action."
    • addedInput schema / properties / payload / properties / automated / $ref
      Added value: +"#/$defs/automated"
    • removedInput schema / properties / payload / properties / automated / default
      Removed value: -false
    • removedInput schema / properties / payload / properties / automated / description
      Removed value: -"Order computer-generated captions or human-reviewed ones. What each costs depends on the account's plan and billing settings; computer-generated captions are included at no cost on some plans and billed per minute on others."
    • removedInput schema / properties / payload / properties / automated / type
      Removed value: -"boolean"
    • addedInput schema / properties / payload / properties / rush / $ref
      Added value: +"#/$defs/rush"
    • removedInput schema / properties / payload / properties / rush / default
      Removed value: -true
    • removedInput schema / properties / payload / properties / rush / description
      Removed value: -"Enable rush order for one business day turnaround instead of the standard four, for human-reviewed captions only. Rush bills at the account's higher per-minute rate."
    • removedInput schema / properties / payload / properties / rush / type
      Removed value: -"boolean"
    • addedInput schema / properties / rush / $ref
      Added value: +"#/$defs/rush"
    • removedInput schema / properties / rush / default
      Removed value: -true
    • removedInput schema / properties / rush / description
      Removed value: -"Enable rush order for one business day turnaround instead of the standard four, for human-reviewed captions only. Rush bills at the account's higher per-minute rate."
    • removedInput schema / properties / rush / type
      Removed value: -"boolean"
  2. First observedv2.0.0

TDQS

A4.1/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already flag destructive/openWorld/non-idempotent, but the description goes further: it discloses that the credit card on the account is charged on success, that a saved card must exist, the permission scopes accepted, delegation semantics, the confirm gate, and possible side effects (access sharing, notifications, provider charges). That is substantial context beyond the annotation set.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Purpose and the billing warning are front-loaded in the first sentence, which is exactly right. The permission block is boilerplate-ish but short and informative; nothing is redundant with the annotations.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For an 8-parameter, nested-object, destructive purchase with no output schema, the definition covers cost, auth, confirmation, and side effects well. It stops short of describing what a successful response yields (order/job identifier) that would let an agent chain into get_order_status, which is the main remaining gap.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 75%, so the schema already documents rush, automated, automatically_enable, payload_file, and account. The description only adds meaning for confirm ('required for the requested mutation'); it says nothing about rush pricing interplay, automated vs human-reviewed choice, or the payload/payload_file mutual exclusivity at the description level.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('purchasing English captions for a media'), a scope restriction (English only), and the key billing consequence. Clear purpose, but it never distinguishes itself from sibling ordering tools like create_captions, order_extended_audio_description, or bulk purchase variants.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives real prerequisites: a saved credit card is required, confirm=true is required for the mutation, and the exact permission scope needed (including delegated-token behavior). However it offers no guidance on when to choose this over create_captions or the bulk purchase tool, so exclusions and alternatives are absent.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools