### Audio Configuration Example

Source: https://developers.idomoo.com/docs/v3/fbdd6cc5be2fa-generate-video-from-scenes

Configures audio elements for a scene, specifying properties like duration, visibility, start time, and fade effects. It allows for detailed control over audio playback within the video.

```json
{
  "key": "string",
  "val": "ual://my_media/blue_card.wav",
  "duration_in_seconds": 0,
  "is_hidden": true,
  "start_time": 0,
  "start_referrer": "string",
  "duration_upto_unique_scene_id": "string",
  "audio_duration_addition": 0,
  "mute": false,
  "fade_start": 0,
  "fade_end": 0,
  "volume": 0,
  "sidechain_compression_affect": false,
  "duration_referrer": false,
  "duration_addition": 0,
  "soundtrack_end": false,
  "soundtrack_end_addition": 0,
  "tags": [
    "string"
  ],
  "description": "string",
  "display_name": "string"
}
```

--------------------------------

### Scene Configuration Example

Source: https://developers.idomoo.com/docs/v3/fbdd6cc5be2fa-generate-video-from-scenes

Defines the visual properties of a scene, including background, interactive elements, and display settings. It specifies the bounding box, tracking, and timing for various elements within the scene.

```json
{
  "wrapping_truncate": false,
  "wrapping_truncate_string": "[more…]",
  "right_to_left": false,
  "background_rect": {
    "size_l": 0,
    "size_t": 0,
    "size_r": 0,
    "size_b": 0,
    "corner_lt": 0,
    "corner_rt": 0,
    "corner_lb": 0,
    "corner_rb": 0,
    "color": "rgba(255, 0, 0, 100)",
    "show_original": true
  },
  "interactive_placeholder": {
    "button_stats": "clicked_yes",
    "action": [
      {
        "action_type": "link",
        "data": "string",
        "seek_to_unique_scene_id": "string",
        "duration_addition": 0,
        "body": "string"
      }
    ]
  },
  "data_id": "string",
  "tags": [
    "string"
  ],
  "description": "string",
  "display_name": "string",
  "bounding_box": {
    "x": 0,
    "y": 0,
    "height": 0,
    "width": 0
  },
  "tracking": 0,
  "leading": 0,
  "is_trackmatte": true,
  "start_time": 0
}
```

--------------------------------

### Callback Request Configuration Example (JSON)

Source: https://developers.idomoo.com/docs/v3/66fdd7ae0591a-callback-request-patch

This JSON object demonstrates the structure for configuring a callback request. It includes fields for the callback name, URL, authorization details (OAuth2 example provided), and sharing identifiers. Ensure all required fields are populated according to the API specifications.

```json
{
  "name": "string",
  "callback": {
    "url": "string",
    "authorization": {
      "authorization_type": "oauth2",
      "access_token_url": "https://gateway.brand.com/token",
      "grant_type": "client_credentials",
      "client_id": "string",
      "client_secret": "********",
      "scope": "access token"
    }
  },
  "identifiers": {
    "authorized": [
      1111
    ],
    "open_to_all": false
  }
}
```

--------------------------------

### Set Media Start Time

Source: https://developers.idomoo.com/docs/v3/e8ef4f6198daa-media

Defines the start time in seconds for when a media asset within a placeholder should begin playing. If not specified, it defaults to the beginning of the scene.

```json
{
  "start_time": 0
}
```

--------------------------------

### Using Metadata API Endpoints to Setup a Callback Object

Source: https://developers.idomoo.com/docs/v3/1089f9158885a-use-callbacks-for-video-generation-notifications

Details on how to use the Metadata API endpoints to create, modify, list, and delete callback objects.

```APIDOC
## Using Metadata API Endpoints to Setup a Callback Object

### Description
There are several endpoints with which you can create callback objects, modify them, list them and delete them. You can find these endpoints starting with the POST endpoint here. When creating a callback object, you get an ID of that object back. This ID is what you use when using the generate video endpoints.

Note that when getting a callback object passwords are not shown.
```

--------------------------------

### Landing Pages List Example (JSON)

Source: https://developers.idomoo.com/docs/v3/4ae16621e417d-landing-pages-list

This JSON structure represents a list of landing pages. It includes metadata for each landing page such as its ID, name, title, thumbnail, and modification dates. The 'item_count' indicates the total number of landing pages returned.

```json
{
  "item_count": 0,
  "landing_pages": [
    {
      "landing_page_id": 0,
      "landing_page_name": "string",
      "main_title": "string",
      "thumbnail": "string",
      "last_modified": 1439798793,
      "last_modified_string": "2015-08-17 08:06:33",
      "identifiers": {
        "authorized": []
      }
    }
  ]
}
```

--------------------------------

### Interactive Request Example

Source: https://developers.idomoo.com/docs/v3/wwabvfpbh7yjs-interactive-request

This section details how to make placeholders interactive by adding an 'action' object. It outlines the available action types and their corresponding data fields, including specific requirements for 'seek' actions and how to invoke API calls with a request body.

