Enums and Lookups (SDK)

assetType (on get_asset / child-node results)

Use asset.get("assetType") == 1 to confirm something is a folder.

upload_overwrite_option (upload)

Search filter operator

The authoritative SearchFilterOperator enum (from the OpenAPI spec)
is, with its integer code:

⚠️

The string is "NotEquals" (plural). Earlier docs said "NotEqual" - wrong; the

enum is NotEquals. Like, NotLike, and Prefix are real and were previously omitted.

A filter is {"fieldName": <camelCased field>, "operator": <one above>, "values": <value-or-list>}.
A list of values is OR-combined. Dates must be UTC YYYY-MM-DDTHH:MM:SS.SSSZ.

Matching semantics:

• Equals/Contains match analyzed text (token/phrase). For a strict, case-sensitive exact
  match on a string field, append .keyword to the fieldName.
• Like/NotLike are wildcard patterns (* = any run, ? = one char), case-insensitive.
  Prefix is starts-with.
• The ranges (LessThan/GreaterThan/LessThanEquals/GreaterThanEquals) work on dates and
  numbers. Range and Prefix are not supported against an array of values - the API
  returns 400.
• Add "includeNull": true to a filter to also match records where the field is absent/null
  (the query ORs in an Exists negation), instead of excluding them.

Common filter fieldNames

These fields are commonly filtered with operator: "Equals":

Search sort_fields

Each entry is {"fieldName": <camelCased field>, "sortType": "Ascending" | "Descending"}.

⚠️

Some older examples use "sortOrder" with lowercase ascending/descending. The

SDK actually sends sortType with Ascending/Descending. Use sortType.

Search filter_binder

0 = AND (default), 1 = OR. It controls two things: whether the filters
array is joined with AND vs OR, and the default operator
applied between the terms of a free-text query. Leave it unset for the usual AND behaviour;
set 1 to broaden a query to "match any". The full enum is SearchConditionBinders below.

Search free-text scoping (search_text_fields)

query searches all indexed text fields by default. Pass search_text_fields (a list of the
member names below) to restrict it to specific buckets - e.g. only transcripts/subtitles, or
only EXIF. The platform label (what the field bucket actually holds) is in the right column.

The concrete search field each member maps to is configured per deployment; members the
deployment hasn't mapped are silently ignored. When search_text_fields is omitted the search
covers every mapped bucket plus the general content field.

Find-similar & LLM search

Two modes don't use query/filters the usual way:

• similar_asset_id runs a vector KNN "find similar" against that asset and ignores
  query and offset; min_score (default ~0.65) is the relevance cut-off. Requires vector
  search enabled for the asset - otherwise the result carries a "Similar searching is not enabled"
  message and no items.
• use_llm_search=True runs LLM/semantic search over a query (segment-level for video);
  paging is disabled in this mode.

Live channel status (LiveChannelStatus)

A live channel's status is nested on the channel object as status = {id, description},
where description is the name below and id is the matching LiveChannelStatusLookup
UUID. The int form is the LiveChannelStatus enum (handy for ordering/log lines).

The two terminal lifecycle states for the start/stop flow are Running (after start)
and Idle (after stop) - see recipes/live-channels.md. get_live_channel_status
(JS) returns the description string; if the channel is gone it returns "Deleted".

Live channel type (LiveChannelType)

A channel's type is a lookup; map its value via either column. The lookup UUIDs are the
LiveChannelTypeLookup enum.

Live channel search/returned fields (LiveChannelInfoReturnedFieldName)

When listing channels via search (e.g. contentDefinitionId Equals <liveChannel-cd-id>),
these dotted field names select the live-channel-specific fields on each result:

Selecting returned fields

There are two field-selection mechanisms on the wire:

• search_result_fields (SDK param) → wire searchResultFields: a list of
  {"name": "<fieldName>"} objects. This is the current mechanism.
• returnedFieldNames: a plain list of strings. Marked deprecated in the spec
  but still accepted - e.g.
  ["identifiers.assetType", "identifiers.createdDate", "identifiers.displayName"].

Field names can be dotted paths that reach into the nested identifiers object on each
result, e.g. identifiers.displayName, identifiers.parentId, identifiers.assetType.
Prefer search_result_fields for new code; expect returnedFieldNames in older payloads.

Enum reference

Member names come from the OpenAPI spec; integer wire codes are the platform's published enum codes. Blank int = string enum with no published integer code.

AdSlotTypes

AssetStatuses (flags)

AssetTransferStatuses (flags)

AssetTypes

AssociatedAssetLocations

AssociatedAssetSources

AssociatedAssetTypes

AvailabilityStatuses

CloudFrontDistributions

ConfigTypes

ContentLanguageStatuses

ContentManagementTypes

ContentTextTypes

EmailTypes

EmbeddingTypes

FaceMatchTypes

InputCodec

InputMaximumBitrate

InputResolution

LiveChannelTypes

LiveRequestActions

LiveRequestTargets (flags)

LiveScheduleStatus

LoginResponseStatuses

LookupTypes

MediaTypes

MessageInfoTypes

MetadataTypes

NewsRoomFailureType

OutputType

PingStatuses

PropertyChangeTypes

RecordingStatus

ScheduleItemSearchTypes

ScheduleItemSourceTypes

ScheduleItemTypes (flags)

ScheduleStatuses (flags)

ScheduleTypes (flags)

SearchConditionBinders

SearchFilterOperators

SearchSortTypes

SearchTextFields

SecureOutputFieldStates

SecurityPermissions

SharePermissions

ShareStatus

ShareType

SiteInitializationStatuses

State

Status

StorageClasses (flags)

TextCaptionTypes

TranscriptionContainerOutputTypes

Type

UploadOverwriteOptions

UploadReplaceOptions

UserSessionStatuses

VideoTrackingAttributes

VideoTrackingEvents