Fax for Agents

Fax for Agents Faxes API

The faxes API from Fax for Agents — 6 operation(s) for faxes.

GitHub OpenAPI

Operations 7

POST /v1/faxes Send a quoted fax (Idempotency-Key recommended) #
GET /v1/faxes List fax jobs, newest first #
GET /v1/faxes/{fax_id} Read a fax job (with evidence once delivered) #
GET /v1/faxes/{fax_id}/events Ordered events of one fax #
GET /v1/faxes/{fax_id}/attempts Attempt history #
GET /v1/faxes/{fax_id}/receipt Delivery evidence as a receipt (JSON) #
POST /v1/faxes/{fax_id}/cancel Cancel if still possible (best effort once sending) #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/faxforagents/openapi/faxforagents-faxes-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/faxforagents/json-schema/faxforagents-extraction-schema.json
📊
JSONSchema
https://artifacts.apis.io/faxforagents/json-schema/faxforagents-fax-job-schema.json
📊
JSONSchema
https://artifacts.apis.io/faxforagents/json-schema/faxforagents-quote-schema.json
📊
JSONSchema
https://artifacts.apis.io/faxforagents/json-schema/faxforagents-inbox-item-detail-schema.json
📊
JSONSchema
https://artifacts.apis.io/faxforagents/json-schema/faxforagents-analytics-organization-schema.json
📊
JSONSchema
https://artifacts.apis.io/faxforagents/json-schema/faxforagents-number-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/faxforagents:faxforagents-faxes-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

faxforagents-faxes-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Faxforagents Faxes API
  version: 1.4.3
  contact:
    name: Fax for Agents
    url: https://faxforagents.com/contact/
    email: hello@faxforagents.com
  termsOfService: https://faxforagents.com/terms/
  x-refined-note:
  - x-snapshot differs across the merged source definitions and was not carried
  description: 'Operations tagged faxes across 2 of this provider''s published API definitions: faxforagents-api-openapi.json, faxforagents-site-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.faxforagents.com
  description: Production
