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

# Spreedly API

Spreedly API provides programmatic access to developer tools functionality. The API exposes 40 endpoints secured with basic authentication.

## For AI agents

Programmatically list supported gateways, create gateway. Covers 40 operations with basic authentication.

## Scope

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

## Capabilities

- List supported gateways
- Create gateway
- Show gateway
- Update a gateway
- Retain
- Redact

## Use cases

### Developer Tools Operations

Use the Spreedly API to perform developer tools operations programmatically. The API provides 40 endpoints covering core functionality including list supported gateways, create gateway, list created gateways.

Example prompt: Call GET /gateways_options.json to list supported gateways

### Automated gateways Management

Automate gateways operations by combining multiple Spreedly API endpoints. Agents can create gateway and then list created gateways in a single workflow.

Example prompt: Call POST /gateways.json to create gateway, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Spreedly 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 basic tokens manually.

Example prompt: Search Jentic for 'list supported gateways', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/gateways_options.json` | List supported gateways |
| POST | `/gateways.json` | Create gateway |
| GET | `/gateways.json` | List created gateways |
| GET | `/gateways/{gateway_token}.json` | Show gateway |
| PUT | `/gateways/{gateway_token}.json` | Update a gateway |
| PUT | `/gateways/{gateway_token}/retain.json` | Retain |
| PUT | `/gateways/{gateway_token}/redact.json` | Redact |
| GET | `/gateways/{gateway_token}/transactions.json` | Transactions |

## Key resources

- **gateways** — Gateways
- **receivers** — Payment Method Receivers
- **payment_methods** — Payment Methods
- **certificates** — Certificates
- **transactions** — Transactions

## Why Jentic

- **Setup:** Wiring the Spreedly API by hand means setting up its HTTP basic auth with your environment key and access secret, and pointing every call at the core.spreedly.com/v1 host yourself. Through Jentic you install once, import the Spreedly API from the API Directory, store the basic credential once, and your agent calls it.
- **Permission scoping:** Spreedly puts the gateway token in the URL path (`/gateways/{gateway_token}.json`), so a rule can pin your agent to one gateway and the reads around it. You choose the operations it may call, so state changes like redacting a gateway are not included unless you add them.
- **Credential handling:** Your Spreedly basic credential 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 'list supported gateways' or 'get a gateway's transactions', and Jentic returns the matching Spreedly API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the Spreedly API use?

The Spreedly API uses HTTP Basic authentication with username and password. 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 list supported gateways with the Spreedly API?

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

### What are the rate limits for the Spreedly 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 list supported gateways through Jentic?

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

### How many endpoints does the Spreedly API have?

The Spreedly API exposes 40 endpoints covering gateways, receivers, payment_methods operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Spreedly API operations and credentials the agent may use. Since Spreedly puts the gateway token in the URL path (`/gateways/{gateway_token}.json`), you can pin the agent to a single gateway and the reads around it, such as GET `/gateways/{gateway_token}.json` and GET `/gateways/{gateway_token}/transactions.json.` You choose which operations are allowed, so state changes like PUT `/gateways/{gateway_token}/redact.json` stay out of reach unless you add them.