canonical: https://jentic.com/apis/sublime.security/sublime-security-api

# Sublime Security API

Email security platform API for message analysis, threat detection, and automated response actions. The API exposes 43 endpoints secured with bearer authentication.

## For AI agents

Programmatically upload binary for analysis, retrieve binexplode scan results. Covers 43 operations with bearer authentication.

## Scope

Does not handle payments, crm, or developer tools - use for communications only.

## Capabilities

- Upload binary for analysis
- Retrieve binexplode scan results
- Analyze links using ML functionality
- List audit log events
- Initiate hunt operation

## Use cases

### Communications Operations

Use the Sublime Security API to perform communications operations programmatically. The API provides 43 endpoints covering core functionality including upload binary for analysis, retrieve binexplode scan results, analyze links using ml functionality.

Example prompt: Call POST /scan to upload binary for analysis

### Automated BinExplode Management

Automate binexplode operations by combining multiple Sublime Security API endpoints. Agents can retrieve binexplode scan results and then analyze links using ml functionality in a single workflow.

Example prompt: Call GET `/scan/{id}` to retrieve binexplode scan results, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Sublime Security 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 bearer tokens manually.

Example prompt: Search Jentic for 'upload binary for analysis', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/scan` | Upload binary for analysis |
| GET | `/scan/{id}` | Retrieve binexplode scan results |
| POST | `/link-analysis/evaluate` | Analyze links using ML functionality |
| GET | `/events` | List audit log events |
| GET | `/event-types` | List event types |
| GET | `/events/{id}` | Retrieve specific event |
| POST | `/hunts` | Initiate hunt operation |
| GET | `/hunts/{id}` | Retrieve hunt job status |

## Key resources

- **BinExplode** — Binary file analysis endpoints
- **Enrichment** — Link and content enrichment
- **Audit Log** — Audit event tracking
- **Hunt Jobs** — Threat hunting operations
- **Lists** — Manage allow/block lists

## 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:** 57 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 76 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 47 / 100
  - Agent Usability: 94 / 100
  - Security: 75 / 100
  - AI Discoverability: 27 / 100
- **View full report:** https://jentic.com/apis/sublime.security/sublime-security-api/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 the Sublime Security API by hand means handling its bearer JWT auth and picking the right regional host among the US, Canada, UK, EU, and Australia endpoints yourself. Through Jentic you install once, import the Sublime Security API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Sublime Security puts the resource id in the URL path (`/scan/{id}`, `/hunts/{id}`), so a rule can pin your agent to one scan or hunt: it reads that record and nothing else. You choose the operations it may call, so starting a new scan or creating a hunt is not included unless you add it.
- **Credential handling:** Your Sublime Security token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'scan a message' or 'evaluate a link', and Jentic returns the matching Sublime Security operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Twilio** — Alternative communications API
- **Sendgrid** — Alternative communications API
- **Pusher** — Complementary communications API

## FAQ

### What authentication does the Sublime Security API use?

The Sublime Security API uses a Bearer token in the Authorization 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 upload binary for analysis with the Sublime Security API?

Yes. Use the POST /scan endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Sublime Security 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 upload binary for analysis through Jentic?

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

### How many endpoints does the Sublime Security API have?

The Sublime Security API exposes 43 endpoints covering binexplode, enrichment, audit log operations.

### Can I limit what my agent is allowed to do with the Sublime Security API?

Yes. Because Jentic One is self-hosted, you write the rules that decide which Sublime Security operations and credentials your agent may use. Since resource ids sit in the URL path, such as `/scan/{id}` and `/hunts/{id}`, you can pin the agent to a single scan or hunt so it reads that record and nothing else. You choose the operations it may call, so starting a new scan with POST /scan or creating a hunt with POST /hunts stays off limits unless you add it.