Fax for Agents

Fax for Agents Documents API

The documents API from Fax for Agents — 11 operation(s) for documents.

GitHub OpenAPI

Operations 13

POST /v1/uploads Create a bounded upload session #
PUT /v1/uploads/{upload_id}/content Send the bytes to a signed upload URL (no API key) #
POST /v1/uploads/{upload_id}/complete Finalize an upload (size and hash checked) #
DELETE /v1/uploads/{upload_id} Cancel an incomplete upload #
POST /v1/documents Create an immutable document from an upload or from text #
GET /v1/documents List documents, newest first #
GET /v1/documents/{document_id} Read a document's hash, pages and validation state #
DELETE /v1/documents/{document_id} Delete a document (its bytes and previews) #
GET /v1/documents/{document_id}/validation Validation warnings #
GET /v1/documents/{document_id}/download A short-lived signed download URL #
GET /v1/documents/{document_id}/content The PDF bytes behind a signed URL (no API key) #
GET /v1/documents/{document_id}/pages Rendered pages with signed preview URLs #
GET /v1/documents/{document_id}/pages/{page_number}/content A page PNG behind a signed URL (no API key) #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/faxforagents/openapi/faxforagents-documents-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-documents-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-documents-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Faxforagents Documents 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 documents 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: Documents
paths:
  /v1/uploads:
    post:
      tags:
      - Documents
      summary: Create a bounded upload session
      operationId: create_upload
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UploadCreate'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UploadSession'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/uploads/{upload_id}/content:
    put:
      tags:
      - Documents
      summary: Send the bytes to a signed upload URL (no API key)
      operationId: put_upload_content
      parameters:
      - name: upload_id
        in: path
        required: true
        schema:
          type: string
          title: Upload 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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UploadSession'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/uploads/{upload_id}/complete:
    post:
      tags:
      - Documents
      summary: Finalize an upload (size and hash checked)
      operationId: complete_upload
      parameters:
      - name: upload_id
        in: path
        required: true
        schema:
          type: string
          title: Upload Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UploadComplete'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UploadSession'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/uploads/{upload_id}:
    delete:
      tags:
      - Documents
      summary: Cancel an incomplete upload
      operationId: cancel_upload
      parameters:
      - name: upload_id
        in: path
        required: true
        schema:
          type: string
          title: Upload 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/documents:
    post:
      tags:
      - Documents
      summary: Create an immutable document from an upload or from text
      operationId: create_document
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocumentCreate'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Documents
      summary: List documents, newest first
      operationId: list_documents
      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
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentPage'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/documents/{document_id}:
    get:
      tags:
      - Documents
      summary: Read a document's hash, pages and validation state
      operationId: get_document
      parameters:
      - name: document_id
        in: path
        required: true
        schema:
          type: string
          title: Document Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Documents
      summary: Delete a document (its bytes and previews)
      operationId: delete_document
      parameters:
      - name: document_id
        in: path
        required: true
        schema:
          type: string
          title: Document 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/documents/{document_id}/validation:
    get:
      tags:
      - Documents
      summary: Validation warnings
      operationId: get_document_validation
      parameters:
      - name: document_id
        in: path
        required: true
        schema:
          type: string
          title: Document Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentValidation'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/documents/{document_id}/download:
    get:
      tags:
      - Documents
      summary: A short-lived signed download URL
      operationId: get_document_download
      parameters:
      - name: document_id
        in: path
        required: true
        schema:
          type: string
          title: Document 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/documents/{document_id}/content:
    get:
      tags:
      - Documents
      summary: The PDF bytes behind a signed URL (no API key)
      operationId: get_document_content
      parameters:
      - name: document_id
        in: path
        required: true
        schema:
          type: string
          title: Document 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'
  /v1/documents/{document_id}/pages:
    get:
      tags:
      - Documents
      summary: Rendered pages with signed preview URLs
      operationId: list_document_pages
      parameters:
      - name: document_id
        in: path
        required: true
        schema:
          type: string
          title: Document Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentPages'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/documents/{document_id}/pages/{page_number}/content:
    get:
      tags:
      - Documents
      summary: A page PNG behind a signed URL (no API key)
      operationId: get_document_page_content
      parameters:
      - name: document_id
        in: path
        required: true
        schema:
          type: string
          title: Document Id
      - name: page_number
        in: path
        required: true
        schema:
          type: integer
          title: Page Number
      - 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:
    DocumentPages:
      properties:
        document_id:
          type: string
          title: Document Id
        page_count:
          type: integer
          title: Page Count
        render_status:
          type: string
          title: Render Status
        render_reason:
          anyOf:
          - type: string
          - type: 'null'
          title: Render Reason
        items:
          items:
            $ref: '#/components/schemas/PagePreview'
          type: array
          title: Items
      additionalProperties: true
      type: object
      required:
      - document_id
      - page_count
      - render_status
      - render_reason
      - items
      title: DocumentPages
    DocumentValidation:
      properties:
        id:
          type: string
          title: Id
        status:
          type: string
          title: Status
        page_count:
          type: integer
          title: Page Count
        render_status:
          type: string
          title: Render Status
        render_reason:
          anyOf:
          - type: string
          - type: 'null'
          title: Render Reason
        warnings:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Warnings
      additionalProperties: true
      type: object
      required:
      - id
      - status
      - page_count
      - render_status
      - render_reason
      - warnings
      title: DocumentValidation
    Document:
      properties:
        id:
          type: string
          title: Id
        environment:
          type: string
          enum:
          - live
          - test
          title: Environment
        status:
          type: string
          title: Status
        source:
          type: string
          title: Source
        filename:
          type: string
          title: Filename
        content_type:
          type: string
          title: Content Type
        size_bytes:
          type: integer
          title: Size Bytes
        sha256:
          type: string
          title: Sha256
        page_count:
          type: integer
          title: Page Count
        render_status:
          type: string
          title: Render Status
        render_reason:
          anyOf:
          - type: string
          - type: 'null'
          title: Render Reason
        validation:
          additionalProperties: true
          type: object
          title: Validation
        upload_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Upload Id
        created_at:
          type: string
          title: Created At
        expires_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Expires At
        deleted_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Deleted At
      additionalProperties: true
      type: object
      required:
      - id
      - environment
      - status
      - source
      - filename
      - content_type
      - size_bytes
      - sha256
      - page_count
      - render_status
      - render_reason
      - validation
      - upload_id
      - created_at
      - expires_at
      - deleted_at
      title: Document
    UploadSession:
      properties:
        id:
          type: string
          title: Id
        status:
          type: string
          title: Status
        filename:
          type: string
          title: Filename
        content_type:
          type: string
          title: Content Type
        declared_size:
          type: integer
          title: Declared Size
        received_size:
          type: integer
          title: Received Size
        sha256:
          anyOf:
          - type: string
          - type: 'null'
          title: Sha256
        created_at:
          type: string
          title: Created At
        expires_at:
          type: string
          title: Expires At
        completed_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Completed At
        upload_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Upload Url
        upload_method:
          anyOf:
          - type: string
          - type: 'null'
          title: Upload Method
        upload_url_expires_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Upload Url Expires At
      additionalProperties: true
      type: object
      required:
      - id
      - status
      - filename
      - content_type
      - declared_size
      - received_size
      - sha256
      - created_at
      - expires_at
      - completed_at
      title: UploadSession
    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
    DocumentCreate:
      properties:
        upload_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Upload Id
        text:
          anyOf:
          - type: string
          - type: 'null'
          title: Text
          description: Plain text rendered to a letter PDF.
        markdown:
          anyOf:
          - type: string
          - type: 'null'
          title: Markdown
          description: Markdown (headings, lists, emphasis, code) rendered to PDF.
        html:
          anyOf:
          - type: string
          - type: 'null'
          title: Html
          description: 'HTML rendered to PDF by a headless browser with scripts off and no network: inline CSS and data: images print, external resources are counted as blocked. US letter unless @page says otherwise. At most 2 MiB.'
        filename:
          anyOf:
          - type: string
            maxLength: 255
          - type: 'null'
          title: Filename
      additionalProperties: false
      type: object
      title: DocumentCreate
    UploadComplete:
      properties:
        sha256:
          anyOf:
          - type: string
            maxLength: 64
            minLength: 64
          - type: 'null'
          title: Sha256
          description: 'Optional: fail if the bytes differ.'
      additionalProperties: false
      type: object
      title: UploadComplete
    Deleted:
      properties:
        id:
          type: string
          title: Id
        deleted:
          type: boolean
          title: Deleted
          default: true
      additionalProperties: true
      type: object
      required:
      - id
      title: Deleted
    PagePreview:
      properties:
        page_number:
          type: integer
          title: Page Number
        width_px:
          anyOf:
          - type: integer
          - type: 'null'
          title: Width Px
        height_px:
          anyOf:
          - type: integer
          - type: 'null'
          title: Height Px
        url:
          type: string
          title: Url
      additionalProperties: true
      type: object
      required:
      - page_number
      - width_px
      - height_px
      - url
      title: PagePreview
    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
    UploadCreate:
      properties:
        filename:
          type: string
          maxLength: 255
          minLength: 1
          title: Filename
        content_type:
          type: string
          maxLength: 100
          title: Content Type
          description: application/pdf, image/png, image/jpeg or image/tiff. An image becomes 8-bit gray letter pages, since fax is monochrome. A frame wider than it is tall is rotated. A frame above 300 dpi letter is downsampled. Every TIFF frame is a page. PNG and JPEG take the first frame. The bytes must be the declared type.
          default: application/pdf
        size_bytes:
          type: integer
          minimum: 1.0
          title: Size Bytes
      additionalProperties: false
      type: object
      required:
      - filename
      - size_bytes
      title: UploadCreate
    DocumentPage:
      properties:
        items:
          items:
            $ref: '#/components/schemas/Document'
          type: array
          title: Items
        next_cursor:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Cursor
      additionalProperties: true
      type: object
      required:
      - items
      title: DocumentPage
x-refined-from:
- faxforagents-api-openapi.json
- faxforagents-site-openapi.json