```APIDOC
## POST /websites/developers_idomoo/interactive

### Description
This endpoint allows you to configure interactive placeholders within your Idomoo content. By adding an `action` object to a placeholder, you can make it clickable and define various actions it can perform.

### Method
POST

### Endpoint
`/websites/developers_idomoo/interactive`

### Parameters
#### Request Body
- **button_stats** (string) - Optional - Value sent to Idomoo's analytics when the placeholder is clicked.
- **action** (array[object]) - Required - An array of actions to be performed when the placeholder is interacted with.
  - **action_type** (string) - Required - The type of action to perform. Allowed values: `link`, `seek`, `pause`, `load_video`, `trigger_event`, `invoke_api`.
  - **data** (string) - Optional - Data associated with the action (e.g., URL for `link`, API endpoint for `invoke_api`, event name for `trigger_event`). Not required for `pause` and `seek`.
  - **seek_to_unique_scene_id** (string) - Optional - Seek to the start time of this specific scene. If not provided, seeks to the video start.
  - **duration_addition** (number) - Optional - Additional time in seconds to add to the seek time. If `seek_to_unique_scene_id` is not used, this represents absolute time from the video start.
  - **body** (string) - Optional - Payload for `invoke_api` actions, turning the call into a POST request.

### Request Example
```json
{
  "button_stats": "clicked_yes",
  "action": [
    {
      "action_type": "link",
      "data": "https://example.com",
      "seek_to_unique_scene_id": "scene_123",
      "duration_addition": 5,
      "body": "some_payload"
    }
  ]
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.
- **message** (string) - A confirmation message.

#### Response Example
```json
{
  "status": "success",
  "message": "Interactive placeholder configured successfully."
}
```
```

--------------------------------

### Send Video Generation Request - Idomoo API

Source: https://developers.idomoo.com/docs/v3/fbdd6cc5be2fa-generate-video-from-scenes

Example of a complete POST request body to initiate video generation. Includes basic output settings, media configuration, security, and timeline details.

```json
{
  "statistic_id": "0000",
  "output_file_name": "videoForJimmy",
  "output_config_id": 0,
  "output": {
    "video": [
      {
        "format": "mp4",
        "quality": 26,
        "height": 720,
        "landing_page_id": 0,
        "crop_to_ratio": [
          4,
          5
        ],
        "overlays": [
          {
            "path": "pal://Idomoo_Play_v2.png",
            "alignment": {
              "horizontal": "right",
              "vertical": "bottom",
              "scale_type": "none"
            }
          }
        ],
        "suffix": "string",
        "label": "string"
      }
    ],
    "gif": [
      {
        "height": 100,
        "time": 0,
        "duration": 0,
        "fps": 1,
        "loop": 0,
        "landing_page_id": 0,
        "color_depth": 256,
        "crop_to_ratio": [
          4,
          5
        ],
        "overlays": [
          {
            "path": "pal://Idomoo_Play_v2.png",
            "alignment": {
              "horizontal": "right",
              "vertical": "bottom",
              "scale_type": "none"
            }
          }
        ],
        "suffix": "string",
        "label": "string"
      }
    ],
    "jpg": [
      {
        "height": 100,
        "time": 0,
        "crop_to_ratio": [
          4,
          5
        ],
        "overlays": [
          {
            "path": "pal://Idomoo_Play_v2.png",
            "alignment": {
              "horizontal": "right",
              "vertical": "bottom",
              "scale_type": "none"
            }
          }
        ],
        "suffix": "string",
        "label": "string"
      }
    ],
    "audio": [
      {
        "format": "wav",
        "sample_rate": 44100,
        "bit_depth": 16,
        "bitrate": 320,
        "channels": "mono"
      }
    ],
    "accessibility": {
      "caption_languages": [
        "EN",
        "ES"
      ],
      "transcript_languages": [
        "EN",
        "FR"
      ]
    }
  },
  "media_access_security": {
    "password": "pa$$word",
    "prompt": "Enter password",
    "wrong_password_message": "string",
    "number_of_attempts": 3,
    "lock_duration": 10,
    "lock_message": "Too many attempts.",
    "attempts_period": 10
  },
  "storage_id": 0,
  "callback_id": 0,
  "analytics_tags": [
    "tag_group.tag_name"
  ],
  "timeline": {
    "scene_order": "linear",
    "soundtrack": {
      "val": "ual://my_media/blue_card.wav",
      "duration_upto_unique_scene_id": "string",
      "audio_duration_addition": 0,
      "fade_start": 0,
      "fade_end": 2,
      "volume": 0,
      "sidechain_compression_amount": 0
    },
    "scenes": [
      {
        "scene_id": 0,
        "unique_scene_id": "string",
        "z_index": 0,
        "duration_in_seconds": 0,
        "duration_upto_unique_scene_id": "string",
        "duration_addition": 0,
        "start_time_offset_unique_scene_id": "string",
        "start_time_offset_seconds": 0,
        "start_time_in_seconds": 0,
        "scene_start_in_seconds": 0,
        "media": [
          {
            "key": "string",
            "val": "ual://my_media/blue_card.png",
            "duration_in_seconds": 0,
            "width": 0,
            "height": 0,
            "is_hidden": false,
            "alignment_scale_type": "fit",
            "alignment_scale": 1,
            "alignment_x_align": 0.5,
            "alignment_y_align": 0.5,
            "if_longer": "cut",
            "mute": false,
            "fade_start": 0,
            "fade_end": 0,
            "volume": 0,
            "sidechain_compression_affect": false,
            "duration_referrer": false,
            "duration_addition": 0,
            "interactive_placeholder": {
              "button_stats": "clicked_yes",
              "action": [
                {
                  "action_type": "link",
                  "data": "string",
                  "seek_to_unique_scene_id": "string",
                  "duration_addition": 0,
                  "body": "string"
                }
              ]
            },
            "data_id": "string",
            "tags": [
              "string"
            ],
            "description": "string",
            "display_name": "string",
            "bounding_box": {
              "x": 0,
              "y": 0,
              "height": 0,
              "width": 0
            },
            "is_trackmatte": true,
            "start_time": 0
          }
        ],
        "text": [
          {
            "key": "string",
            "val": [
              {
                "text": "string",
                "color": "rgb(255, 127, 0)",
                "font_path": "string",
                "scale": 0,
                "baseline": 0.5,
                "highlight": "rgb(255, 127, 0)",
                "strikethrough": true,
                "underline": true,
                "tracking": 0,
                "leading": 0,
                "fallback_fonts": [
                  "string"
                ]
              }
            ],
            "duration_in_seconds": 0,
            "is_hidden": false,
            "asset_path": "string",
            "font_size": 0,
            "text_color": "rgb(255, 127, 0)",
            "alignment_horizontal": "right",
            "alignment_vertical": "bottom",
            "wrapping_shrink": true,
            "wrapping_breakline": true,
            "wrapping_minimum": 0,
            "wrapping_truncate": false,
            "wrapping_truncate_string": "[more…]",
            "right_to_left": false,
            "background_rect": {
              "size_l": 0,
              "size_t": 0,
              "size_r": 0,
              "size_b": 0,
              "corner_lt": 0,
              "corner_rt": 0,
              "corner_lb": 0,
              "corner_rb": 0,
              "color": "rgba(255, 0, 0, 100)",
              "show_original": true
            },
            "interactive_placeholder": {
              "button_stats": "clicked_yes",
              "action": [
                {
                  "action_type": "link",
                  "data": "string",
                  "seek_to_unique_scene_id": "string",
                  "duration_addition": 0,
                  "body": "string"
                }
              ]
            },
            "data_id": "string",
            "tags": [
              "string"
            ],
            "description": "string",
            "display_name": "string",
            "bounding_box": {
              "x": 0,
              "y": 0,
              "height": 0,
              "width": 0
            },
            "tracking": 0,
            "leading": 0
          }
        ]
      }
    ]
  }
}
```

--------------------------------

### Configure Output Request Example (JSON)

Source: https://developers.idomoo.com/docs/v3/32e47876e518f-output-config-request

This JSON object demonstrates the structure for an output configuration request. It specifies the name, sharing controls (authorized accounts and open access), and various output formats including video, GIF, JPG, audio, and accessibility features like caption and transcript languages.

```json
{
  "name": "string",
  "identifiers": {
    "authorized": [
      1111
    ],
    "open_to_all": false
  },
  "output": {
    "video": [
      {
        "crop_to_ratio": [],
        "overlays": []
      }
    ],
    "gif": [
      {
        "crop_to_ratio": [],
        "overlays": []
      }
    ],
    "jpg": [
      {
        "crop_to_ratio": [],
        "overlays": []
      }
    ],
    "audio": [
      {}
    ],
    "accessibility": {
      "caption_languages": [
        "EN",
        "ES"
      ],
      "transcript_languages": [
        "EN",
        "FR"
      ]
    }
  }
}
```

--------------------------------

### Website Project Configuration

Source: https://developers.idomoo.com/docs/v3/fbdd6cc5be2fa-generate-video-from-scenes

This section describes the configuration options available for a website project, including media formats, accessibility features, and media access security settings.

```APIDOC
## Website Project Configuration

### Description
Allows configuration of media generation settings (GIF, JPG, audio), accessibility options (caption and transcript languages), and media access security parameters.

### Method
POST

### Endpoint
/websites/developers_idomoo

### Parameters
#### Request Body
- **gif** (array of objects) - Configuration for GIF generation.
  - **height** (integer) - Height of the GIF.
  - **time** (integer) - Start time for GIF generation.
  - **duration** (integer) - Duration of the GIF.
  - **fps** (integer) - Frames per second for the GIF.
  - **loop** (integer) - Number of loops for the GIF.
  - **landing_page_id** (integer) - ID of the landing page.
  - **color_depth** (integer) - Color depth of the GIF.
  - **crop_to_ratio** (array of two integers) - Aspect ratio for cropping.
  - **overlays** (array of objects) - Overlays to apply to the GIF.
    - **path** (string) - Path to the overlay asset.
    - **alignment** (object) - Alignment settings for the overlay.
      - **horizontal** (string) - Horizontal alignment ('right', 'left', 'center').
      - **vertical** (string) - Vertical alignment ('bottom', 'top', 'middle').
      - **scale_type** (string) - Scaling type ('none', 'fit', 'fill').
  - **suffix** (string) - Suffix for the GIF filename.
  - **label** (string) - Label for the GIF.
- **jpg** (array of objects) - Configuration for JPG generation (similar fields to GIF).
- **audio** (array of objects) - Configuration for audio generation.
  - **format** (string) - Audio format (e.g., 'wav').
  - **sample_rate** (integer) - Sample rate in Hz.
  - **bit_depth** (integer) - Bit depth of the audio.
  - **bitrate** (integer) - Bitrate in kbps.
  - **channels** (string) - Number of audio channels ('mono', 'stereo').
- **accessibility** (object) - Accessibility settings.
  - **caption_languages** (array of strings) - List of supported caption languages.
  - **transcript_languages** (array of strings) - List of supported transcript languages.
- **media_access_security** (object) - Security settings for media access.
  - **password** (string) - Password for media access.
  - **prompt** (string) - Prompt message for password entry.
  - **wrong_password_message** (string) - Message displayed for incorrect password.
  - **number_of_attempts** (integer) - Maximum number of login attempts.
  - **lock_duration** (integer) - Duration in seconds for account lockout.
  - **lock_message** (string) - Message displayed during account lockout.
  - **attempts_period** (integer) - Time period in seconds to count attempts.
- **storage_id** (integer) - Storage identifier.
- **callback_id** (integer) - Callback identifier.
- **analytics_tags** (array of strings) - Tags for analytics.
- **timeline** (object) - Timeline configuration for media sequencing.
  - **scene_order** (string) - Order of scenes ('linear', 'sequential').
  - **soundtrack** (object) - Soundtrack configuration.
    - **val** (string) - URL or path to the soundtrack.
    - **duration_upto_unique_scene_id** (string) - Duration relative to a scene.
    - **audio_duration_addition** (integer) - Additional audio duration.
    - **fade_start** (integer) - Start fade duration.
    - **fade_end** (integer) - End fade duration.
    - **volume** (integer) - Soundtrack volume.
    - **sidechain_compression_amount** (integer) - Sidechain compression amount.
  - **scenes** (array of objects) - Array of scene configurations.
    - **scene_id** (integer) - Unique ID for the scene.
    - **unique_scene_id** (string) - Unique identifier for the scene.
    - **z_index** (integer) - Z-index for layering.
    - **duration_in_seconds** (integer) - Duration of the scene in seconds.
    - **duration_upto_unique_scene_id** (string) - Duration relative to a scene.
    - **duration_addition** (integer) - Additional duration for the scene.
    - **start_time_offset_unique_scene_id** (string) - Start time offset relative to a scene.
    - **start_time_offset_seconds** (integer) - Start time offset in seconds.
    - **start_time_in_seconds** (integer) - Start time in seconds.
    - **scene_start_in_seconds** (integer) - Scene start time in seconds.
    - **media** (array of objects) - Media elements within the scene.
      - **key** (string) - Key for the media element.
      - **val** (string) - URL or path to the media asset.
      - **duration_in_seconds** (integer) - Duration of the media in seconds.
      - **width** (integer) - Width of the media.
      - **height** (integer) - Height of the media.
      - **is_hidden** (boolean) - Whether the media is hidden.
      - **alignment_scale_type** (string) - Scaling type for alignment ('fit', 'fill').
      - **alignment_scale** (float) - Scale factor for alignment.
      - **alignment_x_align** (float) - Horizontal alignment position.
      - **alignment_y_align** (float) - Vertical alignment position.
      - **if_longer** (string) - Behavior when media is longer than scene duration ('cut', 'loop').
      - **mute** (boolean) - Whether to mute the media.
      - **fade_start** (integer) - Fade-in duration.
      - **fade_end** (integer) - Fade-out duration.
      - **volume** (integer) - Media volume.
      - **sidechain_compression_affect** (boolean) - Whether sidechain compression affects this media.
      - **duration_referrer** (boolean) - Indicates if duration is referenced.
      - **duration_addition** (integer) - Additional duration for the media.
      - **interactive_placeholder** (object) - Interactive element configuration.
        - **button_stats** (string) - Statistics for button clicks.
        - **action** (array of objects) - Actions to perform.
          - **action_type** (string) - Type of action ('link', 'seek_to_scene').
          - **data** (string) - Data associated with the action.
          - **seek_to_unique_scene_id** (string) - Scene to seek to.
          - **duration_addition** (integer) - Additional duration for the action.
          - **body** (string) - Request body for the action.
      - **data_id** (string) - Data identifier.
      - **tags** (array of strings) - Tags for the media.
      - **description** (string) - Description of the media.
      - **display_name** (string) - Display name of the media.
      - **bounding_box** (object) - Bounding box coordinates.
        - **x** (integer) - X-coordinate.
        - **y** (integer) - Y-coordinate.
        - **height** (integer) - Height.
        - **width** (integer) - Width.
      - **is_trackmatte** (boolean) - Whether it's a track matte.
      - **start_time** (integer) - Start time of the media.
    - **text** (array of objects) - Text elements within the scene.
      - **key** (string) - Key for the text element.
      - **val** (array of objects) - Array of text content objects.
        - **text** (string) - The text content.
        - **color** (string) - Text color (e.g., 'rgb(255, 0, 0)').
        - **font_path** (string) - Path to the font file.
        - **scale** (float) - Text scale.
        - **baseline** (float) - Text baseline.
        - **highlight** (string) - Highlight color.
        - **strikethrough** (boolean) - Whether to apply strikethrough.
        - **underline** (boolean) - Whether to apply underline.
        - **tracking** (float) - Character spacing.
        - **leading** (float) - Line spacing.
        - **fallback_fonts** (array of strings) - Fallback font paths.
      - **duration_in_seconds** (integer) - Duration of the text in seconds.
      - **is_hidden** (boolean) - Whether the text is hidden.
      - **asset_path** (string) - Path to the text asset.
      - **font_size** (integer) - Font size.
      - **text_color** (string) - Default text color.
      - **alignment_horizontal** (string) - Horizontal alignment ('right', 'left', 'center').
      - **alignment_vertical** (string) - Vertical alignment ('bottom', 'top', 'middle').
      - **wrapping_shrink** (boolean) - Whether to shrink text to fit.
      - **wrapping_breakline** (boolean) - Whether to break lines.
      - **wrapping_minimum** (integer) - Minimum width for wrapping.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Project configuration updated successfully."
}
```
```

