Fax for Agents

Fax for Agents Inbox API

The inbox API from Fax for Agents — 4 operation(s) for inbox.

GitHub OpenAPI

Operations 6

GET /v1/inbox Received faxes, newest first (metadata only) #
GET /v1/inbox/{inbox_id} One received fax with its text as data #
PATCH /v1/inbox/{inbox_id} Mark a received fax read or archived #
DELETE /v1/inbox/{inbox_id} Delete a received fax #
GET /v1/inbox/{inbox_id}/download A short-lived signed link to the received PDF #
GET /v1/inbox/{inbox_id}/content The received PDF behind a signed URL (no API key) #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/faxforagents/openapi/faxforagents-inbox-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-inbox-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-inbox-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Faxforagents Inbox 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 inbox 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: inbox
paths:
  /v1/inbox:
    get:
      tags:
      - inbox
      summary: Received faxes, newest first (metadata only)
      operationId: list_inbox
      parameters:
      - 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
      - name: status
        in: query
        required: false
        schema:
          anyOf:
          - enum:
            - received
            - read
            - archived
            type: string
          - type: 'null'
          title: Status
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboxPage'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/inbox/{inbox_id}:
    get:
      tags:
      - inbox
      summary: One received fax with its text as data
      operationId: get_inbox_item
      parameters:
      - name: inbox_id
        in: path
        required: true
        schema:
          type: string
          title: Inbox Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboxItemDetail'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    patch:
      tags:
      - inbox
      summary: Mark a received fax read or archived
      operationId: update_inbox_item
      parameters:
      - name: inbox_id
        in: path
        required: true
        schema:
          type: string
          title: Inbox Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InboxUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/faxforagents__api__routes__inbox__InboxItem'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - inbox
      summary: Delete a received fax
      operationId: delete_inbox_item
      parameters:
      - name: inbox_id
        in: path
        required: true
        schema:
          type: string
          title: Inbox Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Deleted'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/inbox/{inbox_id}/download:
    get:
      tags:
      - inbox
      summary: A short-lived signed link to the received PDF
      operationId: get_inbox_download
      parameters:
      - name: inbox_id
        in: path
        required: true
        schema:
          type: string
          title: Inbox Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignedUrl'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/inbox/{inbox_id}/content:
    get:
      tags:
      - inbox
      summary: The received PDF behind a signed URL (no API key)
      operationId: get_inbox_content
      parameters:
      - name: inbox_id
        in: path
        required: true
        schema:
          type: string
          title: Inbox Id
      - name: exp
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Exp
      - name: sig
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Sig
      responses:
        '200':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    InboxPage:
      properties:
        items:
          items:
            $ref: '#/components/schemas/faxforagents__api__routes__inbox__InboxItem'
          type: array
          title: Items
        next_cursor:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Cursor
      additionalProperties: true
      type: object
      required:
      - items
      title: InboxPage
    InboxUpdate:
      properties:
        status:
          anyOf:
          - type: string
            enum:
            - received
            - read
            - archived
          - type: 'null'
          title: Status
      additionalProperties: false
      type: object
      title: InboxUpdate
    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
    Deleted:
      properties:
        id:
          type: string
          title: Id
        deleted:
          type: boolean
          title: Deleted
          default: true
      additionalProperties: true
      type: object
      required:
      - id
      title: Deleted
    InboxItemDetail:
      properties:
        id:
          type: string
          title: Id
        from:
          anyOf:
          - type: string
          - type: 'null'
          title: From
        to:
          type: string
          title: To
        pages:
          type: integer
          title: Pages
        status:
          type: string
          title: Status
        document_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Document Id
        received_at:
          type: string
          title: Received At
        amount_micro:
          type: integer
          title: Amount Micro
          default: 0
        note:
          anyOf:
          - type: string
          - type: 'null'
          title: Note
        environment:
          type: string
          enum:
          - live
          - test
          title: Environment
          default: live
        number_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Number Id
        project_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Id
        partial_content:
          type: boolean
          title: Partial Content
          default: false
        media_status:
          type: string
          title: Media Status
          default: stored
        duration_secs:
          anyOf:
          - type: integer
          - type: 'null'
          title: Duration Secs
        provider:
          type: string
          title: Provider
          default: ''
        read_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Read At
        expires_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Expires At
        document:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Document
        text:
          anyOf:
          - type: string
          - type: 'null'
          title: Text
        extraction_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Extraction Id
      additionalProperties: true
      type: object
      required:
      - id
      - to
      - pages
      - status
      - document_id
      - received_at
      title: InboxItemDetail
    faxforagents__api__routes__inbox__InboxItem:
      properties:
        id:
          type: string
          title: Id
        from:
          anyOf:
          - type: string
          - type: 'null'
          title: From
        to:
          type: string
          title: To
        pages:
          type: integer
          title: Pages
        status:
          type: string
          title: Status
        document_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Document Id
        received_at:
          type: string
          title: Received At
        amount_micro:
          type: integer
          title: Amount Micro
          default: 0
        note:
          anyOf:
          - type: string
          - type: 'null'
          title: Note
        environment:
          type: string
          enum:
          - live
          - test
          title: Environment
          default: live
        number_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Number Id
        project_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Id
        partial_content:
          type: boolean
          title: Partial Content
          default: false
        media_status:
          type: string
          title: Media Status
          default: stored
        duration_secs:
          anyOf:
          - type: integer
          - type: 'null'
          title: Duration Secs
        provider:
          type: string
          title: Provider
          default: ''
        read_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Read At
        expires_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Expires At
      additionalProperties: true
      type: object
      required:
      - id
      - to
      - pages
      - status
      - document_id
      - received_at
      title: InboxItem
    SignedUrl:
      properties:
        url:
          type: string
          title: Url
        expires_at:
          type: string
          title: Expires At
        content_type:
          type: string
          title: Content Type
      additionalProperties: true
      type: object
      required:
      - url
      - expires_at
      - content_type
      title: SignedUrl
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
x-refined-from:
- faxforagents-api-openapi.json
- faxforagents-site-openapi.json