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

# Orshot API

Jentic publishes the only available OpenAPI specification for Orshot API, keeping it validated and agent-ready. Orshot is an image-generation service that turns templates into branded images for OG cards, social posts, certificates, dynamic ads, and product mockups. The 16 endpoints cover rendering from studio or library templates, generating signed delivery URLs, managing brand assets, creating and bulk-creating enterprise templates, generating variants, and fetching workspace profile information. It targets marketing, growth, and product teams that want dynamic image generation at scale without running a headless browser farm.

## For AI agents

Generate branded images from studio or enterprise templates, manage brand assets, and produce signed delivery URLs through Orshot.

## Scope

Does not host source asset storage as a CDN, edit raw images, or generate video - use for template-based image rendering and brand asset management only.

## Capabilities

- Render an image from a studio template via POST /render-from-studio-template with the template id and modification payload
- Render an image from a library template using POST /render-from-template
- Generate a signed delivery URL for a rendered image through POST /generate-signed-url
- Manage studio templates by listing, fetching, deleting, and duplicating via the /studio-templates-list, /studio-template-get, /studio-template-delete, and /studio-template-duplicate endpoints
- Upload, list, and delete brand assets through /brand-assets-post, /brand-assets-get, and /brand-assets-delete
- Create enterprise templates one at a time or in bulk with POST /enterprise-template-create and POST /enterprise-template-bulk-create
- Generate batched image variants in one call via POST /enterprise-generate-variants

## Use cases

### Dynamic OG Image Generation

Blogs and SaaS marketing sites want every published article to ship with a unique Open Graph image that reflects the title and author. POST /render-from-studio-template with a per-article modification payload generates the OG card on demand, and POST /generate-signed-url issues the link the meta tag points at.

Example prompt: POST /render-from-studio-template with template id, title, and author for each new blog post and store the returned URL on the post record.

### Certificate and Receipt Generation

Course platforms and event organisers can issue thousands of personalised certificates by calling /render-from-template with the recipient's name, date, and program. The 16-endpoint surface includes signed-URL generation so the certificate can be emailed without exposing internals.

Example prompt: POST /render-from-template per attendee with their name and completion date, then POST /generate-signed-url and email the result.

### Bulk Ad Variant Generation

Performance marketing teams running A/B tests need many variants of the same ad with different headlines, colors, and product images. POST /enterprise-generate-variants takes a base template and a variant matrix, returning rendered images for each combination in one call rather than thousands of single renders.

Example prompt: POST /enterprise-generate-variants with a base template id and a matrix of 5 headlines x 4 backgrounds, returning 20 rendered URLs.

### Brand Asset Management Workflow

Design ops teams managing logos and brand colors across templates can call /brand-assets-post to upload new assets, /brand-assets-get to enumerate, and /brand-assets-delete to retire stale ones, keeping every render aligned with current brand guidelines.

Example prompt: POST /brand-assets-post when a new logo lands in design review, then DELETE the previous variant via /brand-assets-delete.

### Agent-Driven Image Generation via Jentic

Agents that publish content, send emails, or produce social posts can generate accompanying images through Jentic without managing the Orshot API key. Jentic exposes the 16 operations by intent and isolates the key in the vault.

Example prompt: Use Jentic to search 'generate an image from a template', load the POST /render-from-studio-template schema, and execute with the template id and modification payload.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/render-from-studio-template` | Render an image from a studio template |
| POST | `/render-from-template` | Render an image from a library template |
| POST | `/generate-signed-url` | Generate a signed delivery URL |
| GET | `/studio-templates-list` | List studio templates |
| POST | `/brand-assets-post` | Upload a brand asset |
| POST | `/enterprise-template-create` | Create an enterprise template |
| POST | `/enterprise-generate-variants` | Generate batched image variants |
| GET | `/get-profile-workspace` | Retrieve workspace profile |

## Key resources

- **Render** — Render images from studio or library templates
- **Studio Templates** — List, fetch, delete, and duplicate studio templates
- **Enterprise Templates** — Create, bulk create, update, and generate variants for enterprise templates
- **Brand Assets** — Upload, list, and delete brand assets
- **Signed URLs** — Generate time-bounded signed URLs for rendered images
- **Profile** — Retrieve workspace profile information

## Why Jentic

- **Setup:** Wiring the Orshot API by hand means setting up its Authorization-header key auth and mapping the template render, signed-url, and brand-asset routes yourself. Through Jentic you install once, import Orshot from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** You choose which Orshot operations the agent may call, so you can limit it to the operations it needs, such as rendering from a template or listing studio templates, while creating an enterprise template or posting brand assets stays out of the allowed set unless you add them.
- **Credential handling:** Your Orshot API key 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 'generate an OG image' or 'render from a studio template', and Jentic returns the matching Orshot operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Bannerbear API** — Bannerbear is a direct alternative offering template-driven image and video generation.
- **Placid API** — Placid offers similar template-based image generation with a strong focus on PDF and creative variants.
- **Cloudinary Upload API** — Cloudinary handles upload, transformation, and delivery of the assets that feed Orshot templates.

## FAQ

### Why is there no official OpenAPI spec for Orshot API?

Orshot publishes API reference documentation but not a maintained OpenAPI document. Jentic generates and maintains this spec so that AI agents and developers can call Orshot API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Orshot API use?

Orshot uses an API key passed via header (apiKey scheme). Through Jentic the key is stored encrypted in the vault and injected at execution time so the raw secret never reaches the agent.

### Can I generate hundreds of image variants in one call with the Orshot API?

Yes. POST /enterprise-generate-variants accepts a base template id and a variant matrix and returns rendered images for every combination, avoiding one-render-per-variant API calls.

### What are the rate limits for the Orshot API?

The OpenAPI spec does not declare numeric rate limits. Render-heavy operations are typically the bottleneck on the platform side - confirm per-plan limits on orshot.com/docs/api-reference before scaling bulk variant generation.

### How do I render an OG image through Jentic?

Search Jentic for 'generate an image from a template', load the POST /render-from-studio-template schema, and execute with the template id and a modifications object containing the title and author values.

### Does the Orshot API support signed delivery URLs?

Yes. POST /generate-signed-url returns a time-bounded URL for a rendered image, suitable for use in email campaigns or OG meta tags without exposing the raw asset path.

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

Yes. Because you run Jentic One yourself, your own rules decide which Orshot operations and credentials the agent may use. You can allow only the operations it needs, such as POST /render-from-studio-template or GET /studio-templates-list, while keeping actions like POST /enterprise-template-create or POST /brand-assets-post out of the allowed set unless you add them. The stored API key is injected at execution time, so the agent never handles the raw secret.
