Fax for Agents

Fax for Agents Policies API

The policies API from Fax for Agents — 5 operation(s) for policies.

GitHub OpenAPI

Operations 7

GET /v1/policies List the organization's policies #
POST /v1/policies Create a delegated policy (version 1) #
GET /v1/policies/effective What the calling key may do on its own, and whether a human is needed otherwise #
GET /v1/policies/{policy_id} Read a policy (its current version) #
PATCH /v1/policies/{policy_id} Change a policy: a new immutable version #
GET /v1/policies/{policy_id}/versions Every version, oldest first #
POST /v1/policy-evaluations Dry run: would the calling key's policies allow this send? Never executes #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/faxforagents/openapi/faxforagents-policies-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-policies-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-policies-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Faxforagents Policies 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 policies 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: Policies
paths:
  /v1/policies:
    get:
      tags:
      - Policies
      summary: List the organization's policies
      operationId: list_policies
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyList'
    post:
      tags:
      - Policies
      summary: Create a delegated policy (version 1)
      operationId: create_policy
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PolicyCreate'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Policy'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/policies/effective:
    get:
      tags:
      - Policies
      summary: What the calling key may do on its own, and whether a human is needed otherwise
      operationId: get_effective_policies
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EffectivePolicies'
  /v1/policies/{policy_id}:
    get:
      tags:
      - Policies
      summary: Read a policy (its current version)
      operationId: get_policy
      parameters:
      - name: policy_id
        in: path
        required: true
        schema:
          type: string
          title: Policy Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Policy'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    patch:
      tags:
      - Policies
      summary: 'Change a policy: a new immutable version'
      operationId: update_policy
      parameters:
      - name: policy_id
        in: path
        required: true
        schema:
          type: string
          title: Policy Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PolicyUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Policy'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/policies/{policy_id}/versions:
    get:
      tags:
      - Policies
      summary: Every version, oldest first
      operationId: list_policy_versions
      parameters:
      - name: policy_id
        in: path
        required: true
        schema:
          type: string
          title: Policy Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyVersionList'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/policy-evaluations:
    post:
      tags:
      - Policies
      summary: 'Dry run: would the calling key''s policies allow this send? Never executes'
      operationId: create_policy_evaluation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PolicyEvaluationCreate'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyEvaluation'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    PolicyUpdate:
      properties:
        name:
          anyOf:
          - type: string
            maxLength: 120
            minLength: 1
          - type: 'null'
          title: Name
        purpose:
          anyOf:
          - type: string
            maxLength: 500
          - type: 'null'
          title: Purpose
        rules:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Rules
        enabled:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Enabled
      additionalProperties: false
      type: object
      title: PolicyUpdate
    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
    PolicyVersion:
      properties:
        id:
          type: string
          title: Id
        policy_id:
          type: string
          title: Policy Id
        version:
          type: integer
          title: Version
        name:
          type: string
          title: Name
        purpose:
          anyOf:
          - type: string
          - type: 'null'
          title: Purpose
        enabled:
          type: boolean
          title: Enabled
        rules:
          additionalProperties: true
          type: object
          title: Rules
        created_by:
          type: string
          title: Created By
        created_at:
          type: string
          title: Created At
      additionalProperties: true
      type: object
      required:
      - id
      - policy_id
      - version
      - name
      - purpose
      - enabled
      - rules
      - created_by
      - created_at
      title: PolicyVersion
    PolicyEvaluationCreate:
      properties:
        quote_id:
          anyOf:
          - type: string
            pattern: ^[a-z]{2,8}_[0-9a-f]{32}$
          - type: 'null'
          title: Quote Id
          description: Evaluate an existing quote.
        document_id:
          anyOf:
          - type: string
            pattern: ^[a-z]{2,8}_[0-9a-f]{32}$
          - type: 'null'
          title: Document Id
          description: 'Or plan: this document ...'
        to:
          anyOf:
          - type: string
            maxLength: 32
          - type: 'null'
          title: To
          description: '... to this E.164 destination.'
        from:
          anyOf:
          - type: string
            maxLength: 32
          - type: 'null'
          title: From
      additionalProperties: false
      type: object
      title: PolicyEvaluationCreate
    Policy:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        purpose:
          anyOf:
          - type: string
          - type: 'null'
          title: Purpose
        enabled:
          type: boolean
          title: Enabled
        version:
          type: integer
          title: Version
        current_version_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Current Version Id
        rules:
          additionalProperties: true
          type: object
          title: Rules
        created_by:
          type: string
          title: Created By
        created_at:
          type: string
          title: Created At
        updated_at:
          type: string
          title: Updated At
      additionalProperties: true
      type: object
      required:
      - id
      - name
      - purpose
      - enabled
      - version
      - current_version_id
      - rules
      - created_by
      - created_at
      - updated_at
      title: Policy
    PolicyList:
      properties:
        items:
          items:
            $ref: '#/components/schemas/Policy'
          type: array
          title: Items
      additionalProperties: true
      type: object
      required:
      - items
      title: PolicyList
    PolicyCreate:
      properties:
        name:
          type: string
          maxLength: 120
          minLength: 1
          title: Name
        purpose:
          anyOf:
          - type: string
            maxLength: 500
          - type: 'null'
          title: Purpose
          description: Why this policy exists. Shown, never evaluated.
        rules:
          additionalProperties: true
          type: object
          title: Rules
          description: See the PolicyRules schema in docs/APPROVALS.md.
        enabled:
          type: boolean
          title: Enabled
          default: true
      additionalProperties: false
      type: object
      required:
      - name
      - rules
      title: PolicyCreate
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PolicyEvaluation:
      properties:
        decision:
          type: string
          title: Decision
        rule:
          anyOf:
          - type: string
          - type: 'null'
          title: Rule
        reason:
          type: string
          title: Reason
        policy_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Policy Id
        policy_version_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Policy Version Id
        policy_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Policy Name
        version:
          anyOf:
          - type: integer
          - type: 'null'
          title: Version
        denials:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Denials
        plan:
          additionalProperties: true
          type: object
          title: Plan
        executed:
          type: boolean
          title: Executed
          default: false
      additionalProperties: true
      type: object
      required:
      - decision
      - rule
      - reason
      - policy_id
      - policy_version_id
      - policy_name
      - version
      - denials
      - plan
      title: PolicyEvaluation
    PolicyVersionList:
      properties:
        items:
          items:
            $ref: '#/components/schemas/PolicyVersion'
          type: array
          title: Items
      additionalProperties: true
      type: object
      required:
      - items
      title: PolicyVersionList
    EffectivePolicies:
      properties:
        actor:
          type: string
          title: Actor
        environment:
          type: string
          enum:
          - live
          - test
          title: Environment
        under_policy:
          type: boolean
          title: Under Policy
        approval_required_without_policy:
          type: boolean
          title: Approval Required Without Policy
        policies:
          items:
            $ref: '#/components/schemas/Policy'
          type: array
          title: Policies
        rules_order:
          items:
            type: string
          type: array
          title: Rules Order
      additionalProperties: true
      type: object
      required:
      - actor
      - environment
      - under_policy
      - approval_required_without_policy
      - policies
      - rules_order
      title: EffectivePolicies
x-refined-from:
- faxforagents-api-openapi.json
- faxforagents-site-openapi.json