Fax for Agents

Fax for Agents API

A fax API built for AI agents. Keys: Authorization: Bearer ffa_test_... (test mode) or ffa_live_..., or the same key in X-API-Key. Each operation lists the…

Communication#phone

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

A fax API built for AI agents. Keys: Authorization: Bearer ffa_test_... (test mode) or ffa_live_..., or the same key in X-API-Key. Each operation lists the credentials it takes under security and the scope it asks for in x-required-scope. An operation with an empty security list takes no credential. Every error is one envelope: error.code, error.message, error.retryable, error.correlation_id. OAuth access tokens of the hosted MCP server are not accepted here.

Endpoints 194

agents

  • GETList agent identities/v1/agents
  • POSTRegister an agent identity/v1/agents
  • GETRead an agent with its keys and budgets/v1/agents/:agent_id
  • DELETEArchive an agent: its keys are revoked, it leaves the list and its name is free again/v1/agents/:agent_id
  • PATCHChange an agent; disabling revokes its keys/v1/agents/:agent_id
  • GETThe agent's audit trail/v1/agents/:agent_id/activity
  • POSTCreate a key for the agent (bounded scopes, secret shown once)/v1/agents/:agent_id/keys

identity

  • GETList API keys (metadata only)/v1/api-keys
  • POSTCreate an API key (the secret is shown once)/v1/api-keys
  • DELETERevoke a key/v1/api-keys/:key_id
  • POSTRotate an API key and preserve its expiry/v1/api-keys/:key_id/rotateThe replacement keeps the original expires_at, including no expiry. The old secret works for up to 24 hours, capped by its existing expiry. Once a key…
  • GETWho am I/v1/me

approvals

  • GETApproval requests, pending first/v1/approval-requests
  • POSTAsk a human to approve a quoted send, or ask for help (grants nothing)/v1/approval-requests
  • GETRead one request/v1/approval-requests/:approval_id
  • POSTApprove the bound quote (approval:decide, fresh session or independent API credential)/v1/approval-requests/:approval_id/approve
  • POSTReject with a reason (a help request closes without one)/v1/approval-requests/:approval_id/reject
  • POSTRevoke an approval nobody has used yet/v1/approvals/:approval_id/revoke
  • GETGet Integration Review/v1/integration-reviews/:org_id/:environment/:operation_id/:binding_id

