Projects

Add video to a project

PUT https://api.vimeo.com/me/projects/{project_id}/videos/{video_id} Playground
PUT https://api.vimeo.com/users/{user_id}/projects/{project_id}/videos/{video_id} Playground
This method requires a token with the "interact" scope.
HTTP Status Code Explanation
204 No Content

The video was added.

404 Not Found

If project was not found in the user.

Error Code: 5000

404 Not Found

If video was not found.

Error Code: 5000

Add videos to a project

PUT https://api.vimeo.com/me/projects/{project_id}/videos Playground
PUT https://api.vimeo.com/users/{user_id}/projects/{project_id}/videos Playground
This method requires a token with the "interact" scope.
Name Type Required Description
uris string No

A comma-separated list of video URIs to add.

HTTP Status Code Explanation
204 No Content

The videos were added.

404 Not Found

If project or video was not found.

Error Code: 5000

401 Unauthorized

The user credentials are invalid.

Error Code: 8000

400 Bad Request

The input is invalid.

Error Code: 2204

Create a project

POST https://api.vimeo.com/me/projects Playground
POST https://api.vimeo.com/users/{user_id}/projects Playground
This method requires a token with the "create" scope.
Name Type Required Description
name string Yes

The name of the project.

HTTP Status Code Explanation
201 Created

The project was created.

401 Unauthorized

The user credentials are invalid.

Error Code: 8000

400 Bad Request

The input is empty.

Error Code: 2205

400 Bad Request

The input is invalid.

Error Code: 2204

403 Forbidden

You cannot create projects.

Error Code: 3200

Delete a project

DELETE https://api.vimeo.com/me/projects/{project_id} Playground
DELETE https://api.vimeo.com/users/{user_id}/projects/{project_id} Playground
This method requires a token with the "delete" scope.
Name Type Required Description
should_delete_clips boolean No

Whether to delete all the videos in the project along with the project itself.

HTTP Status Code Explanation
204 No Content

The project was deleted.

404 Not Found

If project was not found.

Error Code: 5000

401 Unauthorized

The user credentials are invalid.

Error Code: 8000

403 Forbidden

You cannot delete the project.

Error Code: 3200

Edit a project

PATCH https://api.vimeo.com/me/projects/{project_id} Playground
PATCH https://api.vimeo.com/users/{user_id}/projects/{project_id} Playground
This method requires a token with the "edit" scope.
Name Type Required Description
name string Yes

The name of the project.

HTTP Status Code Explanation
200 OK

The project was edited.

404 Not Found

If project was not found.

Error Code: 5000

401 Unauthorized

The user credentials are invalid.

Error Code: 8000

400 Bad Request

The input is invalid.

Error Code: 2204

400 Bad Request

The request body is invalid.

Error Code: 2205

403 Forbidden

You cannot edit the project.

Error Code: 3200

Get a project

GET https://api.vimeo.com/me/projects/{project_id} Playground
GET https://api.vimeo.com/users/{user_id}/projects/{project_id} Playground
This method requires a token with the "private" scope.
HTTP Status Code Explanation
200 OK

The project was returned.

404 Not Found

If project was not found.

Error Code: 5000

401 Unauthorized

The user credentials are invalid.

Error Code: 8000

Get all projects that belong to a user

GET https://api.vimeo.com/me/projects Playground
GET https://api.vimeo.com/users/{user_id}/projects Playground
This method requires a token with the "private" scope.
Name Type Required Description
direction enum
  • asc
  • desc
No

The sort direction of the results.

page integer No

The page number to show.

per_page integer No

The number of items to show on each page (maximum 100).

sort enum
  • date
  • default
  • modified_time
  • name
No

The technique for sorting the results.

HTTP Status Code Explanation
200 OK

The projects were returned.

401 Unauthorized

The user credentials are invalid.

Error Code: 8000

Get all videos in a project

GET https://api.vimeo.com/me/projects/{project_id}/videos Playground
GET https://api.vimeo.com/users/{user_id}/projects/{project_id}/videos Playground
This method requires a token with the "private" scope.
Name Type Required Description
direction enum
  • asc
  • desc
No

The sort direction of the results.

page integer No

The page number to show.

per_page integer No

The number of items to show on each page (maximum 100).

sort enum
  • alphabetical
  • date
  • default
  • duration
  • last_user_action_event_date
No

The technique for sorting the results.

HTTP Status Code Explanation
200 OK

The videos were returned.

404 Not Found

If project was not found.

Error Code: 5000

401 Unauthorized

The user credentials are invalid.

Error Code: 8000

Remove a video from a project

DELETE https://api.vimeo.com/me/projects/{project_id}/videos/{video_id} Playground
DELETE https://api.vimeo.com/users/{user_id}/projects/{project_id}/videos/{video_id} Playground
This method requires a token with the "delete" scope.
HTTP Status Code Explanation
204 No Content

The video was deleted.

404 Not Found

If video was not found in the project.

Error Code: 5000

401 Unauthorized

The user credentials are invalid.

Error Code: 8000

400 Bad Request

The input is invalid.

Error Code: 2204

Remove videos from a project

DELETE https://api.vimeo.com/me/projects/{project_id}/videos Playground
DELETE https://api.vimeo.com/users/{user_id}/projects/{project_id}/videos Playground
This method requires a token with the "interact" scope.
Name Type Required Description
uris string Yes

A comma-separated list of video URIs to delete.

HTTP Status Code Explanation
204 No Content

The videos were deleted.

404 Not Found

If project was not found.

Error Code: 5000

401 Unauthorized

The user credentials are invalid.

Error Code: 8000

400 Bad Request

The input is invalid.

Error Code: 2204

Send Feedback