# SendFrame API

**Canonical:** https://apis.io/apis/getsendframe-com/getsendframe-com-api/  
**Provider:** SendFrame — https://apis.io/providers/getsendframe-com/  
**Base URL:** https://app.getsendframe.com/api/v1  
**Documentation:** https://docs.getsendframe.com/api

SendFrame API is published by [SendFrame](https://apis.io/providers/getsendframe-com/) on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

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

## Operations (26)

| Method | Path | Summary |
|---|---|---|
| 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. |

## Machine-readable artifacts (8)

- **OpenAPI** — https://artifacts.apis.io/getsendframe-com/openapi/_ae-authored/getsendframe-com-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/getsendframe-com/json-schema/getsendframe-com-post-artifacts-id-share-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/getsendframe-com/json-schema/getsendframe-com-post-recipients-id-erase-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/getsendframe-com/json-schema/getsendframe-com-get-shares-id-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/getsendframe-com/json-schema/getsendframe-com-post-shares-id-recipients-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/getsendframe-com/json-schema/getsendframe-com-post-artifacts-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/getsendframe-com/json-schema/getsendframe-com-get-shares-id-recipients-recipientid-response-schema.json
- **APIsJSON** — https://artifacts.apis.io/getsendframe-com/apis.yml

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/getsendframe-com/getsendframe-com-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/getsendframe-com/.
