SignalWire

SignalWire Fax Media API

Manage fax media files.

Documentation GitHub OpenAPI

Operations 3

GET /Accounts/{AccountSid}/Faxes/{FaxSid}/Media List Fax Media #

GET /Accounts/{AccountSid}/Faxes/{FaxSid}/Media/{Sid} Retrieve Fax Media #

DELETE /Accounts/{AccountSid}/Faxes/{FaxSid}/Media/{Sid} Delete Fax Media #

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/signalwire-fax-media-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

openapi: 3.2.0
info:
  title: Compatibility Fax Media API
  version: 1.0.0
  description: Manage fax media files.
servers:
- url: https://{space_name}.signalwire.com/api/laml/2010-04-01
  description: SignalWire Compatibility API
  variables:
    space_name:
      default: YOUR_SPACE
      description: Your SignalWire Space name
security:
- SignalWireBasicAuth: []
tags:
- name: Fax Media
  description: Manage fax media files.
  externalDocs:
    url: https://signalwire.com/docs/compatibility-api/rest
    description: Developer documentation on the Compatibility REST API
paths:
  /Accounts/{AccountSid}/Faxes/{FaxSid}/Media:
    get:
      operationId: list_all_fax_media
      summary: List Fax Media
      description: 'List all media for a fax.


        #### Permissions


        The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Fax_.


        Learn more about API scopes.'
      parameters:
      - $ref: '#/components/parameters/FaxesAccountSidPath'
      - $ref: '#/components/parameters/FaxSidPathForMedia'
      - name: Page
        in: query
        required: false
        description: The page index to retrieve. Zero-indexed.
        schema:
          type: integer
          format: int32
          minimum: 0
          default: 0
        explode: false
      - name: PageSize
        in: query
        required: false
        description: The number of results per page. Default is 50, maximum is 1000.
        schema:
          type: integer
          format: int32
          minimum: 1
          maximum: 1000
          default: 50
        explode: false
      - name: PageToken
        in: query
        required: false
        description: Token for cursor-based pagination. Required when Page > 0.
        schema:
          type: string
        explode: false
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FaxMediaListResponse'
        '400':
          description: The request was invalid or cannot be processed. Check the error details for more information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
        '401':
          description: Authentication failed. Please verify your credentials and try again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
        '404':
          description: The requested resource was not found. Please verify the resource identifier.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
        '422':
          description: The request could not be processed due to validation errors. Check the error details for more information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
      tags:
      - Fax Media
  /Accounts/{AccountSid}/Faxes/{FaxSid}/Media/{Sid}:
    get:
      operationId: retrieve_medias
      summary: Retrieve Fax Media
      description: 'Retrieve media for a fax.


        #### Permissions


        The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Fax_.


        Learn more about API scopes.'
      parameters:
      - $ref: '#/components/parameters/FaxesAccountSidPath'
      - $ref: '#/components/parameters/FaxSidPathForMedia'
      - $ref: '#/components/parameters/FaxSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FaxMediaResponse'
        '400':
          description: The request was invalid or cannot be processed. Check the error details for more information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
        '401':
          description: Authentication failed. Please verify your credentials and try again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
        '404':
          description: The requested resource was not found. Please verify the resource identifier.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
      tags:
      - Fax Media
    delete:
      operationId: delete_fax_media
      summary: Delete Fax Media
      description: 'Delete media for a fax. Cannot delete media for a fax that is in progress (queued, processing, sending, or receiving).


        #### Permissions


        The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Fax_.


        Learn more about API scopes.'
      parameters:
      - $ref: '#/components/parameters/FaxesAccountSidPath'
      - $ref: '#/components/parameters/FaxSidPathForMedia'
      - $ref: '#/components/parameters/FaxSidPath'
      responses:
        '204':
          description: 204 No Content response.
        '400':
          description: The request was invalid or cannot be processed. Check the error details for more information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
        '401':
          description: Authentication failed. Please verify your credentials and try again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
        '404':
          description: The requested resource was not found. Please verify the resource identifier.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
        '409':
          description: The request conflicts with the current state of the resource. The operation cannot be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
      tags:
      - Fax Media
