Vimeo API

Name: Vimeo API API
Brand: Vimeo API
Availability: InStock

✓ Official Vendor SpecMediaVideo Processingbearer, oauth2328 EndpointsREST

For Agents

Upload, manage, and distribute videos on Vimeo with full control over privacy settings, embed configurations, channels, albums, and on-demand commerce. Covers 328 endpoints across the Vimeo platform.

Quickstart

Get started with Vimeo API in minutes using your preferred integration method.

# Add to your MCP client config (Claude Desktop, Cursor, Windsurf)
{
  "jentic": {
    "url": "https://api.jentic.com/mcp",
    "auth": "oauth"
  }
}

# Then ask your agent:
"upload and host a video"

# → Jentic returns the GET /events tool with parameter schema, agent executes.

Capabilities

What an agent can do with Vimeo API API.

Upload videos with resumable tus protocol and track transcoding progress through status callbacks

Configure per-video privacy settings including password protection, domain-level embed restrictions, and unlisted access

Organize content into channels, albums, and groups with membership and moderation controls

Sell video content through Vimeo On Demand with promotional codes, region-based pricing, and purchase tracking

GET STARTED

Start building with Vimeo API API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use Vimeo API API for, with concrete tasks.

★ AI Agent Video Distribution Automation

AI agents automate video publishing workflows through Jentic — uploading content, setting privacy and embed restrictions, organizing into channels or albums, and distributing embed codes. The agent searches for the relevant operation, receives the OAuth scope requirements and request schema, and executes the full publish flow without manual dashboard interaction. Vimeo's 12 OAuth scopes provide fine-grained permission control for each action.

Upload a video using the tus resumable protocol via POST /me/videos, set privacy to 'password' with a specified password, then add the video to an existing album via PUT /me/albums/{album_id}/videos/{video_id}

Video Content Organization

Structure large video libraries into channels, albums, and groups with per-item membership control. Channels support moderation workflows where admins approve submissions. Albums enable curated collections with custom sorting. Groups provide community spaces where multiple users contribute and discuss video content. Each organizational unit has independent privacy and access settings.

Create a new channel via POST /channels with name and privacy settings, then add three videos to it via PUT /channels/{channel_id}/videos/{video_id}

Vimeo On Demand Commerce

Sell video content with region-based pricing, rental and purchase options, and promotional code distribution through the On Demand endpoints. Creators set prices per region, define rental windows, and track purchases and revenue. Promotional codes offer discounted access for marketing campaigns. The API exposes customer purchase history and active subscription status for access control in external applications.

Retrieve all On Demand pages for the authenticated user via GET /me/ondemand/pages, then list purchases for a specific page via GET /ondemand/pages/{ondemand_id}/purchases

Embed and Player Customization

Generate embeddable video players with custom appearance and behavior settings per video or account-wide. Control player colors, logo display, playback speed options, social sharing buttons, and end-screen behavior through the API. Domain-level embed restrictions ensure videos only play on authorized websites, preventing unauthorized redistribution while maintaining branded playback experiences.

Update the embed settings for a video via PATCH /videos/{video_id} to set custom player colors and restrict embedding to two specific domains

Key Endpoints

328 endpoints — host, manage, and distribute video content through 328 endpoints covering the full vimeo platform — videos, channels, groups, albums, users, on-demand content, and analytics.

METHOD

PATH

DESCRIPTION

POST

/me/videos

Create a video upload ticket

GET

/videos/{video_id}

Get video metadata and status

PATCH

/videos/{video_id}

Update video metadata and privacy

PUT

/me/albums/{album_id}/videos/{video_id}

Add a video to an album

POST

/channels

Create a new channel

GET

/categories/{category}/videos

List videos in a category

GET

/me/videos

List authenticated user's videos

DELETE

/videos/{video_id}

Delete a video permanently

POST

/me/videos

Create a video upload ticket

GET

/videos/{video_id}

Get video metadata and status

PATCH

/videos/{video_id}

Update video metadata and privacy

PUT

/me/albums/{album_id}/videos/{video_id}

Add a video to an album

POST

/channels

Create a new channel

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Vimeo OAuth 2.0 tokens are stored encrypted in the Jentic vault (MAXsystem). Agents receive scoped bearer tokens with only the required OAuth scopes — the client secret and refresh token never enter the agent's execution context.

Intent-based discovery

Agents search by intent (e.g., 'upload a video with privacy settings') and Jentic returns matching Vimeo operations with their OAuth scope requirements and request schemas, so the agent can call the right endpoint from Vimeo's 328-endpoint surface without browsing documentation.

Time to first call

Direct Vimeo integration: 3-7 days for OAuth flow, tus upload implementation, and webhook handling. Through Jentic: under 1 hour — search, load schema, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Mux API

Infrastructure-focused video API with detailed viewer analytics but without social features or embedded player customization

Choose Mux when you need raw video infrastructure with deep quality-of-experience analytics rather than a social video platform with channels and community features

Alternative

api.video

Developer-first video hosting API with simpler surface area and built-in player

Choose api.video when you want a simpler, more focused video hosting API without Vimeo's social and commerce features

Complementary

Cloudinary Upload API

Image and media asset management for thumbnails, poster frames, and promotional imagery alongside Vimeo video content

Choose Cloudinary when you need image transformations, thumbnail generation, or non-video media alongside your Vimeo video library

FAQs

Specific to using Vimeo API API through Jentic.

What authentication does the Vimeo API use?

The Vimeo API uses OAuth 2.0 with both authorization code and client credentials flows. It defines 12 scopes (create, delete, edit, email, interact, private, promo_codes, public, purchase, purchased, stats, upload, video_files) for granular permission control. Bearer tokens are passed in the Authorization header. Through Jentic, OAuth tokens are managed in the MAXsystem vault — agents receive scoped bearer tokens without handling the OAuth flow.

Can I upload videos using the Vimeo API?

Yes. The Vimeo API supports video uploads via the tus resumable upload protocol through POST /me/videos. You first create an upload ticket specifying the file size, then upload the binary data to the returned upload link in chunks. The API tracks transcode progress and notifies when the video is ready for playback. The 'upload' OAuth scope is required.

What are the rate limits for the Vimeo API?

Vimeo applies rate limits that vary by authentication type and plan tier. Authenticated requests with OAuth tokens get higher limits than unauthenticated client-credential requests. The API returns X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset headers with every response to help you track usage.

How do I manage video privacy through the Vimeo API?

Use PATCH /videos/{video_id} with the privacy object to set view access (anybody, nobody, password, disable, unlisted), embed restrictions (public, private, whitelist), and download permissions. For domain-restricted embeds, use the privacy.embed field set to 'whitelist' and configure allowed domains via the video's domain whitelist endpoint.

How do I upload a video through Jentic with an AI agent?

Install the Jentic SDK with pip install jentic, then search for 'upload video to vimeo'. Jentic returns the POST /me/videos operation with the tus upload flow schema and required OAuth scope (upload). The agent creates the upload ticket, posts the file, and monitors transcode status — Jentic handles OAuth token injection so credentials stay out of the agent's context.

Can I organize videos into channels and albums?

Yes. Create channels via POST /channels with name, description, and privacy settings, then add videos with PUT /channels/{channel_id}/videos/{video_id}. Albums work similarly via POST /me/albums and PUT /me/albums/{album_id}/videos/{video_id}. Both support custom video ordering and independent privacy settings separate from individual video privacy.