Optimizely Library API is one of 420 APIs that Optimizely publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Library. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
41 operations
across 24 paths,
and defines 120 schemas.
It is described by OpenAPI 3.2.0, at version V3.
Requests are made against a single base URL, https://api.cmp.optimizely.com/v3.
The identity and technical contract details declared by the specification.
Optimizely Library API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (OAuth2) using the authorizationCode and clientCredentials flows, exposing 3 scopes.
By default, every request must be authenticated.
ReplaceRelatedAssetsRequest
object
1 property
1 required
AllowedContentTypeItem
object
2 properties
2 required
LocationDefaultValue
object
2 properties
2 required
LibraryVideoUpdateRequest
object
11 properties
FolderPermissionUpdateRequest
object
2 properties
DetailedAssetRenditionResponse
ContentTypeFieldEmbedMixConfig
integer
Ref Type: 1 Refer only 2 Refer and create embed 3 Create only
FolderPermissionBulkCreateRequest
object
2 properties
2 required
LibraryImage
object
26 properties
26 required
ChoiceDisplayOption
string
An enumeration.
LocationFieldValueModel
object
3 properties
2 required
AssetPermissionUpdateRequest
object
2 properties
BaseObjectFieldUpdatePayload
object
2 properties
2 required
LocalizedFieldValuesWithEmbeddedContent
object
2 properties
2 required
LibraryArticle
object
28 properties
28 required
AssetFieldsUpdateRequest
array
PatchLocalizedFieldValuesWithEmbeddedContent
object
2 properties
2 required
LibraryAssetFieldDefinition
object
3 properties
2 required
StructuredContentBody
object
The fields of structured content
1 property
LibraryImageUpdateRequest
object
11 properties
BaseAssetField
object
4 properties
4 required
ContentFieldValueWithEmbeddedModel
object
1 property
1 required
LibraryRawFileUpdateRequest
object
10 properties
StringTypeObjectFieldUpdatePayload
LocalizedFieldValues
object
2 properties
2 required
RenditionConfigResponse
object
8 properties
8 required
AssetPermissionBulkCreateRequest
object
2 properties
2 required
Tag
object
2 properties
2 required
ContentFieldValueModel
object
4 properties
2 required
RecursiveStructuredContent
object
8 properties
2 required
ReplaceRelatedAssetsResponse
object
2 properties
2 required
RadioButtonTypeObjectFieldUpdatePayload
AssetFieldUpdateRequest
object
AssetFieldTypePercentageNumber
FolderUpdateRequest
object
2 properties
BaseFieldDefinitionType
string
An enumeration.
VersionedContentTypeModel
object
15 properties
9 required
Error
object
Error payload
2 properties
1 required
ContentFieldsVersionDetails
object
8 properties
5 required
DatetimeFieldDefinition
object
4 properties
3 required
FolderResponse
object
7 properties
7 required
RichTextFieldDefinition
object
4 properties
2 required
AssetVersionCreateRequest
object
2 properties
2 required
DatetimeFieldValueModel
object
2 properties
1 required
ResourceLabelResponse
object
Label associated to a fetched resource
2 properties
2 required
URLFieldValueModel
object
2 properties
1 required
AssetLineageResponse
object
10 properties
10 required
MultiChoiceTypeObjectFieldUpdatePayload
AssetFieldUpdateResponse
object
5 properties
5 required
ChoiceFieldValueModel
object
2 properties
1 required
ChoiceFieldDefinition
object
4 properties
2 required
AssetLineageCreateRequest
object
4 properties
2 required
CoreFieldDef
object
13 properties
5 required
LibraryStructuredContentUpdateRequest
object
3 properties
LibraryStructuredContentCreateRequest
object
3 properties
1 required
RadioButtonTypeObjectField
TextFieldDefinition
object
5 properties
3 required
LibraryAssetCreateRequest
object
3 properties
2 required
RichTextFieldValueModel
object
2 properties
1 required
ContentDetailsModel
object
19 properties
11 required
FolderCreateRequest
object
2 properties
1 required
ContentTypeFieldDefinition
object
6 properties
3 required
ContentFieldValueExpandedModel
object
5 properties
3 required
LibraryAssetType
string
An enumeration.
FeaturedImageResponse
object
9 properties
9 required
LibraryVideo
object
24 properties
24 required
NumberFieldValueModel
object
2 properties
1 required
LibraryAssetVersionResponse
object
8 properties
8 required
BatchFileUrlResponse
object
1 property
1 required
Pagination
object
Pagination related information
2 properties
2 required
NumberFieldDefinition
object
4 properties
1 required
DeleteLocaleFieldValueModel
object
2 properties
2 required
TextFieldValueModel
object
2 properties
1 required
BaseAssetRenditionResponse
object
5 properties
5 required
AssetPermissionListResponseItem
object
2 properties
2 required
RecursivePatchStructuredContentFields
object
8 properties
error_reason
string
An enumeration.
DropdownTypeObjectFieldUpdatePayload
ContentFieldsVersionValidation
object
1 property
RelatedAssetsListResponse
object
2 properties
2 required
LibraryAssetFieldValueModel
object
4 properties
2 required
AssetFieldTypeCurrencyNumber
AssetFieldListResponseItem
DateTypeObjectFieldUpdatePayload
AssetTypeObjectFieldUpdatePayload
FieldType
string
An enumeration.
AssetResponse
object
15 properties
15 required
StructuredContentFields
object
The fields of structured content
AssetContent
object
Content of the asset
2 properties
2 required
DeleteFieldValueModel
object
2 properties
1 required
LibraryAssetDefaultValue
object
2 properties
2 required
BooleanFieldValueModel
object
2 properties
1 required
LibraryRawFile
object
23 properties
23 required
FolderPermissionListResponseItem
object
2 properties
2 required
RelatedAssetItem
object
7 properties
7 required
NumberTypeObjectFieldUpdatePayload
MultiChoiceTypeObjectField
ArticleAuthorResponse
object
Author of the article
1 property
1 required
LibraryStructuredContent
object
11 properties
10 required
BaseFieldDefinition
object
3 properties
2 required
ResourceLabelRequest
object
Payload to associate labels to a resource
2 properties
2 required
FileUrlBulkCreateRequest
object
1 property
1 required
AssetFieldTypes
string
Type of the field
BaseContentTypeVersionModel
object
6 properties
6 required
BasePermissionsResponseSchema
object
6 properties
6 required
AssetFieldTypeSimpleNumber
JSONFieldValueModel
object
2 properties
1 required
ContentFieldWithEmbeddedPatchValueModel
object
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Optimizely publishes across the network.