components:
  parameters:
    FaxesAccountSidPath:
      name: AccountSid
      in: path
      required: true
      description: The Project ID that uniquely identifies the Account.
      schema:
        $ref: '#/components/schemas/uuid'
    FaxSidPath:
      name: Sid
      in: path
      required: true
      description: The Fax ID that uniquely identifies the Fax.
      schema:
        $ref: '#/components/schemas/uuid'
    FaxSidPathForMedia:
      name: FaxSid
      in: path
      required: true
      description: The Fax ID that uniquely identifies the Fax.
      schema:
        $ref: '#/components/schemas/uuid'
  schemas:
    FaxMediaListResponse:
      type: object
      required:
      - uri
      - first_page_uri
      - next_page_uri
      - previous_page_uri
      - page
      - page_size
      - media
      - fax_media
      properties:
        uri:
          type: string
          description: The URI of the current page.
          examples:
          - /fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media?Page=0&PageSize=50
        first_page_uri:
          type: string
          description: The URI of the first page.
          examples:
          - /fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media?PageSize=50
        next_page_uri:
          anyOf:
          - type: string
          - type: 'null'
          description: The URI of the next page, or null if there are no more pages.
          examples:
          - null
        previous_page_uri:
          anyOf:
          - type: string
          - type: 'null'
          description: The URI of the previous page, or null if this is the first page.
          examples:
          - null
        page:
          type: integer
          format: int32
          description: The current page number.
          examples:
          - 0
        page_size:
          type: integer
          format: int32
          description: The number of items per page.
          examples:
          - 50
        media:
          type: array
          items:
            $ref: '#/components/schemas/FaxMedia'
          description: List of media.
        fax_media:
          type: array
          items:
            $ref: '#/components/schemas/FaxMedia'
          description: List of fax media (alias for media).
      unevaluatedProperties:
        not: {}
      description: Response containing a list of fax media.
    FaxMediaResponse:
      type: object
      required:
      - account_sid
      - content_type
      - date_created
      - date_updated
      - fax_sid
      - sid
      - uri
      - url
      properties:
        account_sid:
          type: string
          description: The unique identifier for the account.
          examples:
          - b3877c40-da60-4998-90ad-b792e98472ac
        content_type:
          type: string
          description: The content type of the media.
          examples:
          - application/pdf
        date_created:
          type: string
          description: The date, in ISO 8601 format, this media was created.
          examples:
          - '2018-11-26T20:00:00Z'
        date_updated:
          type: string
          description: The date, in ISO 8601 format, this media was updated.
          examples:
          - '2018-11-27T20:00:00Z'
        fax_sid:
          type: string
          description: The unique identifier for the fax.
          examples:
          - b3877c40-da60-4998-90ad-b792e98472fx
        sid:
          type: string
          description: The unique identifier for the media.
          examples:
          - b3877c40-da60-4998-90ad-b792e98472me
        uri:
          type: string
          description: The URI for the media.
          examples:
          - /fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media/b3877c40-da60-4998-90ad-b792e98472me.json
        url:
          type: string
          description: The URL for the media.
          examples:
          - /fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media/b3877c40-da60-4998-90ad-b792e98472me.json
      unevaluatedProperties:
        not: {}
      description: Response containing a single fax media.
    CompatibilityErrorResponse:
      type: object
      required:
      - code
      - message
      - more_info
      - status
      properties:
        code:
          type: integer
          format: int32
          description: Error code.
          examples:
          - 20003
        message:
          type: string
          description: Error message.
          examples:
          - Authentication failed
        more_info:
          type: string
          description: URL for more information about the error.
          examples:
          - https://signalwire.com/docs/compatibility-api/reference/errors
        status:
          type: integer
          format: int32
          description: HTTP status code.
          examples:
          - 401
      unevaluatedProperties:
        not: {}
      description: Error response model.
    uuid:
      type: string
      format: uuid
      description: Universal Unique Identifier.
    FaxMedia:
      type: object
      required:
      - account_sid
      - content_type
      - date_created
      - date_updated
      - fax_sid
      - sid
      - uri
      - url
      properties:
        account_sid:
          type: string
          description: The unique identifier for the account.
          examples:
          - b3877c40-da60-4998-90ad-b792e98472ac
        content_type:
          type: string
          description: The content type of the media.
          examples:
          - application/pdf
        date_created:
          type: string
          description: The date, in ISO 8601 format, this media was created.
          examples:
          - '2018-11-26T20:00:00Z'
        date_updated:
          type: string
          description: The date, in ISO 8601 format, this media was updated.
          examples:
          - '2018-11-27T20:00:00Z'
        fax_sid:
          type: string
          description: The unique identifier for the fax.
          examples:
          - b3877c40-da60-4998-90ad-b792e98472fx
        sid:
          type: string
          description: The unique identifier for the media.
          examples:
          - b3877c40-da60-4998-90ad-b792e98472me
        uri:
          type: string
          description: The URI for the media.
          examples:
          - /fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media/b3877c40-da60-4998-90ad-b792e98472me.json
        url:
          type: string
          description: The URL for the media.
          examples:
          - /fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media/b3877c40-da60-4998-90ad-b792e98472me.json
      unevaluatedProperties:
        not: {}
      description: Fax media model.
  securitySchemes:
    SignalWireBasicAuth:
      type: http
      scheme: Basic
      description: 'SignalWire Basic Authentication using Project ID and API Token.


        The client sends HTTP requests with the Authorization header containing

        the word Basic followed by a space and a base64-encoded string of project_id:token.

        The project ID will be used as the username and the API token as the password.


        Example:

        ```

        Authorization: Basic base64(project_id:token)

        ```'
      x-fern-basic:
        username:
          name: project_id
          env: SIGNALWIRE_PROJECT_ID
        password:
          name: api_token
          env: SIGNALWIRE_API_TOKEN