--------------------------------

### Generate Video with Overlays

Source: https://developers.idomoo.com/docs/v3/cd57d89b6bbd9-generate-video-from-storyboard

This configuration specifies parameters for generating a video output. It includes format, quality, dimensions, aspect ratio cropping, and overlay settings. The overlay configuration details the image path and its alignment within the video frame.

```json
{
  "storyboard_id": 0,
  "statistic_id": "0000",
  "output_file_name": "string",
  "output_config_id": 0,
  "output": {
    "video": [
      {
        "format": "mp4",
        "quality": 26,
        "height": 720,
        "landing_page_id": 0,
        "crop_to_ratio": [
          4,
          5
        ],
        "overlays": [
          {
            "path": "pal://Idomoo_Play_v2.png",
            "alignment": {
              "horizontal": "right",
              "vertical": "bottom",
              "scale_type": "none"
            }
          }
        ],
        "suffix": "string",
        "label": "string"
      }
    ]
  },
  "media_access_security": {
    "password": "pa$$word",
    "prompt": "Enter password",
    "wrong_password_message": "string",
    "number_of_attempts": 3,
    "lock_duration": 10,
    "lock_message": "Too many attempts.",
    "attempts_period": 10
  },
  "storage_id": 0,
  "callback_id": 0,
  "analytics_tags": [
    "tag_group.tag_name"
  ],
  "data": [
    {
      "key": "name",
      "val": "Christopher"
    }
  ],
  "data_tree": {}
}
```