auth

  • GETWhat an invitation link offers, before joining (the link is the credential)/v1/auth/invitations/:tokenNo session is needed: the token in the link is the credential, as it is in the mail. A link that was used, withdrawn, has expired or never existed answers the…
  • POSTJoin the organization an invitation link names (the signed-in email must match)/v1/auth/invitations/:token/accept
  • POSTLeave an organization you belong to/v1/auth/leave-organizationEnds your membership of the organization org_id names, at once: you can no longer open it, and your connected apps in it are disconnected. Anyone can leave…
  • POSTEnd this session/v1/auth/logoutIdempotency-Key is accepted but ignored for this session-only authentication action. Repeated requests do not create customer resources or charges.…
  • POSTSend a sign-in link to an email address (always 202)/v1/auth/magic-linksIdempotency-Key is accepted but ignored for this session-only authentication action. Repeated requests do not create customer resources or charges.…
  • GETOpen a sign-in link: sets the session cookie and redirects to the app/v1/auth/magic-links/:token
  • GETThe signed-in person, their organizations and the CSRF token/v1/auth/me
  • POSTMark the notices in `me.notices` as read/v1/auth/notices/dismissIdempotency-Key is accepted but ignored for this session-only authentication action. Repeated requests do not create customer resources or charges.…
  • GETFinish GitHub or Google sign-in (the app forwards its /auth/{provider}/callback here)/v1/auth/oauth/:provider/callback
  • GETBegin GitHub or Google sign-in (redirects to the provider)/v1/auth/oauth/:provider/start
  • GETYour passkeys/v1/auth/passkeys
  • POSTOptions for navigator.credentials.get() (discoverable, no email needed)/v1/auth/passkeys/login/optionsIdempotency-Key is accepted but ignored for this session-only authentication action. Repeated requests do not create customer resources or charges.…
  • POSTSign in with a passkey assertion/v1/auth/passkeys/login/verifyIdempotency-Key is accepted but ignored for this session-only authentication action. Repeated requests do not create customer resources or charges.…
  • POSTOptions for navigator.credentials.create() (fresh session required)/v1/auth/passkeys/register/optionsIdempotency-Key is accepted but ignored for this session-only authentication action. Repeated requests do not create customer resources or charges.…
  • POSTStore a new passkey after the browser created it/v1/auth/passkeys/register/verify
  • DELETERemove one of your passkeys/v1/auth/passkeys/:passkey_id
  • PATCHRename one of your passkeys (fresh session required)/v1/auth/passkeys/:passkey_id
  • GETWhich sign-in methods are available/v1/auth/providers
  • POSTProve it is you again (passkey now, or a fresh link by mail) before a sensitive action/v1/auth/reauthIdempotency-Key is accepted but ignored for this session-only authentication action. Repeated requests do not create customer resources or charges.…
  • POSTConfirm the session that asked for a confirm link, from the browser the link opened in/v1/auth/reauth/confirmA confirm link opened away from the session that asked for it sends the browser to a page that asks for the code that session shows (code of POST…
  • POSTSign in with reviewer credentials/v1/auth/review-accessIdempotency-Key is accepted but ignored for this session-only authentication action. Repeated requests do not create customer resources or charges.…
  • GETYour live sessions/v1/auth/sessions
  • DELETESign out everywhere else/v1/auth/sessionsIdempotency-Key is accepted but ignored for this session-only authentication action. Repeated requests do not create customer resources or charges.…
  • DELETERevoke one of your sessions/v1/auth/sessions/:session_idIdempotency-Key is accepted but ignored for this session-only authentication action. Repeated requests do not create customer resources or charges.…
  • POSTLook at another organization you belong to/v1/auth/switch-organizationIdempotency-Key is accepted but ignored for this session-only authentication action. Repeated requests do not create customer resources or charges.…

billing

  • GETAuto top-up settings/v1/auto-topups
  • POSTOpt in to auto top-up (threshold, amount, daily cap); the card is saved at the first payment/v1/auto-topups
  • DELETETurn auto top-up off/v1/auto-topups/:auto_topup_id
  • GETAvailable and held balance/v1/balance
  • POSTOpen the Stripe customer portal (cards, invoices, the subscription)/v1/billing-portal-sessions
  • GETBilling settings of the organization/v1/billing-settings
  • PATCHChange the billing email or the low-balance threshold/v1/billing-settings
  • GETSpending caps of this environment/v1/budgets
  • POSTCreate a daily or monthly cap for the organization, a project or an agent/v1/budgets
  • DELETERemove a cap: deleted when it never charged a hold, archived when it has history/v1/budgets/:budget_id
  • PATCHChange a cap's limit or status/v1/budgets/:budget_id
  • GETStripe invoices and receipts (hosted links)/v1/invoices
  • GETOne Stripe invoice/v1/invoices/:invoice_id
  • GETStripe's receipt for a paid invoice/v1/invoices/:invoice_id/receipt
  • GETWallet transactions, newest first/v1/ledger
  • GETThe wallet statement: one line per event with the balance after it, newest first/v1/statementOne line per event on the wallet, signed the way the balance moved. type filters the lines by the type they carry. kind is the same filter by its older name,…
  • GETThe wallet statement as CSV: every line the filters select/v1/statement.csvOne line per event on the wallet, signed the way the balance moved. type filters the lines by the type they carry. kind is the same filter by its older name,…
  • GETSubscriptions and the workspace entitlement/v1/subscriptions
  • POSTOpen a hosted Checkout for the Agent workspace subscription/v1/subscriptions/checkoutAnswers the address of Stripe's payment page for the plan. It is refused with 409 while the plan is active or a Checkout of it is still open, so the plan is…
  • GETTop-up sessions, newest first/v1/topup-sessions
  • POSTOpen a hosted Checkout to fund the live wallet (10 to 1000 USD)/v1/topup-sessions
  • GETRead a top-up session/v1/topup-sessions/:topup_session_id
  • POSTCancel an open top-up, so its hosted Checkout can no longer be paid/v1/topup-sessions/:topup_session_id/cancelCloses the Checkout of a manual or setup top-up that is still open and answers the session with status canceled. Canceling a setup payment also turns off the…
  • GETStripe's receipt for a paid top-up (manual, setup or automatic)/v1/topup-sessions/:topup_session_id/receipt
  • GETUsage rollups by day, direction, destination and project/v1/usage
  • POSTExport usage as CSV behind a signed download/v1/usage-exports
  • GETRead a usage export (fresh link)/v1/usage-exports/:export_id
  • GETThe CSV behind a signed URL (no API key)/v1/usage-exports/:export_id/content

platform

  • GETLimits and features in force/v1/capabilities
  • GETCustomer-safe availability/v1/service-status

extractions

  • GETClassifications, newest first/v1/classifications
  • POSTClassify a received fax or a document into one of your document types, or abstain/v1/classifications
  • GETOne classification/v1/classifications/:classification_id
  • GETSummaries, newest first/v1/document-summaries
  • POSTSummarise a received fax or a document; every sentence cites its pages/v1/document-summaries
  • GETOne summary/v1/document-summaries/:summary_id
  • GETYour extraction schemas/v1/extraction-schemas
  • POSTSave a versioned extraction schema (the same name again is the next version)/v1/extraction-schemas
  • GETOne schema version/v1/extraction-schemas/:schema_id
  • GETExtractions, newest first/v1/extractions
  • POSTRead a received fax or a document: OCR per page, then fields against a schema/v1/extractions
  • GETOne extraction with its corrections/v1/extractions/:extraction_id
  • POSTRecord a reviewer's correction of one field (stored beside the extraction, never merged)/v1/extractions/:extraction_id/corrections

numbers

  • GETWhere we send and where we host numbers/v1/coverage
  • GETFax-capable numbers for sale/v1/number-inventory
  • GETList your number orders/v1/number-orders
  • POSTBuy a number (the first month is held now, charged on activation)/v1/number-ordersReturns 201 with the created order, including when the carrier refuses the purchase. A refused order has status failed and an error describing the carrier's…
  • GETRead a number order/v1/number-orders/:order_id
  • POSTPut a failed number order away/v1/number-orders/:order_id/dismissalsSets dismissed_at on an order that failed. The order stays in the list. An order that did not fail answers 409 conflict.
  • GETYour numbers/v1/numbers
  • GETOne number/v1/numbers/:number_id
  • PATCHLabel, inbound route and PDF by mail of a number/v1/numbers/:number_id
  • POSTRelease a number (confirm with the number itself; 30-day quarantine follows)/v1/numbers/:number_id/release-requests
  • GETPort orders and port-out requests/v1/port-orders
  • POSTRequest a port-in (handled with you)/v1/port-orders
  • GETOne port order/v1/port-orders/:port_id
  • POSTNote a port-out of one of your numbers/v1/port-out-requests
  • POSTCan these numbers port in/v1/portability-checks
  • POSTVerify a number of yours as a sender (only numbers you own)/v1/sender-verifications

documents

  • GETList documents, newest first/v1/documents
  • POSTCreate an immutable document from an upload or from text/v1/documents
  • GETRead a document's hash, pages and validation state/v1/documents/:document_id
  • DELETEDelete a document (its bytes and previews)/v1/documents/:document_id
  • PATCHRename a document/v1/documents/:document_id
  • GETThe PDF bytes behind a signed URL (no API key)/v1/documents/:document_id/content
  • GETA short-lived signed download URL/v1/documents/:document_id/download
  • GETRendered pages with signed preview URLs/v1/documents/:document_id/pages
  • GETA page PNG behind a signed URL (no API key)/v1/documents/:document_id/pages/:page_number/content
  • GETValidation warnings/v1/documents/:document_id/validation
  • POSTCreate a bounded upload session/v1/uploads
  • DELETECancel an incomplete upload/v1/uploads/:upload_id
  • POSTFinalize an upload (size and hash checked)/v1/uploads/:upload_id/complete
  • PUTSend the bytes to a signed upload URL (no API key)/v1/uploads/:upload_id/content

events

  • GETEvents for reconciliation, oldest first from the cursor/v1/events

quotes

  • POSTPrice an exact document to one destination/v1/fax-quotes
  • GETRead a quote/v1/fax-quotes/:quote_id

faxes

  • GETList fax jobs, newest first/v1/faxesFax jobs of the credential's organization and environment, newest first, in pages of limit. Every filter combines with the others and with cursor: pass the…
  • POSTSend a quoted fax (Idempotency-Key recommended)/v1/faxes
  • GETRead a fax job (with evidence once delivered)/v1/faxes/:fax_id
  • GETAttempt history/v1/faxes/:fax_id/attempts
  • POSTCancel if still possible (best effort once sending)/v1/faxes/:fax_id/cancel
  • GETOrdered events of one fax/v1/faxes/:fax_id/events
  • GETDelivery evidence as a receipt (JSON)/v1/faxes/:fax_id/receipt
  • GETThe same receipt as a one-page PDF/v1/faxes/:fax_id/receipt.pdf

inbox

  • GETReceived faxes, newest first (metadata only)/v1/inbox
  • GETOne received fax with its text as data/v1/inbox/:inbox_id
  • DELETEDelete a received fax: its file and the text read from it/v1/inbox/:inbox_id
  • PATCHMark a received fax read or archived/v1/inbox/:inbox_id
  • GETThe received PDF behind a signed URL (no API key)/v1/inbox/:inbox_id/content
  • GETA short-lived signed link to the received PDF/v1/inbox/:inbox_id/download

members

  • GETOpen invitations/v1/invitations
  • POSTInvite someone by email (a link that works for 7 days)/v1/invitations
  • DELETEWithdraw an invitation/v1/invitations/:invitation_id
  • POSTMake a new link for an open invitation, to hand over yourself (the old link stops working)/v1/invitations/:invitation_id/linkNo mail is sent. The link is shown once, like a key's secret: the server keeps only its hash. It joins the organization only for a person signed in with the…
  • POSTSend an open invitation again (a new link for 7 days; the old link stops working)/v1/invitations/:invitation_id/resend
  • GETThe organization's members/v1/members
  • DELETERemove a member (owner)/v1/members/:member_id
  • PATCHChange a member's role/v1/members/:member_id

oauth

  • GETThe pending consent behind a consent URL: the app, the scopes and your organizations/v1/oauth/authorizations/:authorization_id
  • POSTAllow: mint the authorization code and return where the browser goes next/v1/oauth/authorizations/:authorization_id/approve
  • POSTDeny: send the app an access_denied answer/v1/oauth/authorizations/:authorization_id/deny
  • GETYour connected apps in this organization/v1/oauth/grants
  • DELETERevoke a connected app/v1/oauth/grants/:grant_id

one-time-sends

  • GETList the organization's one-time orders, newest first/v1/one-time-sends
  • POSTCreate a one-time order: one document to one fax number, priced from the card/v1/one-time-sendsNo credential is needed. The answer carries the price, the page count and the status token; the next step is the checkout. A live key with fax:send or a…
  • POSTWhat a confirmation link is for, without using it/v1/one-time-sends/by-tokenThe confirm page reads this before the click, with the token in the body. Nothing is consumed by reading it, and nothing is changed: the call is a read that…
  • GETWhat a confirmation link is for, without using it (token in the path)/v1/one-time-sends/by-token/:tokenDeprecated. Kept for pages loaded before 2026-11-12. The token in a path reaches access logs, so new callers post it to /v1/one-time-sends/by-token instead.…
  • GETWhether one-time sends are open here, and the card and limits an order is priced and checked by/v1/one-time-sends/config
  • POSTMeasure the room the cover sheet leaves for its message, before an order is made/v1/one-time-sends/cover-checksLays out the cover sheet exactly as the create would, with the fields given so far, and answers whether the message fits on its one page and how many more…
  • POSTCreate a one-time order from a live quote the wallet does not cover/v1/one-time-sends/from-quoteThe quote supplies the document, the destination and the cover; the price is the card's one-time price, not the quote's. The quote then belongs to the order.…
  • POSTCount the pages of a document before an order is made/v1/one-time-sends/previewReads a file (or text) exactly as the create would and answers its page count and its first page as a small picture, or the create's own refusal:…
  • GETRead a one-time order: where it stands, what to do next, and the fax with its evidence/v1/one-time-sends/:one_time_order_id
  • POSTOpen the card payment of a one-time order/v1/one-time-sends/:one_time_order_id/checkoutAnswers the hosted payment page of the order. The card is held there, not charged. A failed fax costs nothing. A fax that stops part way is charged the price…
  • POSTConfirm a one-time order with the token of the mailed link: the fax is released/v1/one-time-sends/:one_time_order_id/confirmProves the sender's address and releases the fax. In a browser without a session it also signs the payer in and sets the session cookies. Idempotency-Key is…
  • GETOne page of a one-time order as a picture: the cover sheet, then the document/v1/one-time-sends/:one_time_order_id/pages/:page_numberPage 1 is the cover sheet. Before the fax is released the cover is drawn from the order as it will be printed, and the other pages from the uploaded document.…
  • GETThe receipt of a one-time order's fax as a one-page PDF/v1/one-time-sends/:one_time_order_id/receipt.pdfThe delivery receipt of the order's fax: the state, the pages, the document hash, the carrier's evidence as it was reported, and what became of the card. It…
  • POSTMail the confirmation link of a one-time order again/v1/one-time-sends/:one_time_order_id/resend-confirmationAt most three times per order and once in ten minutes. The earlier links keep working.

organizations

  • GETDownload an organization archive with a signed link valid for 72 hours/v1/organization/export-archives/:token
  • GETThe organizations you belong to/v1/organizations
  • GETThe organization you are looking at/v1/organizations/current
  • PATCHRename the organization/v1/organizations/current
  • GETThe organization's export and deletion requests and where each stands/v1/organizations/current/data-requests
  • POSTAsk for the organization and its data to be deleted (owner)/v1/organizations/current/deletion-requests
  • DELETEWithdraw an open deletion request (owner)/v1/organizations/current/deletion-requests/:request_idWorks while the request is open. Once a person at Fax for Agents has started the deletion the organization answers 410 to every call, this one included.
  • POSTAsk for an export of the organization's data (owner)/v1/organizations/current/export-requests
  • GETThe audit trail as CSV: every action on the organization in the range/v1/records/audit.csvOne line per audit row of the organization, oldest first: when, who (actor and a label), what (action), on what (resource_type and resource_id) and the row's…
  • GETThe fax history as CSV: every fax sent and received in the range/v1/records/faxes.csvNeeds two scopes: fax:read, which x-required-scope names, and inbox:read as well. One line per fax of the key's environment, sent and received, oldest first.…

policies

  • GETRead the auto-send setting for connected apps in this environment/v1/organizations/current/auto-send
  • PUTLet connected apps send without asking, inside two limits (owner)/v1/organizations/current/auto-sendThe environment comes from X-FFA-Environment. When enabled, every connected app of the organization (OAuth connections such as ChatGPT or Claude, and API keys…
  • GETList the organization's policies/v1/policies
  • POSTCreate a delegated policy (version 1)/v1/policies
  • GETRead the rules bound to the caller, an API key, an agent or a connected app/v1/policies/effective
  • GETRead a policy (its current version)/v1/policies/:policy_id
  • PATCHChange a policy: a new immutable version/v1/policies/:policy_id
  • GETEvery version, oldest first/v1/policies/:policy_id/versions
  • POSTDry run: would the policies of the caller, or of a named key, agent or app, allow this send?/v1/policy-evaluations
  • POSTCheck a draft's destination lists against each other. Writes nothing/v1/policy-rule-checksFor the editor of a policy: which numbers of allowed_destinations are already allowed by one of allowed_countries or allowed_country_prefixes. Routed with the…

sandbox

  • DELETEReset this organization's test data/v1/sandbox/data
  • POSTCreate a synthetic inbound fax (the same pipeline as a real one)/v1/sandbox/inbound-faxesA synthetic PDF goes through inbox.service.receive_now: the private document, the inbox item, the fax.received event with its download reference, exactly as a…
  • GETThe scenario catalog and active fixtures/v1/sandbox/scenarios
  • POSTSelect the outcome of the next sends/v1/sandbox/scenariosThe choice lasts 24 hours. A destination has one fixture: a second call for the same destination replaces the first, and a call with no destination replaces…

webhooks

  • GETDelivery attempts (no payload secrets)/v1/webhook-deliveries
  • GETOne delivery with the body that was sent (no secrets)/v1/webhook-deliveries/:delivery_id
  • POSTReplay the event with the same event id/v1/webhook-deliveries/:delivery_id/replay
  • GETList webhooks/v1/webhooks
  • POSTRegister a destination (secret shown once)/v1/webhooks
  • DELETERemove a destination/v1/webhooks/:webhook_id
  • PATCHChange url, filters or pause/v1/webhooks/:webhook_id
  • POSTNew secret; the old one signs too for 24 hours/v1/webhooks/:webhook_id/rotate-secret
  • POSTSend a signed webhook.test event to this destination/v1/webhooks/:webhook_id/test

API details

Base URL
https://api.faxforagents.com
Authentication
An API key in the X-API-Key header
A bearer token in the Authorization header
An API key in the X-FFA-Order-Token header
An API key in the __Host-ffa_session cookie
An API key in the sig query parameter
Operations
194 operations on 159 pathsGET 95POST 70DELETE 16PATCH 11PUT 2
1 marked deprecated
Main resources
billing 28auth 25numbers 16documents 14one-time-sends 14extractions 13organizations 12policies 10webhooks 9faxes 8
Response formats
application/json text/csv application/pdf image/png
Description format
OpenAPI 3.1.0, API version 1.21.4

How to test the Fax for Agents API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Fax for Agents API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the X-API-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List agent identities” (GET /v1/agents), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Fax for Agents API?

A fax API built for AI agents. Keys: Authorization: Bearer ffa_test_... (test mode) or ffa_live_..., or the same key in X-API-Key. Each operation lists the… It is listed under Communication and has 194 endpoints.

Who publishes the Fax for Agents API?

It is listed from Fax for Agents's public API description (an OpenAPI document), not published by Fax for Agents on Swastik Codes. Anyone who controls faxforagents.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Fax for Agents API?

Requests go to https://api.faxforagents.com. Endpoint paths are added to this base URL.

How do I authenticate with the Fax for Agents API?

It accepts 5 methods: an API key in the X-API-Key header; A bearer token in the Authorization header; an API key in the X-FFA-Order-Token header; an API key in the __Host-ffa_session cookie; an API key in the sig query parameter.

How many endpoints does the Fax for Agents API have?

194 operations on 159 paths (95 GET, 70 POST, 16 DELETE, 11 PATCH, 2 PUT). The largest groups are billing, auth, numbers, documents.

Is forking the Fax for Agents API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.