---
canonical_url: "https://docs.composio.dev/toolkits/onesimpleapi"
markdown_url: "https://docs.composio.dev/toolkits/onesimpleapi.md"
product: "platform"
version: null
last_updated: null
---

# OneSimpleAPI

OneSimpleAPI provides utility APIs for web content, images, PDFs, QR codes, URL management, validation, exchange rates, and file management.

- **Category:** developer tools
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 15
- **Triggers:** 0
- **Slug:** `ONESIMPLEAPI`
- **Version:** 00000000_00

## Tools

### Analyze Readability

**Slug:** `ONESIMPLEAPI_ANALYZE_READABILITY`

Analyze text for readability, grade level, reading time, difficult-word counts, and sentiment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | Text to analyze for readability, reading time, and sentiment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Calculate PPP Discount

**Slug:** `ONESIMPLEAPI_CALCULATE_PPP_DISCOUNT`

Calculate a purchasing-power-parity discount and localized price between an origin and a destination country.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `price` | number | Yes | Positive base price to localize. |
| `max_discount` | number | No | Maximum discount percentage. |
| `destination_user_ip` | string | No | Destination user's IPv4 or IPv6 address. Provide exactly one of this field or destination_country_code. |
| `origin_country_code` | string | Yes | Two-letter ISO country code where the base price applies. |
| `destination_country_code` | string | No | Two-letter ISO destination country code. Provide exactly one of this field or destination_user_ip. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Capture Screenshot

**Slug:** `ONESIMPLEAPI_CAPTURE_SCREENSHOT`

Capture a webpage URL or raw HTML as a hosted screenshot and return its URL and rendering metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Public webpage URL to capture; provide this or html. |
| `html` | string | No | Raw HTML to capture; provide this or url. |
| `force` | boolean | No | Force a fresh capture rather than reuse a cached result. |
| `screen` | string | No | Viewport preset (retina, phone, phone-landscape, tablet, tablet-landscape, 4k, or 8k) or custom:WIDTHxHEIGHT in pixels. |
| `full_page` | boolean | No | Capture the full scrollable page rather than only the viewport. |
| `background` | boolean | No | Include page background rendering. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Convert Currency

**Slug:** `ONESIMPLEAPI_CONVERT_CURRENCY`

Convert an amount between supported currencies and return the converted value and exchange rate.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `from_value` | number | No | Amount in the source currency to convert. |
| `to_currency` | string | Yes | Three-letter destination currency code, such as EUR. |
| `from_currency` | string | No | Three-letter source currency code. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Short URL

**Slug:** `ONESIMPLEAPI_CREATE_SHORT_URL`

Create a OneSimpleAPI short URL with optional one-time-use, redirect, query-forwarding, and active-date controls.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Destination HTTP or HTTPS URL. |
| `end_date` | string | No | Optional ISO date when the short URL stops being active. |
| `single_use` | boolean | No | Whether the short URL should work only once. |
| `start_date` | string | No | Optional ISO date when the short URL becomes active. |
| `forward_params` | boolean | No | Whether incoming query parameters should be forwarded to the destination. |
| `temporary_redirect` | boolean | No | Whether redirects should be temporary rather than permanent. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete File

**Slug:** `ONESIMPLEAPI_DELETE_FILE`

Delete a generated OneSimpleAPI file by its hosted URL and return the updated file record.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Generated file URL returned by a creation tool or List Files. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Expand Short URL

**Slug:** `ONESIMPLEAPI_EXPAND_SHORT_URL`

Resolve a shortened URL and return its final URL, redirect count, and redirect trace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Shortened HTTP or HTTPS URL to resolve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate or Convert Color

**Slug:** `ONESIMPLEAPI_GENERATE_OR_CONVERT_COLOR`

