{"components":{"schemas":{"AbortStorageTranscodeJobsSchema":{"properties":{"error_message":{"type":"string"}},"type":"object"},"AnalyzeSchema":{"properties":{"force":{"default":false,"type":"boolean"},"force_type":{"default":"APPEND","enum":["OVERWRITE","APPEND"],"nullable":true,"type":"string"},"service_name":{"type":"string"}},"type":"object"},"AssetLinkData":{"properties":{"site_name":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":"string"}},"type":"object"},"AssetLinkURLSchema":{"properties":{"url":{"format":"url","type":"string"}},"required":["url"],"type":"object"},"BulkActionSchema":{"properties":{"object_ids":{"items":{"format":"uuid","type":"string"},"maxItems":500,"minItems":1,"type":"array"},"object_type":{"enum":["assets","collections","saved_searches"],"type":"string"}},"required":["object_ids","object_type"],"type":"object"},"BulkAnalyzeSchema":{"properties":{"force":{"default":false,"type":"boolean"},"force_type":{"default":"OVERWRITE","enum":["OVERWRITE","APPEND"],"nullable":true,"type":"string"},"object_ids":{"items":{"format":"uuid","type":"string"},"maxItems":500,"minItems":1,"type":"array"},"object_type":{"enum":["assets","collections","saved_searches"],"type":"string"},"profile_id":{"format":"uuid","type":"string"}},"required":["object_ids","object_type"],"type":"object"},"BulkTranscribeSchema":{"properties":{"engine":{"nullable":true,"type":"string"},"force":{"default":false,"type":"boolean"},"language":{"nullable":true,"type":"string"},"object_ids":{"items":{"format":"uuid","type":"string"},"maxItems":500,"minItems":1,"type":"array"},"object_type":{"enum":["assets","collections","saved_searches"],"type":"string"},"profile_id":{"format":"uuid","type":"string"},"speakers":{"format":"int32","maximum":100,"minimum":1,"nullable":true,"type":"integer"},"summary":{"nullable":true,"type":"boolean"},"topics_extraction":{"default":true,"type":"boolean"},"translate_languages":{"default":[],"items":{"type":"string"},"nullable":true,"type":"array"}},"required":["object_ids","object_type"],"type":"object"},"EdgeThumbnailJobFieldSchema":{"properties":{"height":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"id":{"type":"string"},"max_number":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"min_interval":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"timestamp":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"width":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"}},"type":"object"},"EdgeTranscodeEndpointSchema":{"properties":{"data":{"type":"object"},"method":{"type":"string"},"storage_method":{"type":"string"},"type":{"type":"string"},"url":{"type":"string"}},"required":["url"],"type":"object"},"EdgeTranscodeInputSchema":{"properties":{"asset_id":{"type":"string"},"closed_captions":{"type":"boolean"},"directory_path":{"type":"string"},"endpoint":{"$ref":"#/components/schemas/EdgeTranscodeEndpointSchema"},"file_id":{"type":"string"},"file_set_id":{"nullable":true,"type":"string"},"format_id":{"nullable":true,"type":"string"},"language":{"type":"string"},"original_name":{"type":"string"},"proxy_id":{"nullable":true,"type":"string"},"storage_id":{"type":"string"}},"required":["endpoint"],"type":"object"},"EdgeTranscodeJobFieldSchema":{"properties":{"height":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"id":{"type":"string"},"width":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"}},"type":"object"},"EdgeTranscodeJobSchema":{"properties":{"asset_id":{"type":"string"},"collection_id":{"type":"string"},"input":{"$ref":"#/components/schemas/EdgeTranscodeInputSchema"},"job_id":{"type":"string"},"job_steps":{"items":{"$ref":"#/components/schemas/JobStep"},"type":"array"},"media_info":{"nullable":true,"type":"string"},"thumbnail":{"items":{"$ref":"#/components/schemas/EdgeThumbnailJobFieldSchema"},"type":"array"},"transcode":{"items":{"$ref":"#/components/schemas/EdgeTranscodeJobFieldSchema"},"type":"array"}},"required":["input"],"type":"object"},"EdgeTranscodeJobsSchema":{"properties":{"objects":{"items":{"$ref":"#/components/schemas/EdgeTranscodeJobSchema"},"type":"array"}},"type":"object"},"EdgeTranscodeWorkerSchema":{"properties":{"id":{"format":"uuid","readOnly":true,"type":"string"},"last_update_date":{"format":"date-time","readOnly":true,"type":"string"},"status":{"enum":["ACTIVE","INACTIVE"],"type":"string"},"storage_id":{"format":"uuid","type":"string"}},"required":["status","storage_id"],"type":"object"},"EdgeTranscodeWorkersSchema":{"properties":{"objects":{"items":{"$ref":"#/components/schemas/EdgeTranscodeWorkerSchema"},"type":"array"}},"type":"object"},"EndpointSchema":{"properties":{"data":{"type":"object"},"headers":{"type":"object"},"method":{"type":"string"},"storage_method":{"type":"string"},"type":{"type":"string"},"url":{"type":"string"}},"required":["url"],"type":"object"},"FacetBucketSchema":{"properties":{"doc_count":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"key":{"type":"string"}},"type":"object"},"FacetSchema":{"properties":{"buckets":{"items":{"$ref":"#/components/schemas/FacetBucketSchema"},"type":"array"},"doc_count_error_upper_bound":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"sum_other_doc_count":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"}},"type":"object"},"GenerateCollectionKeyframeSchema":{"properties":{"deleted_asset_id":{"format":"uuid","type":"string"},"force":{"type":"boolean"},"specified_asset_ids":{"items":{"format":"uuid","type":"string"},"maxItems":4,"minItems":0,"type":"array"},"specified_keyframes":{"items":{"$ref":"#/components/schemas/SpecifiedKeyframes"},"maxItems":4,"minItems":0,"type":"array"}},"type":"object"},"InputSchema":{"properties":{"asset_id":{"nullable":true,"type":"string"},"closed_captions":{"type":"boolean"},"collection_id":{"nullable":true,"type":"string"},"directory_path":{"nullable":true,"type":"string"},"endpoint":{"$ref":"#/components/schemas/EndpointSchema"},"engine":{"type":"string"},"file_id":{"nullable":true,"type":"string"},"file_set_id":{"nullable":true,"type":"string"},"format_id":{"nullable":true,"type":"string"},"language":{"type":"string"},"original_name":{"type":"string"},"proxy_id":{"nullable":true,"type":"string"},"storage_id":{"type":"string"},"update_proxy_mediainfo":{"nullable":true,"type":"boolean"},"version_id":{"nullable":true,"type":"string"}},"required":["endpoint"],"type":"object"},"JobBaseSchema":{"properties":{"asset_id":{"type":"string"},"collection_id":{"type":"string"},"input":{"$ref":"#/components/schemas/InputSchema"},"job_id":{"type":"string"},"job_steps":{"items":{"$ref":"#/components/schemas/JobStep"},"type":"array"},"media_info":{"nullable":true,"type":"string"},"thumbnail":{"items":{"$ref":"#/components/schemas/ThumbnailJob"},"type":"array"},"transcode":{"items":{"$ref":"#/components/schemas/TranscodeJob"},"type":"array"}},"type":"object"},"JobSchema":{"properties":{"amazon_rekognition":{"type":"boolean"},"analysis_data":{"type":"object"},"analysis_query_default_service_account":{"type":"boolean"},"analyzed_before":{"type":"boolean"},"asset_id":{"type":"string"},"asset_link":{"type":"string"},"collection_id":{"type":"string"},"create_transcription":{"type":"boolean"},"delete_old_transcriptions":{"type":"boolean"},"force_transcoder":{"type":"string"},"google_cloud_video_intelligence":{"type":"boolean"},"input":{"$ref":"#/components/schemas/InputSchema"},"job_id":{"type":"string"},"job_steps":{"items":{"$ref":"#/components/schemas/JobStep"},"type":"array"},"language":{"nullable":true,"type":"string"},"media_info":{"nullable":true,"type":"string"},"overwrite":{"type":"boolean"},"priority":{"format":"int32","maximum":10,"minimum":1,"type":"integer"},"speakers":{"format":"int32","maximum":100,"minimum":2,"nullable":true,"type":"integer"},"thumbnail":{"items":{"$ref":"#/components/schemas/ThumbnailJob"},"type":"array"},"transcode":{"items":{"$ref":"#/components/schemas/TranscodeJob"},"type":"array"},"valid_transcoders":{"items":{"$ref":"#/components/schemas/Transcoders"},"type":"array"},"version_id":{"type":"string"}},"type":"object"},"JobStep":{"properties":{"date_created":{"format":"date-time","type":"string"},"date_updated":{"format":"date-time","type":"string"},"id":{"type":"string"},"label":{"type":"string"},"message":{"type":"string"},"status":{"type":"string"}},"type":"object"},"JobStepSchema":{"properties":{"date_created":{"format":"date-time","type":"string"},"date_updated":{"format":"date-time","type":"string"},"id":{"type":"string"},"label":{"type":"string"},"message":{"type":"string"},"status":{"type":"string"}},"type":"object"},"JobsPrioritySchema":{"properties":{"job_ids":{"items":{"format":"uuid","type":"string"},"maxItems":500,"minItems":1,"type":"array"},"priority":{"format":"int32","maximum":10,"minimum":1,"type":"integer"}},"required":["job_ids","priority"],"type":"object"},"JobsStateSchema":{"properties":{"action":{"enum":["ABORT","RESTART"],"type":"string"},"job_ids":{"items":{"format":"uuid","type":"string"},"maxItems":500,"minItems":1,"type":"array"}},"required":["action","job_ids"],"type":"object"},"ListObjectsSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"LocalStorageFileTranscodeJobSchema":{"properties":{"asset_id":{"type":"string"},"checksum":{"nullable":true,"type":"string"},"collection_id":{"nullable":true,"type":"string"},"component_ids":{"items":{"type":"string"},"type":"array"},"directory_path":{"type":"string"},"file_id":{"type":"string"},"file_set_id":{"type":"string"},"filename":{"type":"string"},"format_id":{"type":"string"},"id":{"type":"string"},"job_id":{"type":"string"},"metadata_update_only":{"nullable":true,"type":"boolean"},"priority":{"format":"int32","maximum":10,"minimum":1,"type":"integer"},"size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"version_id":{"type":"string"}},"required":["asset_id","directory_path","file_id","file_set_id","filename","format_id","job_id","size","version_id"],"type":"object"},"LocalStorageFileTranscodeJobsSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/LocalStorageFileTranscodeJobSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"LocalTranscodeInputSchema":{"properties":{"asset_id":{"type":"string"},"checksum":{"nullable":true,"type":"string"},"closed_captions":{"type":"boolean"},"collection_id":{"nullable":true,"type":"string"},"component_ids":{"items":{"type":"string"},"type":"array"},"directory_path":{"type":"string"},"endpoint":{"$ref":"#/components/schemas/EndpointSchema"},"engine":{"type":"string"},"file_id":{"type":"string"},"file_set_id":{"type":"string"},"filename":{"type":"string"},"format_id":{"type":"string"},"language":{"type":"string"},"original_name":{"type":"string"},"proxy_id":{"nullable":true,"type":"string"},"size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"storage_id":{"type":"string"},"update_proxy_mediainfo":{"nullable":true,"type":"boolean"},"version_id":{"type":"string"}},"required":["asset_id","directory_path","endpoint","file_id","file_set_id","filename","format_id","size","storage_id","version_id"],"type":"object"},"LocalTranscodeJobSchema":{"properties":{"amazon_rekognition":{"type":"boolean"},"analysis_data":{"type":"object"},"analysis_query_default_service_account":{"type":"boolean"},"analyzed_before":{"type":"boolean"},"asset_id":{"type":"string"},"asset_link":{"type":"string"},"collection_id":{"type":"string"},"create_transcription":{"type":"boolean"},"delete_old_transcriptions":{"type":"boolean"},"force_transcoder":{"type":"string"},"google_cloud_video_intelligence":{"type":"boolean"},"input":{"$ref":"#/components/schemas/LocalTranscodeInputSchema"},"job_id":{"type":"string"},"job_steps":{"items":{"$ref":"#/components/schemas/JobStepSchema"},"type":"array"},"language":{"nullable":true,"type":"string"},"media_info":{"nullable":true,"type":"string"},"overwrite":{"type":"boolean"},"priority":{"format":"int32","maximum":10,"minimum":1,"type":"integer"},"speakers":{"format":"int32","maximum":100,"minimum":2,"nullable":true,"type":"integer"},"thumbnail":{"items":{"$ref":"#/components/schemas/ThumbnailJob"},"type":"array"},"transcode":{"items":{"$ref":"#/components/schemas/TranscodeJob"},"type":"array"},"valid_transcoders":{"items":{"$ref":"#/components/schemas/Transcoders"},"type":"array"},"version_id":{"type":"string"}},"required":["input"],"type":"object"},"OutputEndpoint":{"properties":{"headers":{"type":"object"},"key":{"type":"string"}},"required":["key"],"type":"object"},"OutputEndpointSchema":{"properties":{"headers":{"type":"object"},"key":{"type":"string"}},"required":["key"],"type":"object"},"ReindexQueueRecordSchema":{"properties":{"sync_to_another_dc":{"type":"boolean"}},"type":"object"},"SpecifiedKeyframes":{"properties":{"url":{"type":"string"}},"required":["url"],"type":"object"},"SpecifiedKeyframesSchema":{"properties":{"url":{"type":"string"}},"required":["url"],"type":"object"},"ThumbnailJob":{"properties":{"height":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"id":{"type":"string"},"max_number":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"min_interval":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"output_endpoint":{"$ref":"#/components/schemas/OutputEndpoint"},"set_as_custom_keyframe":{"type":"boolean"},"time_end_milliseconds":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"nullable":true,"type":"integer"},"time_start_milliseconds":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"nullable":true,"type":"integer"},"timestamp":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"width":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"}},"required":["output_endpoint"],"type":"object"},"ThumbnailJobSchema":{"properties":{"height":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"id":{"type":"string"},"max_number":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"min_interval":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"output_endpoint":{"$ref":"#/components/schemas/OutputEndpointSchema"},"set_as_custom_keyframe":{"type":"boolean"},"time_end_milliseconds":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"nullable":true,"type":"integer"},"time_start_milliseconds":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"nullable":true,"type":"integer"},"timestamp":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"width":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"}},"required":["output_endpoint"],"type":"object"},"TranscodeESQueueRecordsSchema":{"properties":{"objects":{"items":{"$ref":"#/components/schemas/TranscodeElasticQueueRecord"},"readOnly":true,"type":"array"}},"type":"object"},"TranscodeElasticQueueRecord":{"properties":{"date_created":{"readOnly":true,"type":"string"},"date_updated":{"readOnly":true,"type":"string"},"id":{"readOnly":true,"type":"string"},"job_id":{"readOnly":true,"type":"string"},"object_id":{"readOnly":true,"type":"string"},"object_type":{"readOnly":true,"type":"string"},"priority":{"readOnly":true,"type":"string"},"queue":{"readOnly":true,"type":"string"},"retry_count":{"readOnly":true,"type":"string"},"status":{"readOnly":true,"type":"string"},"storage_id":{"readOnly":true,"type":"string"},"system_domain_id":{"readOnly":true,"type":"string"},"system_domain_timestamp":{"readOnly":true,"type":"string"},"system_name":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"user_id":{"readOnly":true,"type":"string"},"version_id":{"readOnly":true,"type":"string"}},"type":"object"},"TranscodeElasticQueueRecordSchema":{"properties":{"date_created":{"readOnly":true,"type":"string"},"date_updated":{"readOnly":true,"type":"string"},"id":{"readOnly":true,"type":"string"},"job_id":{"readOnly":true,"type":"string"},"object_id":{"readOnly":true,"type":"string"},"object_type":{"readOnly":true,"type":"string"},"priority":{"readOnly":true,"type":"string"},"queue":{"readOnly":true,"type":"string"},"retry_count":{"readOnly":true,"type":"string"},"status":{"readOnly":true,"type":"string"},"storage_id":{"readOnly":true,"type":"string"},"system_domain_id":{"readOnly":true,"type":"string"},"system_domain_timestamp":{"readOnly":true,"type":"string"},"system_name":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"user_id":{"readOnly":true,"type":"string"},"version_id":{"readOnly":true,"type":"string"}},"type":"object"},"TranscodeJob":{"properties":{"height":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"id":{"type":"string"},"output_endpoint":{"$ref":"#/components/schemas/OutputEndpoint"},"width":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"}},"required":["output_endpoint"],"type":"object"},"TranscodeJobSchema":{"properties":{"height":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"id":{"type":"string"},"output_endpoint":{"$ref":"#/components/schemas/OutputEndpointSchema"},"width":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"}},"required":["output_endpoint"],"type":"object"},"TranscodeQueueObjectSchema":{"properties":{"date_created":{"format":"date-time","type":"string"},"date_updated":{"format":"date-time","type":"string"},"id":{"format":"uuid","type":"string"},"job_id":{"format":"uuid","type":"string"},"priority":{"format":"int32","maximum":10,"minimum":1,"type":"integer"},"retry_count":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"status":{"type":"string"},"system_domain":{"type":"string"},"system_domain_id":{"format":"uuid","type":"string"},"system_domain_timestamp":{"type":"number"},"system_name":{"type":"string"},"type":{"type":"string"},"user_id":{"format":"uuid","type":"string"}},"type":"object"},"TranscodeQueueRecordSchema":{"properties":{"bytes_params":{"nullable":true},"date_created":{"type":"string"},"date_updated":{"type":"string"},"id":{"format":"uuid","type":"string"},"job_id":{"format":"uuid","nullable":true,"type":"string"},"media_info":{"nullable":true,"type":"string"},"object_id":{"format":"uuid","nullable":true,"type":"string"},"object_type":{"nullable":true,"type":"string"},"params":{"nullable":true,"type":"string"},"priority":{"nullable":true,"type":"integer"},"retry_count":{"nullable":true,"type":"integer"},"spec":{"nullable":true,"type":"string"},"status":{"nullable":true,"type":"string"},"system_domain_id":{"format":"uuid","nullable":true,"type":"string"},"system_name":{"type":"string"},"transcoder_id":{"format":"uuid","nullable":true,"type":"string"},"type":{"nullable":true,"type":"string"},"user_id":{"format":"uuid","nullable":true,"type":"string"},"version_id":{"format":"uuid","nullable":true,"type":"string"}},"type":"object"},"TranscodeQueueSchema":{"properties":{"facets":{"additionalProperties":{"$ref":"#/components/schemas/FacetSchema"},"type":"object"},"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/TranscodeQueueObjectSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"TranscodeValidateMediaInfoSchema":{"properties":{"filename":{"type":"string"},"media_info":{"type":"string"}},"required":["media_info"],"type":"object"},"Transcoders":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"settings":{"type":"object"},"type":{"type":"string"}},"type":"object"},"TranscodersSchema":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"settings":{"type":"object"},"type":{"type":"string"}},"type":"object"},"TranscribeSchema":{"properties":{"engine":{"nullable":true,"type":"string"},"force":{"default":false,"type":"boolean"},"language":{"nullable":true,"type":"string"},"profile_id":{"format":"uuid","type":"string"},"speakers":{"format":"int32","maximum":100,"minimum":1,"nullable":true,"type":"integer"},"summary":{"nullable":true,"type":"boolean"},"topics_extraction":{"default":true,"type":"boolean"},"translate_languages":{"default":[],"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}}},"info":{"title":"Iconik Transcode","version":"2.0.0"},"openapi":"3.0.3","paths":{"/":{},"/ip/":{},"/livez/":{},"/readyz/":{},"/spec/":{},"/static/{filename}":{},"/v1/analyze/assets/{asset_id}/":{"post":{"deprecated":true,"description":"\nRequired roles:\n - can_analyze_content\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyzeSchema"}}},"description":"body","required":false},"responses":{"201":{"description":"Returns a definition of the started job"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Start a job that sends an asset for analysis"}},"/v1/analyze/assets/{asset_id}/profiles/default/":{"post":{"description":"\nRequired roles:\n - can_analyze_content\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyzeSchema"}}},"description":"body","required":false},"responses":{"201":{"description":"Returns a definition of the started job"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Start a job that sends an asset for analysis with a default analysis profile"}},"/v1/analyze/assets/{asset_id}/profiles/default/{media_type}/":{"post":{"description":"with a default analysis profile of specified media typewith a default analysis profile of specified media type\nRequired roles:\n - can_analyze_content\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"media_type","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyzeSchema"}}},"description":"body","required":false},"responses":{"201":{"description":"Returns a definition of the started job"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Start a job that sends an asset for analysis"}},"/v1/analyze/assets/{asset_id}/profiles/{profile_id}/":{"post":{"description":"\nRequired roles:\n - can_analyze_content\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"profile_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyzeSchema"}}},"description":"body","required":false},"responses":{"201":{"description":"Returns a definition of the started job"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Start a job that sends an asset for analysis with a custom analysis profile"}},"/v1/analyze/bulk/":{"post":{"description":"\nRequired roles:\n - can_analyze_content\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkAnalyzeSchema"}}},"description":"body","required":false},"responses":{"201":{"description":"Returns a definition of the started job"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Analysis account/profile was not found"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Start a job that sends objects for analysis using a custom analysis profile"}},"/v1/edge_transcode/jobs/{job_id}/acknowledge/":{"post":{"description":"\nRequired roles:\n - can_read_transcode_jobs\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"job_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"Acknowledge an edge transcode job"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Edge transcode job doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Acknowledge an edge transcode job"}},"/v1/edge_transcode/workers/":{"get":{"description":"\nRequired roles:\n - is_storage_worker\n- can_read_transcoders\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdgeTranscodeWorkersSchema"}}},"description":"Returns edge transcode workers"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get edge transcode workers"},"post":{"description":"\nRequired roles:\n - is_storage_worker\n- can_write_transcoders\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdgeTranscodeWorkerSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdgeTranscodeWorkerSchema"}}},"description":"Returns an edge transcode worker"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create a new edge transcode worker"}},"/v1/edge_transcode/workers/{worker_id}/":{"delete":{"description":"\nRequired roles:\n - is_storage_worker\n- can_write_transcoders\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"worker_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Edge transcode worker doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete a edge transcode worker"},"get":{"description":"\nRequired roles:\n - is_storage_worker\n- can_read_transcoders\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"worker_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdgeTranscodeWorkerSchema"}}},"description":"Returns a edge transcode worker"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Edge transcode worker doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get a edge transcode worker"},"patch":{"description":"\nRequired roles:\n - is_storage_worker\n- can_write_transcoders\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"worker_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdgeTranscodeWorkerSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdgeTranscodeWorkerSchema"}}},"description":"Returns a edge transcode worker that was updated"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Edge transcode worker doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update a edge transcode worker"},"put":{"description":"\nRequired roles:\n - is_storage_worker\n- can_write_transcoders\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"worker_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdgeTranscodeWorkerSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdgeTranscodeWorkerSchema"}}},"description":"Returns a edge transcode worker that was updated"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Edge transcode worker doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update a edge transcode worker"}},"/v1/keyframes/collections/{collection_id}/":{"post":{"description":"\nRequired roles:\n - can_write_transcode_jobs\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"collection_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateCollectionKeyframeSchema"}}},"description":"body","required":false},"responses":{"201":{"description":"Returns a definiton of the started job"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Start a job that creates a collection keyframe"}},"/v1/keyframes/playlists/{playlist_id}/":{"post":{"description":"\nRequired roles:\n - can_write_transcode_jobs\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"playlist_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateCollectionKeyframeSchema"}}},"description":"body","required":false},"responses":{"201":{"description":"Returns a definiton of the started job"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Start a job that creates a playlist keyframe"}},"/v1/storages/{storage_id}/":{"delete":{"description":"\nRequired roles:\n - can_delete_transcode_jobs\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AbortStorageTranscodeJobsSchema"}}},"description":"body","required":false},"responses":{"202":{"description":"Successfully scheduled operation"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"User does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Cancel all transcode jobs linked to the storage"}},"/v1/storages/{storage_id}/edge_transcode/jobs/":{"get":{"description":"\nRequired roles:\n - can_read_transcode_jobs\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The max number of items to fetch","in":"query","name":"limit","schema":{"default":10,"format":"int32","type":"integer"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EdgeTranscodeJobsSchema"}}},"description":"Returns all analysis service accounts"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get a edge transcode jobs from the job queue"}},"/v1/storages/{storage_id}/files/{file_id}/transcode/":{"delete":{"deprecated":true,"description":"\nRequired roles:\n - can_read_transcode_jobs\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Transcode job was deleted"},"404":{"description":"Transcode job does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete local storage transcode job."}},"/v1/storages/{storage_id}/transcode/":{"get":{"description":"\nRequired roles:\n - can_read_transcode_jobs\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"format":"int32","type":"integer"},"style":"form"},{"description":"ID of a last transcode job entity on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalStorageFileTranscodeJobsSchema"}}},"description":"Returns pending transcode jobs to be handled"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get pending local storage transcode jobs."}},"/v1/storages/{storage_id}/transcode/{record_id}/":{"delete":{"description":"\nRequired roles:\n - can_read_transcode_jobs\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"record_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Transcode job was deleted"},"404":{"description":"Transcode job does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete local storage transcode job."},"get":{"description":"\nRequired roles:\n - can_read_transcode_jobs\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"record_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalStorageFileTranscodeJobSchema"}}},"description":"Returns pending transcode job to be handled"},"404":{"description":"Transcode job does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get local storage transcode job."}},"/v1/transcode/":{"post":{"deprecated":true,"description":"Use /API/files/v1/assets/ID/files/ID/keyframes insteadUse /API/files/v1/assets/ID/files/ID/keyframes instead\nRequired roles:\n - can_write_transcode_jobs\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobSchema"}}},"description":"Returns a definiton of the started job"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Starts a new transcode."}},"/v1/transcode/queue/":{"get":{"description":"\nRequired roles:\n - can_read_transcode_jobs\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"per_page","schema":{"format":"int32","type":"integer"},"style":"form"},{"in":"query","name":"page","schema":{"format":"int32","type":"integer"},"style":"form"},{"description":"A comma separated list of fieldnames without spaces. object_type,user_id,retry_count,priority,type,status","in":"query","name":"sort","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranscodeQueueSchema"}}},"description":"Returns the status of all ongoing transcode jobs"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get all the statuses of the queued transcode jobs"}},"/v1/transcode/queue/system/":{"get":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"per_domain_id","schema":{"type":"boolean"},"style":"form"},{"in":"query","name":"per_page","schema":{"format":"int32","type":"integer"},"style":"form"},{"in":"query","name":"page","schema":{"format":"int32","type":"integer"},"style":"form"},{"in":"query","name":"sort","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranscodeQueueSchema"}}},"description":"Returns the status of all ongoing transcode job queues for all domains"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get the status of the transcode job queues"}},"/v1/transcode/{object_type}/{object_id}/":{"get":{"description":"\nRequired roles:\n - can_read_transcode_jobs\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_type","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranscodeESQueueRecordsSchema"}}},"description":"Returns list of transcode queue records"},"400":{"description":"Bad request - malformed parameters"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns list of transcode queue records by object_id"}},"/v1/transcode/{object_type}/{object_id}/versions/{version_id}/":{"get":{"description":"\nRequired roles:\n - can_read_transcode_jobs\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_type","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"version_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranscodeESQueueRecordsSchema"}}},"description":"Returns list of transcode queue records"},"400":{"description":"Bad request - malformed parameters"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns list of transcode queue records by version_id"}},"/v1/transcode/{transcode_job_id}/":{"delete":{"deprecated":true,"description":"\nRequired roles:\n - can_delete_transcode_jobs\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"transcode_job_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Transcode does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Cancel a particular transcode job by id"},"get":{"description":"\nRequired roles:\n - can_read_transcode_jobs\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"transcode_job_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobSchema"}}},"description":"Returns the status of a particular transcode job"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get transcode job"}},"/v1/transcode/{transcode_job_id}/position/{position}/":{"post":{"deprecated":true,"description":"\nRequired roles:\n - can_write_transcode_jobs\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"transcode_job_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"move transcode job to \"top\" or \"bottom\" position","in":"path","name":"position","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Transcode does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Move transcode job to top or bottom of the queue"}},"/v1/transcode/{transcode_job_id}/priority/{priority}/":{"put":{"deprecated":true,"description":"\nRequired roles:\n - can_write_transcode_jobs\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"transcode_job_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"priority","required":true,"schema":{"format":"int32","type":"integer"},"style":"simple"}],"responses":{"200":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Transcode does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Change transcode job priority"}},"/v1/transcribe/assets/{asset_id}/profiles/default/":{"post":{"description":"\nRequired roles:\n - can_transcribe_content\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranscribeSchema"}}},"description":"body","required":false},"responses":{"201":{"description":"Returns a definition of the started job"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Start a job that sends an asset to default transcription service"}},"/v1/transcribe/bulk/":{"post":{"description":"\nRequired roles:\n - can_transcribe_content\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkTranscribeSchema"}}},"description":"body","required":true},"responses":{"201":{"description":"Returns a definition of the started job"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Start a job that sends multiple objects to transcription service"}}},"servers":[{"url":"/API/transcode/"}]}