Create a new Vimeo connection

post

https://api.pictory.ai/pictoryapis/v1/vimeo-connections

Creates a new Vimeo connection with the provided authentication credentials and configuration. The connection name must be unique within your account. Sensitive credentials (client secret and access token) are securely stored but will not be returned in subsequent GET requests.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request payload for creating a new Vimeo connection with authentication credentials

name

string

required

length ≤ 100

^[a-zA-Z0-9 _-]*$

The display name of the Vimeo connection. Must be unique within your account. Maximum 100 characters. Can only contain letters, numbers, spaces, underscores, and hyphens.

description

string

length ≤ 250

An optional detailed description of the Vimeo connection, explaining its purpose or usage. Maximum 250 characters.

enabled

boolean

required

Defaults to true

Indicates whether the connection should be active and usable immediately after creation. Set to true to enable the connection, false to create it in a disabled state.

clientIdentifier

string

required

length ≤ 500

The Vimeo application client identifier (Client ID). This is obtained from your Vimeo app settings at https://developer.vimeo.com/apps and identifies your application to Vimeo's API. Required for authentication.

clientSecret

string

required

length ≤ 500

The Vimeo application client secret. This is a confidential credential obtained from your Vimeo app settings. Keep this value secure and never expose it in client-side code. Required for authentication.

accessToken

string

required

length ≤ 500

The Vimeo access token for authenticating API requests. This token grants your application permission to access Vimeo resources on behalf of a user or account. Obtain this token through Vimeo's OAuth flow or from your app settings for server-to-server authentication.

Headers

Authorization

string

required

Authentication token for authorization. This token is used to verify the user's identity and associate the connection with their account.

Responses

400

Bad request. The request failed validation. Common reasons include: missing required fields, invalid field formats, field values exceeding maximum length, a connection with the same name already exists, or invalid characters in the name field.

401

Unauthorized access. The request failed because the authentication token is invalid, missing, or expired.

500

Internal server error occurred while processing the request.

201Vimeo connection created successfully. The response contains the created connection details without sensitive credentials.