tags:
- name: Faxes
paths:
  /v1/faxes:
    post:
      tags:
      - Faxes
      summary: Send a quoted fax (Idempotency-Key recommended)
      operationId: create_fax
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FaxCreate'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FaxJob'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Faxes
      summary: List fax jobs, newest first
      operationId: list_faxes
      parameters:
      - name: state
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: State
      - name: cursor
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Cursor
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 200
          minimum: 1
          default: 50
          title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FaxJobPage'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/faxes/{fax_id}:
    get:
      tags:
      - Faxes
      summary: Read a fax job (with evidence once delivered)
      operationId: get_fax
      parameters:
      - name: fax_id
        in: path
        required: true
        schema:
          type: string
          title: Fax Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FaxJob'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/faxes/{fax_id}/events:
    get:
      tags:
      - Faxes
      summary: Ordered events of one fax
      operationId: list_fax_events
      parameters:
      - name: fax_id
        in: path
        required: true
        schema:
          type: string
          title: Fax Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventPage'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/faxes/{fax_id}/attempts:
    get:
      tags:
      - Faxes
      summary: Attempt history
      operationId: list_fax_attempts
      parameters:
      - name: fax_id
        in: path
        required: true
        schema:
          type: string
          title: Fax Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AttemptPage'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/faxes/{fax_id}/receipt:
    get:
      tags:
      - Faxes
      summary: Delivery evidence as a receipt (JSON)
      operationId: get_fax_receipt
      parameters:
      - name: fax_id
        in: path
        required: true
        schema:
          type: string
          title: Fax Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Receipt'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/faxes/{fax_id}/cancel:
    post:
      tags:
      - Faxes
      summary: Cancel if still possible (best effort once sending)
      operationId: cancel_fax
      parameters:
      - name: fax_id
        in: path
        required: true
        schema:
          type: string
          title: Fax Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FaxJob'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    FaxCreate:
      properties:
        quote_id:
          type: string
          title: Quote Id
        client_reference:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Client Reference
        approval_id:
          anyOf:
          - type: string
            pattern: ^[a-z]{2,8}_[0-9a-f]{32}$
          - type: 'null'
          title: Approval Id
          description: An approved approval request bound to this quote. Consumed by this one send.
      additionalProperties: false
      type: object
      required:
      - quote_id
      title: FaxCreate
      description: 'M9: an approved request authorizes the send; without one a quote that needs authorization is

        evaluated against the caller''s delegated policies.'
    AttemptPage:
      properties:
        items:
          items:
            $ref: '#/components/schemas/Attempt'
          type: array
          title: Items
      additionalProperties: true
      type: object
      required:
      - items
      title: AttemptPage
    Attempt:
      properties:
        id:
          type: string
          title: Id
        fax_job_id:
          type: string
          title: Fax Job Id
        attempt_number:
          type: integer
          title: Attempt Number
        provider:
          type: string
          title: Provider
        provider_ref:
          anyOf:
          - type: string
          - type: 'null'
          title: Provider Ref
        status:
          type: string
          title: Status
        pages_sent:
          type: integer
          title: Pages Sent
        failure_code:
          anyOf:
          - type: string
          - type: 'null'
          title: Failure Code
        evidence:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Evidence
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
        started_at:
          type: string
          title: Started At
        finished_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Finished At
      additionalProperties: true
      type: object
      required:
      - id
      - fax_job_id
      - attempt_number
      - provider
      - provider_ref
      - status
      - pages_sent
      - failure_code
      - evidence
      - error
      - started_at
      - finished_at
      title: Attempt
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    FaxJobPage:
      properties:
        items:
          items:
            $ref: '#/components/schemas/FaxJob'
          type: array
          title: Items
        next_cursor:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Cursor
      additionalProperties: true
      type: object
      required:
      - items
      title: FaxJobPage
    FaxJob:
      properties:
        id:
          type: string
          title: Id
        environment:
          type: string
          enum:
          - live
          - test
          title: Environment
        direction:
          type: string
          title: Direction
        state:
          type: string
          enum:
          - queued
          - active
          - partial
          - failed
          - unknown
          - delivered
          title: State
        failure_code:
          anyOf:
          - type: string
          - type: 'null'
          title: Failure Code
        to:
          type: string
          title: To
        from:
          anyOf:
          - type: string
          - type: 'null'
          title: From
        route:
          type: string
          title: Route
        document_id:
          type: string
          title: Document Id
        document_sha256:
          type: string
          title: Document Sha256
        transmitted_sha256:
          anyOf:
          - type: string
          - type: 'null'
          title: Transmitted Sha256
        quote_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Quote Id
        billable_pages:
          type: integer
          title: Billable Pages
        cover_pages:
          type: integer
          title: Cover Pages
        pages_sent:
          type: integer
          title: Pages Sent
        amount_micro:
          type: integer
          title: Amount Micro
        captured_micro:
          type: integer
          title: Captured Micro
        currency:
          type: string
          title: Currency
        provider:
          type: string
          title: Provider
        provider_ref:
          anyOf:
          - type: string
          - type: 'null'
          title: Provider Ref
        client_reference:
          anyOf:
          - type: string
          - type: 'null'
          title: Client Reference
        attempt_count:
          type: integer
          title: Attempt Count
        created_at:
          type: string
          title: Created At
        updated_at:
          type: string
          title: Updated At
        completed_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Completed At
        cancel_requested_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Cancel Requested At
        evidence:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Evidence
          description: The carrier's evidence once delivered or partial; null before.
      additionalProperties: true
      type: object
      required:
      - id
      - environment
      - direction
      - state
      - failure_code
      - to
      - route
      - document_id
      - document_sha256
      - transmitted_sha256
      - quote_id
      - billable_pages
      - cover_pages
      - pages_sent
      - amount_micro
      - captured_micro
      - currency
      - provider
      - provider_ref
      - client_reference
      - attempt_count
      - created_at
      - updated_at
      - completed_at
      - cancel_requested_at
      title: FaxJob
    Receipt:
      properties:
        fax_job_id:
          type: string
          title: Fax Job Id
        state:
          type: string
          title: State
        failure_code:
          anyOf:
          - type: string
          - type: 'null'
          title: Failure Code
        to:
          type: string
          title: To
        from:
          anyOf:
          - type: string
          - type: 'null'
          title: From
        document_sha256:
          type: string
          title: Document Sha256
        transmitted_sha256:
          anyOf:
          - type: string
          - type: 'null'
          title: Transmitted Sha256
        billable_pages:
          type: integer
          title: Billable Pages
        pages_sent:
          type: integer
          title: Pages Sent
        amount_micro:
          type: integer
          title: Amount Micro
        captured_micro:
          type: integer
          title: Captured Micro
        currency:
          type: string
          title: Currency
        provider:
          type: string
          title: Provider
        created_at:
          type: string
          title: Created At
        completed_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Completed At
        evidence:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Evidence
        attempts:
          items:
            $ref: '#/components/schemas/Attempt'
          type: array
          title: Attempts
        note:
          type: string
          title: Note
        generated_at:
          type: string
          title: Generated At
      additionalProperties: true
      type: object
      required:
      - fax_job_id
      - state
      - failure_code
      - to
      - document_sha256
      - transmitted_sha256
      - billable_pages
      - pages_sent
      - amount_micro
      - captured_micro
      - currency
      - provider
      - created_at
      - completed_at
      - evidence
      - attempts
      - note
      - generated_at
      title: Receipt
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    EventPage:
      properties:
        items:
          items:
            $ref: '#/components/schemas/Event'
          type: array
          title: Items
        next_cursor:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Cursor
      additionalProperties: true
      type: object
      required:
      - items
      title: EventPage
    Event:
      properties:
        id:
          type: string
          title: Id
        type:
          type: string
          title: Type
        created_at:
          type: string
          title: Created At
        org_id:
          type: string
          title: Org Id
        environment:
          type: string
          enum:
          - live
          - test
          title: Environment
        project_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Id
        resource_type:
          type: string
          title: Resource Type
        resource_id:
          type: string
          title: Resource Id
        fax_job_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Fax Job Id
        schema_version:
          type: integer
          title: Schema Version
        correlation_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Correlation Id
        data:
          additionalProperties: true
          type: object
          title: Data
      additionalProperties: true
      type: object
      required:
      - id
      - type
      - created_at
      - org_id
      - environment
      - project_id
      - resource_type
      - resource_id
      - fax_job_id
      - schema_version
      - correlation_id
      - data
      title: Event
x-refined-from:
- faxforagents-api-openapi.json
- faxforagents-site-openapi.json