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

# Orshot

Orshot generates images, PDFs, and videos from templates and manages workspace templates, brand assets, and social publishing.

- **Category:** ai content generation
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 8
- **Triggers:** 0
- **Slug:** `ORSHOT`
- **Version:** 00000000_00

## Tools

### Add Brand Color

**Slug:** `ORSHOT_ADD_BRAND_COLOR`

Save a hex, RGB, HSL, or gradient color to the workspace brand assets and return its new ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | No | Optional tags to associate with the saved color. |
| `value` | string | Yes | Color value in the syntax selected by color_type: #RGB, #RRGGBB, or #RRGGBBAA for hex; rgb(...); hsl(...); or a CSS gradient. |
| `color_type` | string ("hex" | "rgb" | "hsl" | "gradient") | No | Syntax used by value: hex, rgb, hsl, or gradient. |

#### 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 Brand Color

**Slug:** `ORSHOT_DELETE_BRAND_COLOR`

Permanently delete one saved workspace brand color by ID. This deletion cannot be undone; use it only for a color the caller explicitly intends to remove.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `color_id` | integer | Yes | ID of the saved workspace brand color to permanently delete. |

#### 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 Profile

**Slug:** `ORSHOT_GET_PROFILE`

Return the authenticated Orshot profile and the IDs, names, and slugs of its accessible workspaces.

#### 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 Studio Template

**Slug:** `ORSHOT_GET_STUDIO_TEMPLATE`

Return one Studio template's metadata, pages, and available render modifications by template ID. A 403 response can mean the template is missing or is not owned by the connected workspace; the API does not distinguish those conditions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_id` | integer | Yes | Studio template ID, usually obtained from ORSHOT_LIST_STUDIO_TEMPLATES. |

#### 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 Brand Assets

**Slug:** `ORSHOT_LIST_BRAND_ASSETS`

List one category of workspace brand assets, optionally requiring all supplied tags. Brand colors are limited by Orshot to the 200 most recent values.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | No | Tags each returned asset must contain; all supplied tags must match. |
| `asset_type` | string ("images" | "colors" | "fonts" | "videos" | "audio") | Yes | Brand asset category to list. |

#### 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 Social Accounts

**Slug:** `ORSHOT_LIST_SOCIAL_ACCOUNTS`

Return connected social-account IDs and platforms, optionally checking whether each account needs reconnection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `include_health` | boolean | No | When true, ask Orshot to check token health and report whether each account requires reconnection. |

#### 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 Studio Templates

**Slug:** `ORSHOT_LIST_STUDIO_TEMPLATES`

Return one filtered page of Studio templates in the API key's workspace, with an opaque cursor for the next page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | No | Tags the template must contain; all supplied tags must match. |
| `limit` | integer | No | Maximum templates to return on this page (1-40). |
| `search` | string | No | Search text for narrowing templates by Orshot's template search behavior. |
| `embed_id` | string | No | Embed identifier to filter by; provide embed_user_id with it. |
| `next_cursor` | string | No | Opaque cursor returned by a previous call; omit for the first page. |
| `embed_user_id` | string | No | Embedded-user identifier to filter by; provide embed_id with it. |

#### 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 |

### Render Studio Template

**Slug:** `ORSHOT_RENDER_STUDIO_TEMPLATE`

Render an owned Studio template as an image or PDF URL/base64 result. This consumes render credits and does not publish to social accounts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scale` | number | No | Optional positive scale multiplier applied to the output dimensions. |
| `width` | integer | No | Optional output width in pixels (10-5000); provide height with it. |
| `height` | integer | No | Optional output height in pixels (10-5000); provide width with it. |
| `file_name` | string | No | Optional output file name without an extension. Supported for URL responses. |
| `template_id` | string | Yes | Owned Studio template ID to render. |
| `include_pages` | array | No | One-based page numbers to render from a multi-page template. |
| `modifications` | object | No | Values keyed by modification IDs returned by ORSHOT_GET_STUDIO_TEMPLATE. |
| `output_format` | string ("png" | "webp" | "jpg" | "avif" | "pdf") | No | Output file format. Supported values are PNG, WebP, JPG, AVIF, and PDF. |
| `response_type` | string ("url" | "base64") | No | Return the render as a hosted URL or inline base64 content. |

#### 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 |