Which endpoints accept OAuth tokens?

Which Orshot API endpoints are callable with an OAuth token rather than an API key.

Published ·Updated

Available Endpoints#

EndpointMethodRequired Scope
/v1/meGETprofile or workspace:read
/v1/generate/:renderType (for example /v1/generate/images)POSTrender:generate
/v1/studio/renderPOSTrender:generate
/v1/studio/templatesGETworkspace:templates:read
/v1/studio/templates/allGETworkspace:templates:read
/v1/studio/templates/:idGETworkspace:templates:read
/v1/studio/:idGETworkspace:templates:read
/v1/studio/:id/modificationsGETworkspace:templates:read
/v1/studio/templates/:id/deleteDELETEworkspace:templates:write
/v1/studio/templates/:id/shareGETworkspace:templates:read
/v1/studio/templates/:id/sharePOSTworkspace:templates:write
/v1/studio/templates/:id/folderPATCHworkspace:templates:write
/v1/studio/foldersGETworkspace:templates:read
/v1/studio/foldersPOSTworkspace:templates:write
/v1/studio/folders/:idPATCHworkspace:templates:write
/v1/studio/folders/:idDELETEworkspace:templates:write
/v1/studio/templates/:id/versionsGETworkspace:templates:read
/v1/studio/templates/:id/versions/:vidGETworkspace:templates:read
/v1/studio/templates/:id/versionsPOSTworkspace:templates:write
/v1/studio/templates/:id/versions/:vidPATCHworkspace:templates:write
/v1/studio/templates/:id/versions/:vidDELETEworkspace:templates:write
/v1/studio/templates/:id/versions/:vid/restorePOSTworkspace:templates:write
/v1/studio/templates/:id/versions/:vid/duplicatePOSTworkspace:templates:write
/v1/studio/render-jobsGETrender:generate
/v1/studio/render-jobs/:idGETrender:generate
/v1/studio/render-jobs/:id/cancelPOSTrender:generate
/v1/workspace/logsGETworkspace:read
/v1/ai/presetsGETworkspace:read
/v1/ai/video/estimatePOSTrender:generate
/v1/ai/videoPOSTrender:generate

The Approvals API uses its own workspace:approvals:* scopes. See Scopes.

Other endpoints return 403 oauth_not_allowed. Use an API key for those.

Errors#

HTTPCodeMeaning
401oauth_token_invalidThe token is expired or revoked. Refresh it
403insufficient_scopeThe token lacks the scope this endpoint needs
403oauth_not_allowedThis endpoint does not accept OAuth tokens. Use an API key
403workspace_not_accessiblex-workspace-id names a workspace that is not on the token
403sandbox_restrictedThe app is in development mode and the user is not the owner or a test user

Template endpoints currently return a plain 401 with no code for expired tokens, workspace_not_accessible and sandbox_restricted.

Dynamic Client Registration#

MCP clients (Claude, Cursor and others) can register themselves with POST /v1/oauth/register (RFC 7591). The discovery document at /.well-known/oauth-authorization-server lists it as registration_endpoint.

Shell
curl -X POST https://api.orshot.com/v1/oauth/register \
  -H "Content-Type: application/json" \
  -d '{
    "client_name": "My MCP Client",
    "redirect_uris": ["http://localhost:3334/callback"]
  }'

redirect_uris is required and must be a non-empty array. The call does not create a new app. It returns 201 with a public client_id (no secret), plus client_name, redirect_uris, grant_types, token_endpoint_auth_method: "none", scope and client_id_issued_at. The consent screen names Orshot, not your client. Use that client_id with the Authorization Code flow.

To build your own app with its own name on the consent screen, register an app instead.

Was this page helpful?

Ready to automate?

Start rendering images, PDFs and videos from your templates in under 2 minutes. Free plan, no credit card.

Get your API key
  • Image, PDF and video generation via API
  • Visual editor with AI and smart layouts
  • Zapier, Make, MCP and 40+ integrations
  • White-label embed for your own app
  • 100 free credits a month, no credit card required