Skip to main content
Orshot logo
  • Category: ai content generation
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 8
  • Triggers: 0
  • Slug: ORSHOT
  • Version: 00000000_00

Tools

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

Input Parameters

array
Optional tags to associate with the saved color.
string
required
Color value in the syntax selected by color_type: #RGB, #RRGGBB, or #RRGGBBAA for hex; rgb(…); hsl(…); or a CSS gradient.
string ("hex" | "rgb" | "hsl" | "gradient")
Syntax used by value: hex, rgb, hsl, or gradient.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORSHOT_DELETE_BRAND_COLORPermanently 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

integer
required
ID of the saved workspace brand color to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORSHOT_GET_PROFILEReturn the authenticated Orshot profile and the IDs, names, and slugs of its accessible workspaces.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORSHOT_GET_STUDIO_TEMPLATEReturn 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

integer
required
Studio template ID, usually obtained from ORSHOT_LIST_STUDIO_TEMPLATES.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORSHOT_LIST_BRAND_ASSETSList 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

array
Tags each returned asset must contain; all supplied tags must match.
string ("images" | "colors" | "fonts" | "videos" | "audio")
required
Brand asset category to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORSHOT_LIST_SOCIAL_ACCOUNTSReturn connected social-account IDs and platforms, optionally checking whether each account needs reconnection.

Input Parameters

boolean
When true, ask Orshot to check token health and report whether each account requires reconnection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORSHOT_LIST_STUDIO_TEMPLATESReturn one filtered page of Studio templates in the API key’s workspace, with an opaque cursor for the next page.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ORSHOT_RENDER_STUDIO_TEMPLATERender 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not