--------------------------------

### Status Embed

Source: https://developers.idomoo.com/docs/v3/203d2367e2213-interactive-action

Information on how to correctly install and display status embeds, which show incidents or maintenance updates from your status page.

```APIDOC
## Status Embed Installation

### Description
This section provides guidance on embedding status updates onto your website. When an incident or maintenance is posted on your status page, it will be displayed on your site via this embed.

### Usage
Ensure the status embed is installed correctly to show the latest updates from your status page.
```

--------------------------------

### Generate JPG with Overlays

Source: https://developers.idomoo.com/docs/v3/cd57d89b6bbd9-generate-video-from-storyboard

This configuration outlines parameters for generating a JPG image output. It includes height, time, aspect ratio cropping, and overlay settings. The overlay configuration specifies the image path and its alignment within the JPG.

```json
{
  "storyboard_id": 0,
  "statistic_id": "0000",
  "output_file_name": "string",
  "output_config_id": 0,
  "output": {
    "jpg": [
      {
        "height": 100,
        "time": 0,
        "crop_to_ratio": [
          4,
          5
        ],
        "overlays": [
          {
            "path": "pal://Idomoo_Play_v2.png",
            "alignment": {
              "horizontal": "right",
              "vertical": "bottom",
              "scale_type": "none"
            }
          }
        ],
        "suffix": "string",
        "label": "string"
      }
    ]
  },
  "media_access_security": {
    "password": "pa$$word",
    "prompt": "Enter password",
    "wrong_password_message": "string",
    "number_of_attempts": 3,
    "lock_duration": 10,
    "lock_message": "Too many attempts.",
    "attempts_period": 10
  },
  "storage_id": 0,
  "callback_id": 0,
  "analytics_tags": [
    "tag_group.tag_name"
  ],
  "data": [
    {
      "key": "name",
      "val": "Christopher"
    }
  ],
  "data_tree": {}
}
```

