Fax for Agents

Fax for Agents Agents API

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

GitHub OpenAPI

Operations 6

GET /v1/agents List agent identities #
POST /v1/agents Register an agent identity #
GET /v1/agents/{agent_id} Read an agent with its keys and budgets #
PATCH /v1/agents/{agent_id} Change an agent; disabling revokes its keys #
POST /v1/agents/{agent_id}/keys Mint a key for the agent (bounded scopes, secret shown once) #
GET /v1/agents/{agent_id}/activity The agent's audit trail #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/faxforagents/openapi/faxforagents-agents-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-agents-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-agents-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Faxforagents Agents 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 agents 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: Agents
paths:
  /v1/agents:
    get:
      tags:
      - Agents
      summary: List agent identities
      operationId: list_agents
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentList'
    post:
      tags:
      - Agents
      summary: Register an agent identity
      operationId: create_agent
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgentCreate'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Agent'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/agents/{agent_id}:
    get:
      tags:
      - Agents
      summary: Read an agent with its keys and budgets
      operationId: get_agent
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Agent'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    patch:
      tags:
      - Agents
      summary: Change an agent; disabling revokes its keys
      operationId: update_agent
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgentUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Agent'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/agents/{agent_id}/keys:
    post:
      tags:
      - Agents
      summary: Mint a key for the agent (bounded scopes, secret shown once)
      operationId: create_agent_key
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgentKeyCreate'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyWithSecret'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/agents/{agent_id}/activity:
    get:
      tags:
      - Agents
      summary: The agent's audit trail
      operationId: get_agent_activity
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          title: Agent Id
      - 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/AgentActivityPage'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    AgentKeyCreate:
      properties:
        label:
          type: string
          maxLength: 120
          minLength: 1
          title: Label
          default: agent key
        environment:
          type: string
          enum:
          - live
          - test
          title: Environment
          default: test
        scopes:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Scopes
          description: Omit for the default agent set. Never approval:decide, key:admin, policy:admin, agent:admin.
        expires_in_days:
          anyOf:
          - type: integer
            maximum: 3650.0
            minimum: 1.0
          - type: 'null'
          title: Expires In Days
      additionalProperties: false
      type: object
      title: AgentKeyCreate
    AgentActivityPage:
      properties:
        items:
          items:
            $ref: '#/components/schemas/AgentActivity'
          type: array
          title: Items
        next_cursor:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Cursor
      additionalProperties: true
      type: object
      required:
      - items
      title: AgentActivityPage
    ApiKeyWithSecret:
      properties:
        id:
          type: string
          title: Id
        label:
          type: string
          title: Label
        prefix:
          type: string
          title: Prefix
        environment:
          type: string
          enum:
          - live
          - test
          title: Environment
        project_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Id
        agent_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Agent Id
        scopes:
          items:
            type: string
          type: array
          title: Scopes
        created_at:
          type: string
          title: Created At
        last_used_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Used At
        expires_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Expires At
        revoked_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Revoked At
        rotated_from_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Rotated From Id
        secret:
          type: string
          title: Secret
          description: Shown once. Store it now; it cannot be read back.
      additionalProperties: true
      type: object
      required:
      - id
      - label
      - prefix
      - environment
      - project_id
      - agent_id
      - scopes
      - created_at
      - last_used_at
      - expires_at
      - revoked_at
      - rotated_from_id
      - secret
      title: ApiKeyWithSecret
    AgentUpdate:
      properties:
        name:
          anyOf:
          - type: string
            maxLength: 120
            minLength: 1
          - type: 'null'
          title: Name
        purpose:
          anyOf:
          - type: string
            maxLength: 500
          - type: 'null'
          title: Purpose
        enabled:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Enabled
          description: false revokes every key of the agent.
        policy_ids:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Policy Ids
        contact_email:
          anyOf:
          - type: string
            maxLength: 254
          - type: 'null'
          title: Contact Email
      additionalProperties: false
      type: object
      title: AgentUpdate
    Agent:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        purpose:
          anyOf:
          - type: string
          - type: 'null'
          title: Purpose
        enabled:
          type: boolean
          title: Enabled
        status:
          type: string
          title: Status
        project_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Id
        policy_ids:
          items:
            type: string
          type: array
          title: Policy Ids
        contact_email:
          anyOf:
          - type: string
          - type: 'null'
          title: Contact Email
        budget_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Budget Id
        budgets:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Budgets
        keys:
          items:
            $ref: '#/components/schemas/ApiKey'
          type: array
          title: Keys
        created_by:
          type: string
          title: Created By
        created_at:
          type: string
          title: Created At
        updated_at:
          type: string
          title: Updated At
        disabled_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Disabled At
      additionalProperties: true
      type: object
      required:
      - id
      - name
      - purpose
      - enabled
      - status
      - project_id
      - policy_ids
      - contact_email
      - budget_id
      - budgets
      - keys
      - created_by
      - created_at
      - updated_at
      - disabled_at
      title: Agent
    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
    AgentCreate:
      properties:
        name:
          type: string
          maxLength: 120
          minLength: 1
          title: Name
        purpose:
          anyOf:
          - type: string
            maxLength: 500
          - type: 'null'
          title: Purpose
          description: Shown to humans, never evaluated.
        policy_ids:
          items:
            type: string
          type: array
          title: Policy Ids
        contact_email:
          anyOf:
          - type: string
            maxLength: 254
          - type: 'null'
          title: Contact Email
          description: Where decided approvals are mailed.
      additionalProperties: false
      type: object
      required:
      - name
      title: AgentCreate
    AgentList:
      properties:
        items:
          items:
            $ref: '#/components/schemas/Agent'
          type: array
          title: Items
      additionalProperties: true
      type: object
      required:
      - items
      title: AgentList
    ApiKey:
      properties:
        id:
          type: string
          title: Id
        label:
          type: string
          title: Label
        prefix:
          type: string
          title: Prefix
        environment:
          type: string
          enum:
          - live
          - test
          title: Environment
        project_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Id
        agent_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Agent Id
        scopes:
          items:
            type: string
          type: array
          title: Scopes
        created_at:
          type: string
          title: Created At
        last_used_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Used At
        expires_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Expires At
        revoked_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Revoked At
        rotated_from_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Rotated From Id
      additionalProperties: true
      type: object
      required:
      - id
      - label
      - prefix
      - environment
      - project_id
      - agent_id
      - scopes
      - created_at
      - last_used_at
      - expires_at
      - revoked_at
      - rotated_from_id
      title: ApiKey
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    AgentActivity:
      properties:
        id:
          type: string
          title: Id
        actor:
          type: string
          title: Actor
        action:
          type: string
          title: Action
        resource_type:
          type: string
          title: Resource Type
        resource_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Resource Id
        data:
          additionalProperties: true
          type: object
          title: Data
        correlation_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Correlation Id
        created_at:
          type: string
          title: Created At
      additionalProperties: true
      type: object
      required:
      - id
      - actor
      - action
      - resource_type
      - resource_id
      - data
      - correlation_id
      - created_at
      title: AgentActivity
x-refined-from:
- faxforagents-api-openapi.json
- faxforagents-site-openapi.json