# API Documentation ## Contents [Parameters](http://docs.streamengine.igolgi.com/books/igolgi-stream-engine/page/api-documentation#bkmrk-parameters) [Cloud Credentials](http://docs.streamengine.igolgi.com/books/igolgi-stream-engine/page/api-documentation#bkmrk-cloud-credentials) [Cloud Credentials Input/Output](http://docs.streamengine.igolgi.com/books/igolgi-stream-engine/page/api-documentation#bkmrk-cloud-credentials-in) [Audio Profiles](http://docs.streamengine.igolgi.com/books/igolgi-stream-engine/page/api-documentation#bkmrk-audio-profiles) [Video Profiles](http://docs.streamengine.igolgi.com/books/igolgi-stream-engine/page/api-documentation#bkmrk-video-profiles) [Supported Containers and Codecs](http://docs.streamengine.igolgi.com/books/igolgi-stream-engine/page/api-documentation#bkmrk-supported-containers) [Creating Jobs](http://docs.streamengine.igolgi.com/books/igolgi-stream-engine/page/creating-curl-jobs) [ Using the API from within Python](http://docs.streamengine.igolgi.com/books/igolgi-stream-engine/page/code) [Retrieving a Sent Job](http://docs.streamengine.igolgi.com/books/igolgi-stream-engine/page/creating-curl-jobs#bkmrk-retrieving-a-sent-jo) ### Parameters #### input or not to use this input. This will be an object key if using a cloud provider, or a regular URL otherwise.
TypeRequiredDefault
stringYes
#### videoProfiles An array containing at least one video profile.
TypeRequiredDefault
arrayYes
#### audioProfiles An array containing zero or more audio profiles.
TypeRequiredDefault
arrayYes
#### output\_container Output container to be used. Supported values are ts, mp4, hls, and silverlight .
TypeRequiredDefault
stringNomp4
#### ts\_mode\_input\_audio\_source\_stream\_count Audio stream count (in TS mode only).
TypeRequiredDefault
numberNo
#### audio\_output\_path The cloud location where audio should be stored.
TypeRequiredDefault
stringNo
#### bucket\_output\_path The location, within a cloud bucket, where the output should be stored in segmented mode.
TypeRequiredDefault
stringNo
#### master\_variant\_mode Whether or not to use separate audio.
TypeRequiredDefault
booleanNofalse
#### segmented\_output\_hls Whether to use HLS in segmented output.
TypeRequiredDefault
booleanNofalse
#### segmented\_output\_dash Whether to use DASH in segmented output.
TypeRequiredDefault
booleanNofalse
#### segment\_length The segment length in segmented output.
TypeRequiredDefault
numberNo
#### video\_codec Output video encoder. Supported values are h.264, mpeg2, and hevc.
TypeRequiredDefault
stringNoh.264
#### ip\_distance Target I/P frame distance.
TypeRequiredDefault
numberNo
#### gop\_length Target GOP length in seconds.
TypeRequiredDefault
numberNo1
#### scte35\_passthough Use SCTE35 passthrough?
TypeRequiredDefault
booleanNofalse
#### scte35\_pid\_remap PID Remap.
TypeRequiredDefault
numberNo
#### create\_tar\_file In segmented output, whether to tar the resulting directory and store it in the same bucket specified by the bucket\_output\_path parameter. Note that this will take up more space in your bucket.
TypeRequiredDefault
booleanNo
#### audio\_volume Target audio volume (0-200).
TypeRequiredDefault
numberNo100
#### h264\_quality Output quality. Accepted values are 'good', 'better', and 'best'. Supported values are good, better , and best.
TypeRequiredDefault
stringNogood
#### video\_aspect\_ratio Output video aspect ratio. Supported values are passthrough, force\_4:3, force\_16:9, invert\_aspect\_ratio, rotate\_counterclockwise , rotate\_clockwise, and rotate\_counterclockwise + invert\_aspect\_ratio.
TypeRequiredDefault
stringNopassthrough
#### rotation\_blackness ... .
TypeRequiredDefault
numberNo
#### closed\_captions Write CC to output?
TypeRequiredDefault
booleanNo
#### force\_progressive Force progressive?
TypeRequiredDefault
booleanNofalse
#### keep\_fps Preserve the framerate?
TypeRequiredDefault
booleanNotrue
#### logo\_url URL to an image file to use as a watermark.
TypeRequiredDefault
stringNo
#### cloud\_credentials See Below
TypeRequiredDefault
objectYes
### Cloud Credentials #### input
TypeRequiredDefault
object Yes
#### output
TypeRequiredDefault
object Yes
### Cloud Credentials Input/Output #### cloud\_provider The cloud provider to use
Supported values are aws, oracle, gcloud, http, file-upload, igolgi-store .
TypeRequiredDefault
stringYesoracle
#### access\_key Account access key.
TypeRequiredDefault
stringNo
#### secret\_key Account secret key.
TypeRequiredDefault
stringNo
#### region The region within which your target bucket is located.
TypeRequiredDefault
stringNo
\------ #### tenancy\_ocid Tenancy OCID (for oracle only)
TypeRequiredDefault
stringNo
#### user\_ocid User OCID (for oracle only)
TypeRequiredDefault
stringNo
#### oci\_fingerprint User Fingerprint (for oracle only)
TypeRequiredDefault
stringNo
#### project\_id Project ID (for google only)
TypeRequiredDefault
stringNo
#### client\_email Client email (for google only)
TypeRequiredDefault
stringNo
#### client\_id Client ID (for google only)
TypeRequiredDefault
stringNo
#### private\_key\_id Private Key ID (for google only)
TypeRequiredDefault
stringNo
### Audio Profiles #### audio\_codec Audio codec to be used during transcode. Supported values are aac, ac3 or mp2.
TypeRequiredDefault
stringNoaac
#### audio\_channels Number of audio channels on the output. Use 2 for stereo and 6 for 5.1. Supported values are 2 or 6.
TypeRequiredDefault
stringNo2
#### audio\_bitrate Output audio bitrate. Supported values are 32, 40, 64, 96, 128, 192, 256, 384, 448 or 768.
TypeRequiredDefault
stringNo256
#### primary\_audio\_downmix\_to\_stereo Downmix primary audio from 5.1 to stereo.
TypeRequiredDefault
booleanNo
#### source\_stream The index of the source stream. Supported values are 1 , 2 , 3 , 4 , 5 , 6 , 7 or 8.
TypeRequiredDefault
stringNo
#### dolby\_digital\_dialnorm The dialnorm. Values range from 0 to 31 inclusive. Use 0 for passthrough.
TypeRequiredDefault
numberNo
### Video Profiles #### output The location, including the file name, where the output is to be sent.
TypeRequiredDefault
stringNo
#### width The output width in pixels.
TypeRequiredDefault
numberYes
#### height The output height in pixels
TypeRequiredDefault
numberYes
#### video\_bitrate\_mode Output video bitrate mode. Supported values are cbr or vbr.
TypeRequiredDefault
stringNo
#### video\_bitrate The video bitrate in kbps.
TypeRequiredDefault
numberYes
#### video\_framerate The video framerate. Supported values are 1x, 1/2x or 2x.
TypeRequiredDefault
stringNo1x
#### audio\_profiles
TypeRequiredDefault
stringNo
### Supported Containers and Codecs - Input Containers: MXF, MPEG2-TS and MP4 - Output Containers: MPEG2-TS, MP4 - Input Codecs: MPEG2, ProRes, XDCAM, H.264, HEVC for video; AC3, MPEG2, AAC for audio - Output Codecs: MPEG2, H.264 and HEVC for video; Passthrough, AAC-LC and AAC 5.1 for audio, AC3 stereo and 5.1 for audio ### Creating Jobs ### Using the API from within Python ### Retrieving a Sent Job Job Status: {'job\_id': '4765', 'tcode\_progress': '100', 'state': 'ready', 'tcode\_time': '57.89', 'tcode\_speed': '0.0', 'job\_completed': True, 'xfer\_speed': '337.88', 'xfer\_time': '0.67', 'xfer\_progress': '100'} Job Config: {'input': 'https://streamengine.igolgi.com/uploads/659d9ac25dc7bf7b1a7c487a971a98e8', 'videoProfiles': \[{'output': 'oci://yzwhip2gci7s/igolgi-public/80d8cc2a\_bdab\_442b\_bc19\_21fe00267a34.mp4', 'width': 0, 'height': 0, 'video\_bitrate': 6000, 'video\_framerate': '1x'}\], 'audioProfiles': \[{'audio\_codec': 'aac', 'audio\_channels': 2, 'audio\_bitrate': 128, 'primary\_audio\_downmix\_to\_stereo': False, 'source\_stream': 1}\], 'output\_container': 'mp4', 'audio\_output\_path': 'oci://yzwhip2gci7s/igolgi-public/96dbafd7\_bf4f\_45a8\_bd06\_627a4684e45b.mp4', 'separate\_audio': True, 'segmented\_output\_hls': False, 'segmented\_output\_dash': False, 'video\_codec': 'hevc', 'ip\_distance': 3, 'gop\_length': 2, 'scte35\_passthough': False, 'scte35\_pid\_remap': -1, 'create\_tar\_file': False, 'audio\_volume': 100, 'h264\_quality': 'good', 'video\_aspect\_ratio': 'rotate\_counterclockwise + invert\_aspect\_ratio', 'rotation\_blackness': 0, 'closed\_captions': False, 'picture\_transform': 'none', 'logo\_url': None}