--------------------------------

### Output Config List API

Source: https://developers.idomoo.com/docs/v3/aa8d23fd10339-scene-metadata

Retrieve a list of all output configurations.

```APIDOC
## GET /output-configs

### Description
Retrieves a list of all output configurations saved within the account.

### Method
GET

### Endpoint
/output-configs

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **outputConfigs** (array) - A list of output configuration objects.
  - **outputConfigId** (string) - The unique identifier for the output configuration.
  - **name** (string) - The name of the output configuration.
  - **createdAt** (string) - The timestamp when the output configuration was created.

#### Response Example
```json
{
  "outputConfigs": [
    {
      "outputConfigId": "oc_uvwxy",
      "name": "HD Video Config",
      "createdAt": "2023-10-27T10:25:00Z"
    }
  ]
}
```
```

--------------------------------

### Idomoo API 3.0 - Output Config List

Source: https://developers.idomoo.com/docs/v3/b5148ed6462dd-storyboards-list

Retrieves a list of all output configurations.

```APIDOC
## Output Config List API

### Description
Returns a list of all available output configurations.

### Method
GET

### Endpoint
/output-config-list

### Parameters
None

### Request Example
(No request body for GET request)

### Response
#### Success Response (200)
- **output_configs** (array) - A list of output configuration objects.
  - **id** (string) - Unique identifier for the output configuration.
  - **name** (string) - Name of the output configuration.

#### Response Example
```json
{
  "output_configs": [
    {
      "id": "ocfg_777",
      "name": "Default Video Config"
    },
    {
      "id": "ocfg_888",
      "name": "GIF Export"
    }
  ]
}
```
```

