> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Orshot

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

![Orshot logo](https://mintcdn.com/composio-preview/gqjBKmmJCINafaiK/images/toolkits/orshot.svg?fit=max\&auto=format\&n=gqjBKmmJCINafaiK\&q=85\&s=1bafa86bd43679aa6c66a3c1e713531b)

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

## Tools

> [accordion] 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
>
> **tags** `array`
>
> Optional tags to associate with the saved color.
>
> **value** `string` *required*
>
> 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")`
>
> Syntax used by value: hex, rgb, hsl, or gradient.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **color\_id** `integer` *required*
>
> ID of the saved workspace brand color to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Profile
>
> **Slug:** `ORSHOT_GET_PROFILE`
>
> Return the authenticated Orshot profile and the IDs, names, and slugs of its accessible workspaces.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **template\_id** `integer` *required*
>
> Studio template ID, usually obtained from ORSHOT\_LIST\_STUDIO\_TEMPLATES.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **tags** `array`
>
> Tags each returned asset must contain; all supplied tags must match.
>
> **asset\_type** `string ("images" | "colors" | "fonts" | "videos" | "audio")` *required*
>
> Brand asset category to list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Social Accounts
>
> **Slug:** `ORSHOT_LIST_SOCIAL_ACCOUNTS`
>
> Return connected social-account IDs and platforms, optionally checking whether each account needs reconnection.
>
> #### Input Parameters
>
> **include\_health** `boolean`
>
> When true, ask Orshot to check token health and report whether each account requires reconnection.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **tags** `array`
>
> Tags the template must contain; all supplied tags must match.
>
> **limit** `integer`
>
> Maximum templates to return on this page (1-40).
>
> **search** `string`
>
> Search text for narrowing templates by Orshot's template search behavior.
>
> **embed\_id** `string`
>
> Embed identifier to filter by; provide embed\_user\_id with it.
>
> **next\_cursor** `string`
>
> Opaque cursor returned by a previous call; omit for the first page.
>
> **embed\_user\_id** `string`
>
> Embedded-user identifier to filter by; provide embed\_id with it.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **scale** `number`
>
> Optional positive scale multiplier applied to the output dimensions.
>
> **width** `integer`
>
> Optional output width in pixels (10-5000); provide height with it.
>
> **height** `integer`
>
> Optional output height in pixels (10-5000); provide width with it.
>
> **file\_name** `string`
>
> Optional output file name without an extension. Supported for URL responses.
>
> **template\_id** `string` *required*
>
> Owned Studio template ID to render.
>
> **include\_pages** `array`
>
> One-based page numbers to render from a multi-page template.
>
> **modifications** `object`
>
> Values keyed by modification IDs returned by ORSHOT\_GET\_STUDIO\_TEMPLATE.
>
> **output\_format** `string ("png" | "webp" | "jpg" | "avif" | "pdf")`
>
> Output file format. Supported values are PNG, WebP, JPG, AVIF, and PDF.
>
> **response\_type** `string ("url" | "base64")`
>
> Return the render as a hosted URL or inline base64 content.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
