Can I use Vimeo as a CLI?

Yes. KosmoKrator exposes a Vimeo CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose Vimeo through MCP?

Yes. The KosmoKrator MCP gateway can expose selected Vimeo tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are Vimeo credentials stored?

Vimeo credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for Vimeo MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

media

Vimeo CLI for AI Agents

Use the Vimeo CLI from KosmoKrator to call Vimeo tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.

6 functions 5 read 1 write Bearer token auth

Submit Vimeo feedback View package source

Vimeo CLI Setup

Vimeo can be configured headlessly with `kosmokrator integrations:configure vimeo`.

# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash

# Configure and verify this integration.
kosmokrator integrations:configure vimeo --set access_token="$VIMEO_ACCESS_TOKEN" --enable --read allow --write ask --json
kosmokrator integrations:doctor vimeo --json
kosmokrator integrations:status --json

Credentials

Authentication type: Bearer token bearer_token. Configure credentials once, then use the same stored profile from scripts, coding CLIs, Lua code mode, and the MCP gateway.

Key	Env var	Type	Required	Label
`access_token`	`VIMEO_ACCESS_TOKEN`	Secret `secret`	yes	Access Token
`base_url`	`VIMEO_BASE_URL`	URL `url`	no	API Base URL

Call Vimeo Headlessly

Use the generic call form when another coding CLI or script needs a stable universal interface.

kosmo integrations:call vimeo.vimeo_create_video '{
  "upload_approach": "example_upload_approach",
  "upload_link": "example_upload_link",
  "name": "example_name",
  "description": "example_description",
  "privacy": "example_privacy",
  "password": "example_password",
  "folder_uri": "example_folder_uri"
}' --json

Use the provider shortcut form for shorter human-facing commands.

kosmo integrations:vimeo vimeo_create_video '{
  "upload_approach": "example_upload_approach",
  "upload_link": "example_upload_link",
  "name": "example_name",
  "description": "example_description",
  "privacy": "example_privacy",
  "password": "example_password",
  "folder_uri": "example_folder_uri"
}' --json

Agent Discovery Commands

These commands return structured output for coding agents that need to inspect capabilities before choosing a function.

kosmo integrations:docs vimeo --json
kosmo integrations:docs vimeo.vimeo_create_video --json
kosmo integrations:schema vimeo.vimeo_create_video --json
kosmo integrations:search "Vimeo" --json
kosmo integrations:list --json

All CLI Functions

Every function below can be called headlessly. The generic form is stable across all integrations; the provider shortcut is shorter but specific to Vimeo.

`vimeo.vimeo_create_video`

Write write

Create a new video upload slot on Vimeo. Choose an upload approach: "pull" (Vimeo downloads from a URL), "post" (you POST to an upload link), or "streaming" (Tus protocol). Returns the video URI and upload target.

Parameters: upload_approach, upload_link, name, description, privacy, password, folder_uri

Generic CLI call

kosmo integrations:call vimeo.vimeo_create_video '{"upload_approach":"example_upload_approach","upload_link":"example_upload_link","name":"example_name","description":"example_description","privacy":"example_privacy","password":"example_password","folder_uri":"example_folder_uri"}' --json

Provider shortcut

kosmo integrations:vimeo vimeo_create_video '{"upload_approach":"example_upload_approach","upload_link":"example_upload_link","name":"example_name","description":"example_description","privacy":"example_privacy","password":"example_password","folder_uri":"example_folder_uri"}' --json

`vimeo.vimeo_get_current_user`

Read read

Get the authenticated Vimeo user's profile information. Returns name, bio, location, account type, upload quota, and profile pictures.

Parameters: none

Generic CLI call

kosmo integrations:call vimeo.vimeo_get_current_user '{}' --json

Provider shortcut

kosmo integrations:vimeo vimeo_get_current_user '{}' --json

`vimeo.vimeo_get_video`

Read read

Get detailed information about a single Vimeo video by its ID. Returns name, description, duration, thumbnails, privacy, stats, and playback links.

Parameters: video_id

Generic CLI call

kosmo integrations:call vimeo.vimeo_get_video '{"video_id":"example_video_id"}' --json

Provider shortcut

kosmo integrations:vimeo vimeo_get_video '{"video_id":"example_video_id"}' --json

`vimeo.vimeo_list_albums`

Read read

List albums (showcases) for the authenticated Vimeo user. Supports pagination, query search, sorting, and direction. Returns album names, descriptions, thumbnails, and video counts.

Parameters: per_page, page, query, sort, direction

Generic CLI call

kosmo integrations:call vimeo.vimeo_list_albums '{"per_page":1,"page":1,"query":"example_query","sort":"example_sort","direction":"example_direction"}' --json

Provider shortcut

kosmo integrations:vimeo vimeo_list_albums '{"per_page":1,"page":1,"query":"example_query","sort":"example_sort","direction":"example_direction"}' --json

`vimeo.vimeo_list_folders`

Read read