--------------------------------

### Basic Authorization Example

Source: https://developers.idomoo.com/docs/v3/1a01b75826c59-basic-authorization

This snippet demonstrates the structure for basic authorization, which requires an authorization type, username, and password. The 'basic' type is currently the only supported option. The password field is always hidden in responses.

```json
{
  "authorization_type": "basic",
  "username": "string",
  "password": "********"
}
```

--------------------------------

### Generate GIF with Overlays

Source: https://developers.idomoo.com/docs/v3/cd57d89b6bbd9-generate-video-from-storyboard

This configuration defines parameters for generating a GIF output. It includes dimensions, duration, frame rate, looping, aspect ratio cropping, and overlay settings. The overlay configuration specifies the image path and its alignment within the GIF.

```json
{
  "storyboard_id": 0,
  "statistic_id": "0000",
  "output_file_name": "string",
  "output_config_id": 0,
  "output": {
    "gif": [
      {
        "height": 100,
        "time": 0,
        "duration": 0,
        "fps": 1,
        "loop": 0,
        "landing_page_id": 0,
        "color_depth": 256,
        "crop_to_ratio": [
          4,
          5
        ],
        "overlays": [
          {
            "path": "pal://Idomoo_Play_v2.png",
            "alignment": {
              "horizontal": "right",
              "vertical": "bottom",
              "scale_type": "none"
            }
          }
        ],
        "suffix": "string",
        "label": "string"
      }
    ]
  },
  "media_access_security": {
    "password": "pa$$word",
    "prompt": "Enter password",
    "wrong_password_message": "string",
    "number_of_attempts": 3,
    "lock_duration": 10,
    "lock_message": "Too many attempts.",
    "attempts_period": 10
  },
  "storage_id": 0,
  "callback_id": 0,
  "analytics_tags": [
    "tag_group.tag_name"
  ],
  "data": [
    {
      "key": "name",
      "val": "Christopher"
    }
  ],
  "data_tree": {}
}
```

--------------------------------

### Configure Audio Asset Settings

Source: https://developers.idomoo.com/docs/v3/fbdd6cc5be2fa-generate-video-from-scenes

Sets parameters for audio assets, including format, sample rate, bit depth, bitrate, and channels. This configuration is essential for managing audio playback within the project.

```json
{
  "format": "wav",
  "sample_rate": 44100,
  "bit_depth": 16,
  "bitrate": 320,
  "channels": "mono"
}
```

--------------------------------

### Configure Identifier Sharing - JSON Example

Source: https://developers.idomoo.com/docs/v3/4724d52e8bdc3-identifiers

This JSON object configures sharing controls for an object, specifying authorized Idomoo account IDs and whether the object is open to all accounts. It's used to manage access permissions for specific resources within the Idomoo platform.

```json
{
  "authorized": [
    1111
  ],
  "open_to_all": false
}
```

--------------------------------

### Scene API Request Example (JSON)

Source: https://developers.idomoo.com/docs/v3/b7ba98cad52f7-scene-api-request

This JSON object represents a typical request to the Idomoo Scene API. It includes configurations for various output formats (video, GIF, JPG, audio, accessibility), media access security settings, analytics tags, and timeline parameters.

