canonical: https://jentic.com/apis/sendsafely.com/sendsafely

# SendSafely REST API

The SendSafely REST API provides programmatic access to SendSafely for sending and receiving encrypted files. The API uses API key and HMAC signature-based authentication. The base URL is your SendSafely host (e.g. https://companyname.sendsafely.com or https://www.sendsafely.com) followed by `/api/v2.0.` The API exposes 36 endpoints secured with apiKey authentication.

## For AI agents

Programmatically verify API credentials, verify API version. Covers 36 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for storage and databases only.

## Capabilities

- Verify API credentials
- Get user information
- Add dropzone recipient
- Query and filter SendSafely REST API records by parameters
- Monitor SendSafely REST API operational status and events

## Use cases

### Storage and Databases Operations

Use the SendSafely REST API to perform storage operations programmatically. The API provides 36 endpoints covering core functionality including verify API credentials, verify API version, get user information.

Example prompt: Call GET `/config/verify-credentials`/ to verify API credentials

### Automated config Management

Automate config operations by combining multiple SendSafely REST API endpoints. Agents can verify API version and then get user information in a single workflow.

Example prompt: Call GET `/config/version/{platform}/{versionNo}`/ to verify API version, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call SendSafely REST API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'verify API credentials', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/config/verify-credentials/` | Verify API credentials |
| GET | `/config/version/{platform}/{versionNo}/` | Verify API version |
| GET | `/user/` | Get user information |
| GET | `/user/dropzone-recipients/` | Get dropzone recipients |
| PUT | `/user/dropzone-recipients/` | Add dropzone recipient |
| GET | `/user/groups/` | Get contact groups |
| GET | `/enterprise/` | Get enterprise information |
| GET | `/package/` | List active packages |

## Key resources

- **config** — Configuration and verification operations
- **user** — User information and settings
- **enterprise** — Enterprise information
- **packages** — Package management operations
- **recipients** — Recipient management operations

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 60 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 71 / 100
  - Developer Experience & Jentic Compatibility: 56 / 100
  - AI-Readiness & Agent Experience: 45 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 76 / 100
- **View full report:** https://jentic.com/apis/sendsafely.com/sendsafely/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring SendSafely by hand means putting your own hostname into the base URL, sending the ss-api-key header, and computing the HMAC-SHA256 request signature and timestamp for every call yourself. Through Jentic you install once, import SendSafely from the API Directory, store the key and secret once, and your agent calls it.
- **Permission scoping:** SendSafely puts the package id in the URL path (`/package/{packageId}/...`), so a rule can pin your agent to one package: it can read that package's files and activity and nothing else. You choose the operations it may call, so file deletion or package finalize is not included unless you add it.
- **Credential handling:** Your SendSafely key and secret are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'verify API credentials' or 'list files in a package', and Jentic returns the matching SendSafely operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Dropbox** — Alternative storage API
- **Box** — Alternative storage API
- **Amazonaws** — Complementary storage API

## FAQ

### What authentication does the SendSafely REST API use?

The SendSafely REST API uses an API key passed in the `ss-api-key` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I verify API credentials with the SendSafely REST API?

Yes. Use the GET `/config/verify-credentials`/ endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the SendSafely REST API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I verify API credentials through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'verify API credentials'. Jentic returns the matching SendSafely REST API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the SendSafely REST API have?

The SendSafely REST API exposes 36 endpoints covering config, user, enterprise operations.

### Can I limit what my agent is allowed to do with the SendSafely REST API?

Yes. Jentic One is self-hosted by you, so your own rules decide which SendSafely operations and credentials the agent may use. Because SendSafely puts the package id in the URL path (`/package/{packageId}/...`), you can pin the agent to a single package so it only reads that package's files and activity and nothing else. You pick the operations it may call, so actions like file deletion or package finalize stay out of reach unless you add them.