List folders (projects) for the authenticated Vimeo user. Supports pagination and query search. Returns folder names, descriptions, and item counts.

Parameters: per_page, page, query

Generic CLI call

kosmo integrations:call vimeo.vimeo_list_folders '{"per_page":1,"page":1,"query":"example_query"}' --json

Provider shortcut

kosmo integrations:vimeo vimeo_list_folders '{"per_page":1,"page":1,"query":"example_query"}' --json

`vimeo.vimeo_list_videos`

Read read

List videos for the authenticated Vimeo user. Supports pagination, full-text search via query, and filters (e.g., embeddable, playable, privacy). Returns video URIs, names, durations, thumbnails, and metadata.

Parameters: per_page, page, query, filter, filter_embeddable, filter_playable, direction, sort

Generic CLI call

kosmo integrations:call vimeo.vimeo_list_videos '{"per_page":1,"page":1,"query":"example_query","filter":"example_filter","filter_embeddable":true,"filter_playable":true,"direction":"example_direction","sort":"example_sort"}' --json

Provider shortcut

kosmo integrations:vimeo vimeo_list_videos '{"per_page":1,"page":1,"query":"example_query","filter":"example_filter","filter_embeddable":true,"filter_playable":true,"direction":"example_direction","sort":"example_sort"}' --json

Function Schemas

Use these parameter tables when building CLI payloads without calling integrations:schema first.

`vimeo.vimeo_create_video`

Operation: Write write
Schema command: kosmo integrations:schema vimeo.vimeo_create_video --json

Parameter	Type	Required	Description
`upload_approach`	string	no	Upload method: "pull" (Vimeo fetches from URL), "post" (direct upload), or "streaming" (Tus). Default: "post".
`upload_link`	string	no	Required when upload_approach is "pull". The URL Vimeo will download the video from.
`name`	string	no	Title of the video.
`description`	string	no	Description of the video.
`privacy`	string	no	Privacy setting: "anybody", "nobody", "contacts", "password", "unlisted", "disable".
`password`	string	no	Required when privacy is "password".
`folder_uri`	string	no	URI of a folder (project) to add the video to after creation.

`vimeo.vimeo_get_current_user`

Get the authenticated Vimeo user's profile information. Returns name, bio, location, account type, upload quota, and profile pictures.

Operation: Read read
Schema command: kosmo integrations:schema vimeo.vimeo_get_current_user --json

Parameter	Type	Required	Description
No parameters.

`vimeo.vimeo_get_video`

Get detailed information about a single Vimeo video by its ID. Returns name, description, duration, thumbnails, privacy, stats, and playback links.

Operation: Read read
Schema command: kosmo integrations:schema vimeo.vimeo_get_video --json

Parameter	Type	Required	Description
`video_id`	string	yes	The Vimeo video ID (e.g., "123456789").

`vimeo.vimeo_list_albums`

List albums (showcases) for the authenticated Vimeo user. Supports pagination, query search, sorting, and direction. Returns album names, descriptions, thumbnails, and video counts.

Operation: Read read
Schema command: kosmo integrations:schema vimeo.vimeo_list_albums --json

Parameter	Type	Required	Description
`per_page`	integer	no	Number of albums per page (1–100, default: 25).
`page`	integer	no	Page number for pagination (default: 1).
`query`	string	no	Full-text search query to filter albums by name or description.
`sort`	string	no	Sort field: "alphabetical", "date", "duration", "manual", "modified_time", "name".
`direction`	string	no	Sort direction: "asc" or "desc".

`vimeo.vimeo_list_folders`

List folders (projects) for the authenticated Vimeo user. Supports pagination and query search. Returns folder names, descriptions, and item counts.

Operation: Read read
Schema command: kosmo integrations:schema vimeo.vimeo_list_folders --json

Parameter	Type	Required	Description
`per_page`	integer	no	Number of folders per page (1–100, default: 25).
`page`	integer	no	Page number for pagination (default: 1).
`query`	string	no	Search query to filter folders by name.

`vimeo.vimeo_list_videos`

Operation: Read read
Schema command: kosmo integrations:schema vimeo.vimeo_list_videos --json

Parameter	Type	Required	Description
`per_page`	integer	no	Number of videos per page (1–100, default: 25).
`page`	integer	no	Page number for pagination (default: 1).
`query`	string	no	Full-text search query to filter videos by name or description.
`filter`	string	no	Filter category: "embeddable", "playable", "purchase_price", "privacy".
`filter_embeddable`	boolean	no	When filter is "embeddable": true = only embeddable, false = only non-embeddable.
`filter_playable`	boolean	no	When filter is "playable": true = only playable, false = only non-playable.
`direction`	string	no	Sort direction: "asc" or "desc".
`sort`	string	no	Sort field: "alphabetical", "comments", "date", "duration", "likes", "plays".

Permissions

Headless calls still follow the integration read/write permission policy. Configure read/write defaults with integrations:configure. Add --force only for trusted automation that should bypass that policy.