```json
{
  "statistic_id": "0000",
  "output_file_name": "videoForJimmy",
  "output_config_id": 0,
  "output": {
    "video": [
      {
        "crop_to_ratio": [],
        "overlays": []
      }
    ],
    "gif": [
      {
        "crop_to_ratio": [],
        "overlays": []
      }
    ],
    "jpg": [
      {
        "crop_to_ratio": [],
        "overlays": []
      }
    ],
    "audio": [
      {}
    ],
    "accessibility": {
      "caption_languages": [
        "EN",
        "ES"
      ],
      "transcript_languages": [
        "EN",
        "FR"
      ]
    }
  },
  "media_access_security": {
    "password": "pa$$word",
    "prompt": "Enter password",
    "wrong_password_message": "string",
    "number_of_attempts": 3,
    "lock_duration": 10,
    "lock_message": "Too many attempts.",
    "attempts_period": 10
  },
  "storage_id": 0,
  "callback_id": 0,
  "analytics_tags": [
    "tag_group.tag_name"
  ],
  "timeline": {
    "scene_order": "linear",
    "soundtrack": {
      "val": "ual://my_media/blue_card.wav",
      "duration_upto_unique_scene_id": "string",
      "audio_duration_addition": 0,
      "fade_start": 0,
      "fade_end": 2,
      "volume": 0,
      "sidechain_compression_amount": 0
    }
  }
}
```

--------------------------------

### Callback Response JSON Structure Example

Source: https://developers.idomoo.com/docs/v3/245cbcfb08e7e-callback-response

This JSON object represents the structure of a callback response, detailing notification information such as name, ID, callback URL, authorization details, and sharing controls for the object. It includes both epoch time and human-readable date formats for modification and creation.

```json
{
  "name": "string",
  "callback_id": 0,
  "callback": {
    "url": "string",
    "authorization": {
      "authorization_type": "oauth2",
      "access_token_url": "https://gateway.brand.com/token",
      "grant_type": "client_credentials",
      "client_id": "string",
      "client_secret": "********",
      "scope": "access token"
    }
  },
  "identifiers": {
    "authorized": [
      1111
    ],
    "open_to_all": false
  },
  "account_id": 0,
  "last_modified": 1439798793,
  "last_modified_string": "2015-08-17 08:06:33",
  "creation_date": 1439798793,
  "creation_date_string": "2015-08-17 08:06:33"
}
```

--------------------------------

### Storyboard API Request Example (JSON)

Source: https://developers.idomoo.com/docs/v3/cfdcf53056a21-storyboard-api-request

This JSON object demonstrates a typical request payload for the Idomoo Storyboard API. It includes essential parameters for defining the storyboard to render, output formats, security settings, and data inputs. Ensure all fields adhere to the specified data types and constraints.

```json
{
  "storyboard_id": 0,
  "statistic_id": "0000",
  "output_file_name": "string",
  "output_config_id": 0,
  "output": {
    "video": [
      {
        "crop_to_ratio": [],
        "overlays": []
      }
    ],
    "gif": [
      {
        "crop_to_ratio": [],
        "overlays": []
      }
    ],
    "jpg": [
      {
        "crop_to_ratio": [],
        "overlays": []
      }
    ],
    "audio": [
      {}
    ],
    "accessibility": {
      "caption_languages": [
        "EN",
        "ES"
      ],
      "transcript_languages": [
        "EN",
        "FR"
      ]
    }
  },
  "media_access_security": {
    "password": "pa$$word",
    "prompt": "Enter password",
    "wrong_password_message": "string",
    "number_of_attempts": 3,
    "lock_duration": 10,
    "lock_message": "Too many attempts.",
    "attempts_period": 10
  }
}
```

--------------------------------

### Configure Audio Output Settings

Source: https://developers.idomoo.com/docs/v3/fbdd6cc5be2fa-generate-video-from-scenes

Sets the audio output format and characteristics, including format, sample rate, bit depth, bitrate, and channels. This configuration ensures the desired audio quality for the final output.

```json
{
  "statistic_id": "0000",
  "output_file_name": "videoForJimmy",
  "output_config_id": 0,
  "output": {
    "audio": [
      {
        "format": "wav",
        "sample_rate": 44100,
        "bit_depth": 16,
        "bitrate": 320,
        "channels": "mono"
      }
    ]
  }
}
```

--------------------------------

### GIF Output Response Structure (JSON)

Source: https://developers.idomoo.com/docs/v3/e701a630e9378-gif-output-response

This JSON object represents the response structure for a GIF output. It includes parameters for controlling GIF generation such as frame rate, height, start time, duration, suffix, cost, and links to the generated GIF and its landing page. The 'links' object contains the 'url' and 'landing_page_url'.

```json
{
  "fps": 30,
  "height": 0,
  "time": 0,
  "duration": 0,
  "suffix": "string",
  "cost": 0,
  "links": {
    "url": "string",
    "landing_page_url": "string"
  },
  "label": "string"
}
```

--------------------------------

### Idomoo API v3 Overview

Source: https://developers.idomoo.com/docs/v3/ecf9a271b2c4e-api-errors