Generate a deterministic color palette from text or convert a supplied color into HEX, RGB, HSL, and related palette values.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hue` | number | No | Optional palette hue adjustment from 0 through 360. |
| `text` | string | No | Text used to deterministically generate a color and palette; provide this or color. |
| `color` | string | No | HEX or rgb() color to convert; provide this or text. |
| `lightness` | number | No | Optional palette lightness adjustment from 0 through 1. |
| `saturation` | number | No | Optional palette saturation adjustment from 0 through 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate PDF

**Slug:** `ONESIMPLEAPI_GENERATE_PDF`

Generate a PDF from either a webpage URL or raw HTML and return the hosted PDF URL and page metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Public webpage URL to convert; provide this or html. |
| `html` | string | No | Raw HTML to convert. Use this instead of url; do not provide both fields. |
| `page` | string ("Letter" | "Legal" | "Tabloid" | "Ledger" | "A0" | "A1" | "A2" | "A3" | "A4" | "A5" | "A6") | No | PDF page size. |
| `force` | boolean | No | Force regeneration rather than reuse a cached result. |
| `background` | boolean | No | Include page backgrounds in the PDF; disabled by default. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate QR Code

**Slug:** `ONESIMPLEAPI_GENERATE_QR_CODE`

Generate a hosted PNG or SVG QR code for a message and return its URL.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | string ("small" | "medium" | "large") | No | Generated QR code size. |
| `color` | string | No | Foreground color in hexadecimal, RGB, or RGBA notation. |
| `format` | string ("png" | "svg") | No | Generated image format. |
| `message` | string | Yes | Text, URL, phone number, or other message to encode in the QR code. |
| `background` | string | No | Background color in hexadecimal, RGB, or RGBA notation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Image Information

**Slug:** `ONESIMPLEAPI_GET_IMAGE_INFORMATION`

Extract dimensions, image metadata, EXIF camera fields, and available GPS details from an image URL. Returned fields vary with the metadata embedded in the image.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `raw` | boolean | No | Whether to include raw metadata in addition to normalized fields. |
| `url` | string | Yes | Publicly reachable image URL to inspect. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Files

**Slug:** `ONESIMPLEAPI_LIST_FILES`

Return one page of generated files owned by the connected account, optionally filtered by live or deleted status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | string ("live" | "deleted") | No | Optional lifecycle status to filter files by. |
| `next_cursor` | string | No | Cursor from a previous response; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Short URLs

**Slug:** `ONESIMPLEAPI_LIST_SHORT_URLS`

Return one page of OneSimpleAPI short URLs and their click statistics.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `next_cursor` | string | No | Cursor from a previous response; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Transform Image

**Slug:** `ONESIMPLEAPI_TRANSFORM_IMAGE`

Resize, crop, rotate, flip, filter, border, optimize, and host an image, returning the generated image URL and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `crop` | string | No | Crop size, such as 200x150, or a supported social-media size. |
| `flip` | string ("v" | "h" | "vh") | No | Flip vertically, horizontally, or on both axes. |
| `page` | integer | No | One-based page number to convert when the source is a multi-page PDF. |
| `size` | string | No | Output size, such as 200x150, 200w, 150h, or a supported social-media size. |
| `force` | boolean | No | Whether to regenerate the image instead of reusing a cached transform. |
| `image` | string | Yes | Source image URL or provider-supported base64 image value. |
| `border` | integer | No | Border width in pixels. |
| `crop_x` | number | No | Horizontal crop coordinate used with offset or focal crop mode. |
| `crop_y` | number | No | Vertical crop coordinate used with offset or focal crop mode. |
| `format` | string ("webp" | "jpg" | "png") | No | Generated image format. |
| `rotate` | string ("auto" | "90" | "180" | "270") | No | Rotation to apply to the generated image. |
| `filters` | string | No | Comma-separated filters: grayscale, sepia, or name:value using blur and sharpen from 0 to 100, brightness and contrast from -100 to 100, gamma from 0.01 to 9.99, or pixelate from 0 to 1000. |
| `optimize` | boolean | No | Whether to optimize the generated image for size and performance. |
| `crop_mode` | string ("top" | "top-left" | "top-right" | "center" | "center-left" | "center-right" | "bottom" | "bottom-left" | "bottom-right" | "offset" | "focal") | No | Crop strategy, such as center, top-left, offset, or focal. Use offset or focal with crop_x and crop_y. |
| `resize_mode` | string ("contain" | "size-limit" | "forced") | No | How to fit the source into the requested size. |
| `border_color` | string | No | Border color as an HTML color name or hexadecimal color. |
| `border_method` | string ("overlay" | "expand" | "shrink") | No | How the border affects the output image dimensions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validate Email

**Slug:** `ONESIMPLEAPI_VALIDATE_EMAIL`

Validate an email address and assess its domain, MX records, deliverability, disposability, role status, and registration safety.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Email address to validate. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |