SendFrame API

SendFrame API as documented publicly: 26 operations. Contract generated from the documentation by API Evangelist (2026-11-10); not the provider's own document.

GitHub OpenAPI

Operations 26

GET /api/v1 GET /api/v1 returns this route table as JSON. #
POST /api/v1/artifacts Upload an artifact via REST #
GET /artifacts Every artifact, with status and finding counts. #
POST /artifacts Upload. multipart/form-data with a file part; optional title. #
GET /artifacts/{id} One artifact and where it stands: its status, its versions with the served one marked, findings by severity, and the shares sent from it. #
GET /artifacts/{id}/findings The safety review, and what is currently redacted. #
POST /artifacts/{id}/findings/{findingid}/redact Hide one finding again. Takes effect on the next fetch. #
POST /artifacts/{id}/findings/{findingid}/unredact Clear one redaction, so the recipient sees it from now on. #
POST /artifacts/{id}/process Convert, scan and detect the NEWEST version. REQUIRED before an artifact can be shared. #
POST /artifacts/{id}/share Send. #
GET /artifacts/{id}/versions Every version of one artifact, newest first, saying which one recipients are being served right now. #
POST /artifacts/{id}/versions Upload a new version of an existing artifact, so that shares already sent can serve it without a new link. #
POST /recipients/{id}/erase Erase everything about one named recipient — their address, their link, every view and everything they wrote. #
POST /recipients/{id}/notify Send one recipient their existing link again, by email. #
POST /recipients/{id}/revoke Kill one recipient's link, leaving the rest live. #
GET /shares Every share this organization has sent, with how many recipients have opened each one. #
GET /shares/{id} Recipients, status and engagement for one share. #
POST /shares/{id}/access Turn download or print on or off for one share. #
GET /shares/{id}/delivered EXACTLY what a verified recipient receives, produced by the same function the viewer calls. #
GET /shares/{id}/events The unified event feed. #
POST /shares/{id}/expiry Set or clear the expiry on a live share. #
POST /shares/{id}/recipients Add recipients to a share that already exists, so "loop in their boss" does not need a second send. #
GET /shares/{id}/recipients/{recipientid} One recipient's visits: each session with its derived time and the pages it entered, time per page for that recipient alone, and their download count. #
POST /shares/{id}/release Release a share held under require_human_release. #
POST /shares/{id}/revoke Kill a share. Every recipient link stops resolving immediately. #
GET /shares/{id}/state Interactive state recipients wrote. #

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/getsendframe-com:getsendframe-com-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

getsendframe-com-openapi-generated.yml Raw ↑
openapi: 3.1.0
info:
  title: SendFrame API
  version: '2026-11-10'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-10: 26 operation(s) read from 2 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; SendFrame has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 0
    documentation: 26
    pages-with-code: 0
    pages-read: 2
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-10'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.getsendframe.com/api
  - https://docs.getsendframe.com/claude