General overview of the Idomoo API v3, including authentication and interface details.

```APIDOC
## Idomoo API v3 Overview

### Description
This API provides access to various Idomoo services, including account management, video generation, media handling, and reporting.

### Authentication
Refer to the 'Authentication' section for details on how to authenticate your API requests.

### API Interface
The 'API Interface' section describes the structure and available endpoints.

### API Errors
Consult the 'API Errors' section for a list of possible error codes and their meanings.

### Guides
Available guides include:
- Use Callbacks For Video Generation Notifications
- Using Output Config to Reuse Output Settings
```

--------------------------------

### Report Metadata JSON Structure

Source: https://developers.idomoo.com/docs/v3/06ec7d10cb431-report-metadata

This JSON object represents the metadata for a specific report. It includes details such as the report's name, ID, filtering criteria (storyboard, tags, statistics ID), start and stop dates for scheduled reports, and an array of links to the report data. Each link object contains the type, a presigned URL, and expiration information.

```json
{
  "name": "My Report",
  "report_id": "string",
  "report_filters": {
    "storyboard": "All",
    "tags": "Silver, Gold, Platinum",
    "statistics_id": "All"
  },
  "starts_on": "2015-08-17 08:06:33",
  "stops_on": "2015-08-17 08:06:33",
  "links": [
    {
      "type": "views",
      "url": "string",
      "expired": 1439798793,
      "expired_string": "2015-08-17 08:06:33"
    }
  ],
  "last_modified": 1439798793,
  "last_modified_string": "2015-08-17 08:06:33",
  "creation_date": 1439798793,
  "creation_date_string": "2015-08-17 08:06:33",
  "account_id": 1111
}
```

--------------------------------

### Idomoo API v3 - Overview

Source: https://developers.idomoo.com/docs/v3/feb7dd3010f7f-reports-list

General overview of the Idomoo API v3, including authentication methods and error handling.

```APIDOC
## Idomoo API v3

### Description
Provides access to Idomoo's services for video generation, media management, and reporting.

### Authentication
Supports OAuth2 and Basic Authorization.

### API Errors
Details on common API error codes and messages.

### Guides
Includes guides on using callbacks for notifications and output configurations.
```

--------------------------------

### Video Output Response Structure (JSON Example)

Source: https://developers.idomoo.com/docs/v3/518e5e271a0cd-video-output-response

This JSON object represents the structure of a video output response. It includes details such as the output format (HLS or MP4), quality settings, height, optional suffix, duration, cost in credits, and various links including the direct URL, landing page URL, expiration date, and a human-readable expiration string. The height is specified in pixels, with the width automatically calculated to maintain the aspect ratio.

```json
{
  "format": "mp4",
  "quality": 26,
  "height": 0,
  "suffix": "string",
  "duration": 0,
  "cost": 0,
  "links": {
    "url": "string",
    "landing_page_url": "string"
  },
  "label": "string",
  "expired": 1547114586,
  "expired_string": "2019-01-10 10:03:06 GMT"
}
```

--------------------------------

### Configure Media Placeholder Properties

Source: https://developers.idomoo.com/docs/v3/e8ef4f6198daa-media

Defines the properties for a media placeholder, including its key, the path to the media asset, and various display and playback options. Supports images, videos, and colors. The 'val' parameter accepts external file paths or Idomoo server paths for media, and a specific RGB format for colors.

```json
{
  "key": "string",
  "val": "ual://my_media/blue_card.png",
  "duration_in_seconds": 0,
  "width": 0,
  "height": 0,
  "is_hidden": false,
  "alignment_scale_type": "fit",
  "alignment_scale": 1,
  "alignment_x_align": 0.5,
  "alignment_y_align": 0.5,
  "if_longer": "cut",
  "mute": false,
  "fade_start": 0,
  "fade_end": 0,
  "volume": 0,
  "sidechain_compression_affect": false,
  "duration_referrer": false,
  "duration_addition": 0
}
```

--------------------------------

### Configure Audio Output

Source: https://developers.idomoo.com/docs/v3/cd57d89b6bbd9-generate-video-from-storyboard

This configuration specifies parameters for generating an audio output. It includes format, sample rate, bit depth, bitrate, and channel configuration.

```json
{
  "storyboard_id": 0,
  "statistic_id": "0000",
  "output_file_name": "string",
  "output_config_id": 0,
  "output": {
    "audio": [
      {
        "format": "wav",
        "sample_rate": 44100,
        "bit_depth": 16,
        "bitrate": 320,
        "channels": "mono"
      }
    ]
  },
  "media_access_security": {
    "password": "pa$$word",
    "prompt": "Enter password",
    "wrong_password_message": "string",
    "number_of_attempts": 3,
    "lock_duration": 10,
    "lock_message": "Too many attempts.",
    "attempts_period": 10
  },
  "storage_id": 0,
  "callback_id": 0,
  "analytics_tags": [
    "tag_group.tag_name"
  ],
  "data": [
    {
      "key": "name",
      "val": "Christopher"
    }
  ],
  "data_tree": {}
}
```