Oh Fax

Price a fax before committing to anything. Validates the destination and the document, counts pages, and returns an exact total plus a payment link. Free, and sends nothing. Always call this before send_fax.

{
  "type": "object",
  "properties": {
    "to": {
      "type": "string",
      "description": "Destination fax number. US and Canada only."
    },
    "document_url": {
      "description": "Publicly reachable URL of a PDF.",
      "type": "string"
    },
    "document_base64": {
      "description": "Base64-encoded PDF, as an alternative to document_url.",
      "type": "string"
    }
  },
  "required": [
    "to"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Returns the authorization instructions for sending a previously quoted fax. THIS ACTION COSTS MONEY AND CANNOT BE UNDONE: paying the returned link transmits a real document to a real fax machine. This tool itself does not charge you — it returns the exact price and a payment link, and the fax is only sent once you deliberately pay that link. Confirm the cost is acceptable before paying.

{
  "type": "object",
  "properties": {
    "quote_id": {
      "type": "string",
      "description": "A quote_id from quote_fax."
    }
  },
  "required": [
    "quote_id"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Current delivery state of a fax: awaiting_payment, paid, submitted, sending, delivered, or failed. Failed faxes include a reason you can act on.

{
  "type": "object",
  "properties": {
    "fax_id": {
      "type": "string"
    }
  },
  "required": [
    "fax_id"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Verifiable delivery receipt for a completed fax. Available once the fax has reached a final state. Use this to prove the workflow finished.

{
  "type": "object",
  "properties": {
    "fax_id": {
      "type": "string"
    }
  },
  "required": [
    "fax_id"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}