Shotstack API
OpenAPI 3.1 definition for Shotstack Edit and Serve operations. The production Edit API base URL is used; Serve and Ingest have separate official base URLs and should be configured separately when needed.
Connect this API to an AI agent Browse all specs
What you can do with Shotstack API via MCP
Every endpoint below becomes a governed tool your AI agent (Claude, ChatGPT, or a customer-facing VX agent) can call — with scoped permissions, sandbox testing, and audit logs.
| Method | Path | Operation | Description |
|---|---|---|---|
| POST | /render |
postRender | Create a render job Method: POST Path: /render IMPORTANT: This function has 1 REQUIRED parameter(s) and 0 OPTIONAL parameter(s) REQUIRED parameters MUST be provided OPTIONAL parameters can be omitted if not needed Parameters: Request Body: REQUIRED: - body: Request body (application/json) |
| GET | /render/{renderId} |
getRenderByRenderid | Get render status Method: GET Path: /render/{renderId} IMPORTANT: This function has 1 REQUIRED parameter(s) and 0 OPTIONAL parameter(s) REQUIRED parameters MUST be provided OPTIONAL parameters can be omitted if not needed Parameters: Path Parameters: REQUIRED: - renderId: renderId parameter. |
| GET | /templates |
getTemplates | List templates Method: GET Path: /templates IMPORTANT: This function has 0 REQUIRED parameter(s) and 2 OPTIONAL parameter(s) REQUIRED parameters MUST be provided OPTIONAL parameters can be omitted if not needed Parameters: Query Parameters: OPTIONAL: - page: page parameter. - perPage: perPage parameter. |
| GET | /templates/{templateId} |
getTemplatesByTemplateid | Get a template Method: GET Path: /templates/{templateId} IMPORTANT: This function has 1 REQUIRED parameter(s) and 0 OPTIONAL parameter(s) REQUIRED parameters MUST be provided OPTIONAL parameters can be omitted if not needed Parameters: Path Parameters: REQUIRED: - templateId: templateId parameter. |
| POST | /serve |
postServe | Create a serve URL Method: POST Path: /serve IMPORTANT: This function has 1 REQUIRED parameter(s) and 0 OPTIONAL parameter(s) REQUIRED parameters MUST be provided OPTIONAL parameters can be omitted if not needed Parameters: Request Body: REQUIRED: - body: Request body (application/json) |
Usage guide
## Shotstack API This listing describes documented production API routes only. Before making requests, read the provider's official documentation and configure the server URL variables where applicable. ### Authentication Create an API key in the Shotstack dashboard and send it in the `x-api-key` header. Use the production Edit API base URL for production jobs; use the documented Stage host for development. ### Operational guidance Use pagination for collection endpoints, respect provider rate limits, validate identifiers before mutating resources, and follow each provider's terms, consent requirements, and data-retention policies.
How to use this spec
- Create a free VX Agents account (sandbox tools included).
- Open the marketplace and connect “Shotstack API” to an agent.
- Expose it as an MCP server for Claude/ChatGPT, or chat with it directly.