Create a Clip
POST/bv/cms/v1/clips
Create a Clip
Request
Header Parameters
To invoke this API using api_token, you need to set the x-bv-org-id header to specify the organization for which you want to perform the action.
- application/json
Body
required
- Removing an explicitly-provided
+sign (+2.5->2.5). - Replacing a zero-length integer value with
0(.5->0.5). - Coercing the exponent character to lower-case (
2.5E8->2.5e8). - Removing an explicitly-provided zero exponent (
2.5e0->2.5). - Removing an explicitly-provided
+sign (+2.5->2.5). - Replacing a zero-length integer value with
0(.5->0.5). - Coercing the exponent character to lower-case (
2.5E8->2.5e8). - Removing an explicitly-provided zero exponent (
2.5e0->2.5). - Array [
- ]
source object
The source where the clip is created from.
Possible values: [CLIP_SOURCE_TYPE_VOD]
The type of the source.
start_time objectrequired
A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.
The decimal value, as a string.
The string representation consists of an optional sign, + (U+002B)
or - (U+002D), followed by a sequence of zero or more decimal digits
("the integer"), optionally followed by a fraction, optionally followed
by an exponent.
The fraction consists of a decimal point followed by zero or more decimal digits. The string must contain at least one digit in either the integer or the fraction. The number formed by the sign, the integer and the fraction is referred to as the significand.
The exponent consists of the character e (U+0065) or E (U+0045)
followed by one or more decimal digits.
Services should normalize decimal values before storing them by:
Services may perform additional normalization based on its own needs
and the internal decimal implementation selected, such as shifting the
decimal point and exponent value together (example: 2.5e-1 <-> 0.25).
Additionally, services may preserve trailing zeroes in the fraction
to indicate increased precision, but are not required to do so.
Note that only the . character is supported to divide the integer
and the fraction; , should not be supported regardless of locale.
Additionally, thousand separators should not be supported. If a
service does support them, values must be normalized.
The ENBF grammar is:
DecimalString =
[Sign] Significand [Exponent];
Sign = '+' | '-';
Significand =
Digits ['.'] [Digits] | [Digits] '.' Digits;
Exponent = ('e' | 'E') [Sign] Digits;
Digits = { '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' };
Services should clearly document the range of supported values, the maximum supported precision (total number of digits), and, if applicable, the scale (number of digits after the decimal point), as well as how it behaves when receiving out-of-bounds values.
Services may choose to accept values passed as input even when the
value has a higher precision or scale than the service supports, and
should round the value to fit the supported scale. Alternatively, the
service may error with 400 Bad Request (INVALID_ARGUMENT in gRPC)
if precision would be lost.
Services should error with 400 Bad Request (INVALID_ARGUMENT in
gRPC) if the service receives a value outside of the supported range.
end_time objectrequired
A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.
The decimal value, as a string.
The string representation consists of an optional sign, + (U+002B)
or - (U+002D), followed by a sequence of zero or more decimal digits
("the integer"), optionally followed by a fraction, optionally followed
by an exponent.
The fraction consists of a decimal point followed by zero or more decimal digits. The string must contain at least one digit in either the integer or the fraction. The number formed by the sign, the integer and the fraction is referred to as the significand.
The exponent consists of the character e (U+0065) or E (U+0045)
followed by one or more decimal digits.
Services should normalize decimal values before storing them by:
Services may perform additional normalization based on its own needs
and the internal decimal implementation selected, such as shifting the
decimal point and exponent value together (example: 2.5e-1 <-> 0.25).
Additionally, services may preserve trailing zeroes in the fraction
to indicate increased precision, but are not required to do so.
Note that only the . character is supported to divide the integer
and the fraction; , should not be supported regardless of locale.
Additionally, thousand separators should not be supported. If a
service does support them, values must be normalized.
The ENBF grammar is:
DecimalString =
[Sign] Significand [Exponent];
Sign = '+' | '-';
Significand =
Digits ['.'] [Digits] | [Digits] '.' Digits;
Exponent = ('e' | 'E') [Sign] Digits;
Digits = { '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' };
Services should clearly document the range of supported values, the maximum supported precision (total number of digits), and, if applicable, the scale (number of digits after the decimal point), as well as how it behaves when receiving out-of-bounds values.
Services may choose to accept values passed as input even when the
value has a higher precision or scale than the service supports, and
should round the value to fit the supported scale. Alternatively, the
service may error with 400 Bad Request (INVALID_ARGUMENT in gRPC)
if precision would be lost.
Services should error with 400 Bad Request (INVALID_ARGUMENT in
gRPC) if the service receives a value outside of the supported range.
The title of the clip.
The description of the clip.
tags object[]
The tags of the clip.
The name of the tag.
Responses
- 200
- 400
- 401
- 403
- 500
- default
A successful response.
- application/json
- Schema
- Example (from schema)
Schema
- Removing an explicitly-provided
+sign (+2.5->2.5). - Replacing a zero-length integer value with
0(.5->0.5). - Coercing the exponent character to lower-case (
2.5E8->2.5e8). - Removing an explicitly-provided zero exponent (
2.5e0->2.5). - Removing an explicitly-provided
+sign (+2.5->2.5). - Replacing a zero-length integer value with
0(.5->0.5). - Coercing the exponent character to lower-case (
2.5E8->2.5e8). - Removing an explicitly-provided zero exponent (
2.5e0->2.5). - Array [
- ]
clip object
The created clip.
Output only. The unique id of the clip.
start_time object
A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.
The decimal value, as a string.
The string representation consists of an optional sign, + (U+002B)
or - (U+002D), followed by a sequence of zero or more decimal digits
("the integer"), optionally followed by a fraction, optionally followed
by an exponent.
The fraction consists of a decimal point followed by zero or more decimal digits. The string must contain at least one digit in either the integer or the fraction. The number formed by the sign, the integer and the fraction is referred to as the significand.
The exponent consists of the character e (U+0065) or E (U+0045)
followed by one or more decimal digits.
Services should normalize decimal values before storing them by:
Services may perform additional normalization based on its own needs
and the internal decimal implementation selected, such as shifting the
decimal point and exponent value together (example: 2.5e-1 <-> 0.25).
Additionally, services may preserve trailing zeroes in the fraction
to indicate increased precision, but are not required to do so.
Note that only the . character is supported to divide the integer
and the fraction; , should not be supported regardless of locale.
Additionally, thousand separators should not be supported. If a
service does support them, values must be normalized.
The ENBF grammar is:
DecimalString =
[Sign] Significand [Exponent];
Sign = '+' | '-';
Significand =
Digits ['.'] [Digits] | [Digits] '.' Digits;
Exponent = ('e' | 'E') [Sign] Digits;
Digits = { '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' };
Services should clearly document the range of supported values, the maximum supported precision (total number of digits), and, if applicable, the scale (number of digits after the decimal point), as well as how it behaves when receiving out-of-bounds values.
Services may choose to accept values passed as input even when the
value has a higher precision or scale than the service supports, and
should round the value to fit the supported scale. Alternatively, the
service may error with 400 Bad Request (INVALID_ARGUMENT in gRPC)
if precision would be lost.
Services should error with 400 Bad Request (INVALID_ARGUMENT in
gRPC) if the service receives a value outside of the supported range.
end_time object
A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.
The decimal value, as a string.
The string representation consists of an optional sign, + (U+002B)
or - (U+002D), followed by a sequence of zero or more decimal digits
("the integer"), optionally followed by a fraction, optionally followed
by an exponent.
The fraction consists of a decimal point followed by zero or more decimal digits. The string must contain at least one digit in either the integer or the fraction. The number formed by the sign, the integer and the fraction is referred to as the significand.
The exponent consists of the character e (U+0065) or E (U+0045)
followed by one or more decimal digits.
Services should normalize decimal values before storing them by:
Services may perform additional normalization based on its own needs
and the internal decimal implementation selected, such as shifting the
decimal point and exponent value together (example: 2.5e-1 <-> 0.25).
Additionally, services may preserve trailing zeroes in the fraction
to indicate increased precision, but are not required to do so.
Note that only the . character is supported to divide the integer
and the fraction; , should not be supported regardless of locale.
Additionally, thousand separators should not be supported. If a
service does support them, values must be normalized.
The ENBF grammar is:
DecimalString =
[Sign] Significand [Exponent];
Sign = '+' | '-';
Significand =
Digits ['.'] [Digits] | [Digits] '.' Digits;
Exponent = ('e' | 'E') [Sign] Digits;
Digits = { '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' };
Services should clearly document the range of supported values, the maximum supported precision (total number of digits), and, if applicable, the scale (number of digits after the decimal point), as well as how it behaves when receiving out-of-bounds values.
Services may choose to accept values passed as input even when the
value has a higher precision or scale than the service supports, and
should round the value to fit the supported scale. Alternatively, the
service may error with 400 Bad Request (INVALID_ARGUMENT in gRPC)
if precision would be lost.
Services should error with 400 Bad Request (INVALID_ARGUMENT in
gRPC) if the service receives a value outside of the supported range.
The title of the clip.
The description of the clip.
tags object[]
The tags of the clip.
The name of the tag.
Output only. The thumbnail uri of the clip.
Possible values: [CLIP_CREATED_BY_USER, CLIP_CREATED_BY_AUTO_TAGGING]
Output only. The clip was created by.
{
"clip": {
"id": "string",
"start_time": {
"value": "string"
},
"end_time": {
"value": "string"
},
"title": "string",
"description": "string",
"tags": [
{
"name": "string"
}
],
"thumbnail_uri": "string",
"created_by": "CLIP_CREATED_BY_USER"
}
}
A bad request response.
The code is 3 means got an invalid argument. There are more HTTP status code mappings listed on here and gRPC code on here.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- If no scheme is provided,
httpsis assumed. - An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
- Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
- ]
details object[]
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http, https, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be
used with implementation specific semantics.
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
A unauthenticated response.
The header authorization was missing or unidentified.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- If no scheme is provided,
httpsis assumed. - An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
- Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
- ]
details object[]
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http, https, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be
used with implementation specific semantics.
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
A forbidden response.
It means that the provided authorization did not have enough permission to access the resource or the API.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- If no scheme is provided,
httpsis assumed. - An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
- Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
- ]
details object[]
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http, https, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be
used with implementation specific semantics.
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
A server error response. There are more HTTP status code mappings listed on here.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- If no scheme is provided,
httpsis assumed. - An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
- Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
- ]
details object[]
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http, https, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be
used with implementation specific semantics.
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- If no scheme is provided,
httpsis assumed. - An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
- Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
- ]
details object[]
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http, https, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be
used with implementation specific semantics.
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}