servers:
- url: https://app.getsendframe.com/api/v1
paths:
  /api/v1:
    get:
      operationId: get_api_v1
      tags:
      - Api
      summary: GET /api/v1 returns this route table as JSON.
      x-source: https://docs.getsendframe.com/api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/artifacts:
    post:
      operationId: post_api_v1_artifacts
      tags:
      - Api
      summary: Upload an artifact via REST
      x-source: https://docs.getsendframe.com/claude
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1ArtifactsRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /artifacts:
    get:
      operationId: get_artifacts
      tags:
      - Artifacts
      summary: Every artifact, with status and finding counts.
      x-source: https://docs.getsendframe.com/api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_artifacts
      tags:
      - Artifacts
      summary: Upload. multipart/form-data with a file part; optional title.
      x-source: https://docs.getsendframe.com/api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostArtifactsRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /artifacts/{id}:
    get:
      operationId: get_artifacts_id
      tags:
      - Artifacts
      summary: 'One artifact and where it stands: its status, its versions with the served one marked, findings by severity, and the shares sent
        from it.'
      x-source: https://docs.getsendframe.com/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /artifacts/{id}/findings:
    get:
      operationId: get_artifacts_id_findings
      tags:
      - Artifacts
      summary: The safety review, and what is currently redacted.
      x-source: https://docs.getsendframe.com/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /artifacts/{id}/findings/{findingid}/redact:
    post:
      operationId: post_artifacts_id_findings_findingid_redact
      tags:
      - Artifacts
      summary: Hide one finding again. Takes effect on the next fetch.
      x-source: https://docs.getsendframe.com/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: findingid
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /artifacts/{id}/findings/{findingid}/unredact:
    post:
      operationId: post_artifacts_id_findings_findingid_unredact
      tags:
      - Artifacts
      summary: Clear one redaction, so the recipient sees it from now on.
      x-source: https://docs.getsendframe.com/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: findingid
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /artifacts/{id}/process:
    post:
      operationId: post_artifacts_id_process
      tags:
      - Artifacts
      summary: Convert, scan and detect the NEWEST version. REQUIRED before an artifact can be shared.
      x-source: https://docs.getsendframe.com/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /artifacts/{id}/share:
    post:
      operationId: post_artifacts_id_share
      tags:
      - Artifacts
      summary: Send.
      x-source: https://docs.getsendframe.com/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostArtifactsIdShareRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /artifacts/{id}/versions:
    get:
      operationId: get_artifacts_id_versions
      tags:
      - Artifacts
      summary: Every version of one artifact, newest first, saying which one recipients are being served right now.
      x-source: https://docs.getsendframe.com/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_artifacts_id_versions
      tags:
      - Artifacts
      summary: Upload a new version of an existing artifact, so that shares already sent can serve it without a new link.
      x-source: https://docs.getsendframe.com/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostArtifactsIdVersionsRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /recipients/{id}/erase:
    post:
      operationId: post_recipients_id_erase
      tags:
      - Recipients
      summary: Erase everything about one named recipient — their address, their link, every view and everything they wrote.
      description: Erases all data about the specified recipient. The recipient must be revoked first; otherwise the request is refused. The operation
        records the request and the actual deletion occurs on the next purge run. The response indicates that the erasure is scheduled and lists
        surviving audit information.
      x-source: https://docs.getsendframe.com/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostRecipientsIdEraseResponse'
      x-evidence:
        kind: documentation
  /recipients/{id}/notify:
    post:
      operationId: post_recipients_id_notify
      tags:
      - Recipients
      summary: Send one recipient their existing link again, by email.
      x-source: https://docs.getsendframe.com/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /recipients/{id}/revoke:
    post:
      operationId: post_recipients_id_revoke
      tags:
      - Recipients
      summary: Kill one recipient's link, leaving the rest live.
      x-source: https://docs.getsendframe.com/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /shares:
    get:
      operationId: get_shares
      tags:
      - Shares
      summary: Every share this organization has sent, with how many recipients have opened each one.
      x-source: https://docs.getsendframe.com/api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /shares/{id}:
    get:
      operationId: get_shares_id
      tags:
      - Shares
      summary: Recipients, status and engagement for one share.
      x-source: https://docs.getsendframe.com/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSharesIdResponse'
      x-evidence:
        kind: documentation
  /shares/{id}/access:
    post:
      operationId: post_shares_id_access
      tags:
      - Shares
      summary: Turn download or print on or off for one share.
      x-source: https://docs.getsendframe.com/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostSharesIdAccessRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /shares/{id}/delivered:
    get:
      operationId: get_shares_id_delivered
      tags:
      - Shares
      summary: EXACTLY what a verified recipient receives, produced by the same function the viewer calls.
      x-source: https://docs.getsendframe.com/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSharesIdDeliveredResponse'
      x-evidence:
        kind: documentation
  /shares/{id}/events:
    get:
      operationId: get_shares_id_events
      tags:
      - Shares
      summary: The unified event feed.
      x-source: https://docs.getsendframe.com/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: since
        in: query
        required: false
        schema:
          type: string
        description: Cursor for pagination.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSharesIdEventsResponse'
      x-evidence:
        kind: documentation
  /shares/{id}/expiry:
    post:
      operationId: post_shares_id_expiry
      tags:
      - Shares
      summary: Set or clear the expiry on a live share.
      x-source: https://docs.getsendframe.com/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostSharesIdExpiryRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /shares/{id}/recipients:
    post:
      operationId: post_shares_id_recipients
      tags:
      - Shares
      summary: Add recipients to a share that already exists, so "loop in their boss" does not need a second send.
      x-source: https://docs.getsendframe.com/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostSharesIdRecipientsRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /shares/{id}/recipients/{recipientid}:
    get:
      operationId: get_shares_id_recipients_recipientid
      tags:
      - Shares
      summary: 'One recipient''s visits: each session with its derived time and the pages it entered, time per page for that recipient alone,
        and their download count.'
      x-source: https://docs.getsendframe.com/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: recipientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSharesIdRecipientsRecipientidResponse'
      x-evidence:
        kind: documentation
  /shares/{id}/release:
    post:
      operationId: post_shares_id_release
      tags:
      - Shares
      summary: Release a share held under require_human_release.
      x-source: https://docs.getsendframe.com/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /shares/{id}/revoke:
    post:
      operationId: post_shares_id_revoke
      tags:
      - Shares
      summary: Kill a share. Every recipient link stops resolving immediately.
      x-source: https://docs.getsendframe.com/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /shares/{id}/state:
    get:
      operationId: get_shares_id_state
      tags:
      - Shares
      summary: Interactive state recipients wrote.
      x-source: https://docs.getsendframe.com/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSharesIdStateResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PostApiV1ArtifactsRequest:
      type: object
      properties:
        file:
          type: string
          description: File part (multipart/form-data)
        title:
          type: string
          description: Optional title
      required:
      - file
    PostArtifactsRequest:
      type: object
      properties:
        file:
          type: string
          description: File part (PowerPoint, Word, Excel, PDF, HTML, PNG or JPEG).
        title:
          type: string
          description: Optional title.
      required:
      - file
    PostArtifactsIdShareRequest:
      type: object
      properties:
        recipients:
          type: array
          description: Array of recipient identifiers.
        expiresAt:
          type: string
          description: Optional expiry timestamp.
        notify:
          type: boolean
          description: Optional notify flag.
        idempotencyKey:
          type: string
          description: Optional idempotency key.
      required:
      - recipients
    PostArtifactsIdVersionsRequest:
      type: object
      properties:
        file:
          type: string
          description: File part of any accepted kind (PowerPoint, Word, Excel, PDF, HTML, PNG or JPEG).
      required:
      - file
    PostRecipientsIdEraseResponse:
      type: object
      properties:
        status:
          type: string
          description: Indicates that the erase request is scheduled.
        survivingData:
          type: object
          description: What remains after erasure, such as de‑attributed document state, audit records with an internal id, and bounce suppression.
    GetSharesIdResponse:
      type: object
      properties:
        recipients:
          type: array
          description: List of recipients.
        status:
          type: string
          description: Current status of the share.
        engagement:
          type: object
          description: Engagement metrics.
    PostSharesIdAccessRequest:
      type: object
      properties:
        allowDownload:
          type: boolean
          description: Enable or disable download.
        allowPrint:
          type: boolean
          description: Enable or disable print.
    GetSharesIdDeliveredResponse:
      type: object
      properties:
        content:
          type: string
          description: Delivered file content.
    GetSharesIdEventsResponse:
      type: object
      properties:
        events:
          type: array
          description: List of events.
    PostSharesIdExpiryRequest:
      type: object
      properties:
        expiresAt:
          type: string
          description: ISO‑8601 timestamp or null to remove expiry.
      required:
      - expiresAt
    PostSharesIdRecipientsRequest:
      type: object
      properties:
        recipients:
          type: array
          description: Array of recipient objects.
        notify:
          type: boolean
          description: Whether to email the new recipients.
      required:
      - recipients
    GetSharesIdRecipientsRecipientidResponse:
      type: object
      properties:
        sessions:
          type: array
          description: Visit sessions for the recipient.
        downloadCount:
          type: integer
          description: Number of downloads by the recipient.
    GetSharesIdStateResponse:
      type: object
      properties:
        state:
          type: object
          description: Recipient‑written state.
tags:
- name: Api
- name: Artifacts
- name: Recipients
- name: Shares