start_session
Start PromptFax session
Use this first when a user wants to send or price a fax. PromptFax is built for irregular, pay-per-use outbound faxing: every real send requires a user-reviewed quote and Stripe payment authorization before transmission. MCP clients should set hostType to identify their host: chatgpt, claude, browser, or other. In ChatGPT, pass official files[] file parameters first when they are available so PromptFax can immediately import files[].download_url; never pass a raw file_id or local path as the document. The ChatGPT widget opens for destination entry, automatic quote creation, Stripe Checkout, status tracking, and Choose PDF from ChatGPT fallback when automatic attachment is unavailable or fails. If no document is attached, tell the user to attach a document in the widget. The widget does not provide a document preview step. Do not tell ChatGPT users to get a quote; after the widget has a document and valid destination, tell them to verify the price and use Pay & send when ready. Standards-compatible MCP Apps hosts use the inline PromptFax picker, and text-only clients use the hosted PromptFax session page or attach_document with a fetchable HTTPS URL. Do not call get_quote, checkout, or send_fax for a ChatGPT widget session unless the user explicitly asks for fallback behavior or the widget is unavailable. Use get_status only for a textual status refresh.
输入参数fileshostTypemetadatafaxNumbersessionIdhostCapabilities
attach_document
Attach fax document
Fallback/non-widget tool for binding a PromptFax document or one or more HTTPS PDF URLs into the current MCP session before requesting a quote. In ChatGPT widget sessions, prefer the widget's file controls after start_session instead of calling this tool unless the widget is unavailable or the user explicitly asks for fallback behavior.
输入参数fileUrlssessionId必填documentId
Fallback/non-widget tool for creating a user-reviewable pay-per-use fax quote when you have a fax number and either an MCP session, a PromptFax documentId, or one or more HTTPS PDF URLs. A quote is required before Stripe Checkout and before any real fax transmission. In ChatGPT widget sessions, do not call this after start_session because the widget auto-quotes once the document and destination are ready.
输入参数fileUrlsfaxNumbersessionIddocumentId
checkout
Open Stripe Checkout
Fallback/non-widget tool for starting external Stripe Checkout after the user accepts a pay-per-use quote. Payment authorization is required before PromptFax can send; PromptFax treats webhook-confirmed authorization, not browser redirect, as payment truth. In ChatGPT widget sessions, do not call this after start_session because the widget's Pay & send step opens Checkout.
输入参数sessionIdsendIntentIdautoSendAfterAuthorization
Fallback/non-widget tool for sending after payment is authorized and the user explicitly wants to send now. In ChatGPT widget sessions, do not call this after start_session unless the widget is unavailable or the user explicitly asks for fallback behavior.
输入参数sessionIdsendIntentId
Use this when you need the latest PromptFax workflow state, quote/payment state, or fax transmission status.
输入参数sessionIdsendIntentId
retry_failed_fax
Retry failed fax
Use this after a retry-eligible failed fax to queue another attempt under the existing authorization. You may supply a corrected destination.
输入参数faxNumbersessionIdsendIntentId
Use this when you need to cancel the active PromptFax send.
输入参数sessionIdsendIntentId
