pro7.9.openapi-spec.json

{
  "openapi": "3.0.2",
  "info": {
    "title": "ProPresenter API",
    "version": "1.0",
    "description": "Public API for controlling and retrieving information from ProPresenter."
  },
  "servers": [
    {
      "url": "../../"
    }
  ],
  "paths": {
    "/v1/audio/playlists": {
      "get": {
        "operationId": "audioPlaylistsGet",
        "tags": [
          "Audio"
        ],
        "summary": "Requests a list with all the configured audio playlists.",
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "id"
                    ],
                    "properties": {
                      "id": {
                        "$ref": "#/paths/~1v1~1playlist~1current/get/responses/200/content/application~1json/schema"
                      },
                      "type": {
                        "type": "string",
                        "enum": [
                          "group",
                          "playlist"
                        ],
                        "description": "Whether this is a playlist folder or an actual playlist."
                      },
                      "children": {
                        "type": "array",
                        "items": {
                          "$ref": "#/paths/~1v1~1audio~1playlists/get/responses/200/content/application~1json/schema/items"
                        },
                        "description": "The list of child playlists inside this playlist."
                      }
                    }
                  }
                },
                "example": {
                  "id": {
                    "uuid": "ED59503B-394D-4D5D-B0B0-5AE80D0BA025",
                    "name": "Playlist Folder",
                    "index": 0
                  },
                  "type": "group",
                  "children": [
                    {
                      "id": {
                        "uuid": "C49A250A-3E32-4C26-A220-46D6596426B5",
                        "name": "Playlist 1",
                        "index": 0
                      },
                      "type": "playlist",
                      "children": []
                    },
                    {
                      "id": {
                        "uuid": "D8C5D151-45C9-4CFF-B1F9-74F3B4B5173B",
                        "name": "Playlist 2",
                        "index": 1
                      },
                      "type": "playlist",
                      "children": []
                    }
                  ]
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/audio/playlist/{playlist_id}": {
      "get": {
        "operationId": "audioPlaylistGet",
        "tags": [
          "Audio"
        ],
        "summary": "Requests a list of all the audio items in the specified audio playlist.",
        "description": "A maximum of 100 items will be returned per call. The `start` query parameter can\nbe used to retrieve multiple pages of items, by setting it to the index of the first\nitem to return.\n",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1playlist~1%7Bplaylist_id%7D/parameters/0"
          },
          {
            "in": "query",
            "required": false,
            "name": "start",
            "description": "The starting index in the list. If the index is out of range, the returned items array will be empty.\n",
            "schema": {
              "type": "integer"
            },
            "example": 100,
            "default": 0
          }
        ],
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "id",
                      "items"
                    ],
                    "properties": {
                      "id": {
                        "$ref": "#/paths/~1v1~1playlist~1current/get/responses/200/content/application~1json/schema"
                      },
                      "items": {
                        "type": "array",
                        "$ref": "#/paths/~1v1~1media~1playlist~1%7Bplaylist_id%7D/get/responses/200/content/application~1json/schema/items"
                      }
                    }
                  }
                },
                "example": {
                  "id": {
                    "uuid": "B238C071-3628-4204-BB19-DDE76DC57CE7",
                    "name": "Playlist 3",
                    "index": 2
                  },
                  "items": [
                    {
                      "id": {
                        "uuid": "94A2D4EA-EEA5-48A4-AF6F-850D700C1830",
                        "name": "Song 1",
                        "index": 0
                      },
                      "type": "audio",
                      "artist": "unknown",
                      "duration": 123
                    },
                    {
                      "id": {
                        "uuid": "8F40D44E-4018-4552-8803-60DC788DB1CF",
                        "name": "Amazing Grace",
                        "index": 1
                      },
                      "type": "audio",
                      "artist": "John Newton",
                      "duration": 110
                    }
                  ]
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/audio/playlist/{playlist_id}/updates": {
      "get": {
        "operationId": "audioPlaylistUpdateGet",
        "tags": [
          "Audio"
        ],
        "summary": "Requests a chunked data update every time the specified audio playlist changes.",
        "description": "This endpoint can be used to subscribe to changes to a particular playlist.\nThe response is chunked, where each chunk is a simple string \"change\".\nThis string will be sent whenever the audio playlist changes in regards to any of the\ndata returned by `GET /audio/playlist/{playlist_id}`. The updated playlist data can be\nqueried by recalling `GET /audio/playlist/{playlist_id}`.\n\nNote that this endpoint will return nothing unless the `chunked` parameter is set to `true`.\n",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1playlist~1%7Bplaylist_id%7D/parameters/0"
          },
          {
            "$ref": "#/paths/~1v1~1props/get/parameters/0"
          }
        ],
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string",
                  "enum": [
                    "change"
                  ]
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/capture/status": {
      "get": {
        "operationId": "captureStatusGet",
        "tags": [
          "Capture"
        ],
        "summary": "Requests the current capture status and capture time.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1props/get/parameters/0"
          }
        ],
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "capturing"
                  ],
                  "properties": {
                    "capturing": {
                      "type": "boolean",
                      "description": "`true` if the capture is running, `false` otherwise\n"
                    },
                    "capture_time": {
                      "type": "string",
                      "description": "The length of time the capture has been running for, hh:mm:ss format",
                      "example": "00:42:27"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/capture/{operation}": {
      "get": {
        "operationId": "captureOperation",
        "tags": [
          "Capture"
        ],
        "summary": "Performs the requested capture operation (start, stop).",
        "parameters": [
          {
            "in": "path",
            "required": true,
            "name": "operation",
            "description": "The capture operation to perform",
            "schema": {
              "type": "string",
              "enum": [
                "start",
                "stop"
              ]
            }
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/capture/settings": {
      "get": {
        "operationId": "captureSettingsGet",
        "tags": [
          "Capture"
        ],
        "summary": "Requests the current capture settings.",
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/paths/~1v1~1capture~1settings/put/requestBody/content/application~1json/schema"
                },
                "examples": {
                  "disk": {
                    "$ref": "#/paths/~1v1~1capture~1settings/put/requestBody/content/application~1json/examples/disk"
                  },
                  "rtmp_no_local": {
                    "$ref": "#/paths/~1v1~1capture~1settings/put/requestBody/content/application~1json/examples/rtmp_no_local"
                  },
                  "rtmp_local": {
                    "$ref": "#/paths/~1v1~1capture~1settings/put/requestBody/content/application~1json/examples/rtmp_local"
                  },
                  "resi": {
                    "$ref": "#/paths/~1v1~1capture~1settings/put/requestBody/content/application~1json/examples/resi"
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      },
      "put": {
        "operationId": "captureSettingsSet",
        "tags": [
          "Capture"
        ],
        "summary": "Sets the capture settings.",
        "requestBody": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "400": {
            "$ref": "#/paths/~1v1~1looks/post/responses/400"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          },
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "source",
                  "destination",
                  "audio_routing"
                ],
                "properties": {
                  "source": {
                    "type": "string",
                    "description": "The UUID of the source screen."
                  },
                  "audio_routing": {
                    "type": "array",
                    "items": {
                      "type": "array",
                      "items": {
                        "type": "integer"
                      }
                    },
                    "description": "Audio routing for the capture stream."
                  },
                  "disk": {
                    "type": "object",
                    "required": [
                      "file_location",
                      "codec",
                      "resolution",
                      "frame_rate"
                    ],
                    "properties": {
                      "file_location": {
                        "type": "string",
                        "description": "The location of the file on disk (folder only, no filename)",
                        "example": "/Users/someuser/Movies"
                      },
                      "encoding": {
                        "type": "string",
                        "description": "The encoding used for encoding the captured video. This must match one\nof the encodings returned by the /encoding endpoint\n"
                      },
                      "resolution": {
                        "type": "object",
                        "required": [
                          "width",
                          "height"
                        ],
                        "properties": {
                          "width": {
                            "type": "integer",
                            "example": 1920
                          },
                          "height": {
                            "type": "integer",
                            "example": 1080
                          }
                        }
                      },
                      "frame_rate": {
                        "type": "number",
                        "description": "The capture frame rate.",
                        "example": 29.97
                      }
                    }
                  },
                  "rtmp": {
                    "type": "object",
                    "required": [
                      "url",
                      "key",
                      "encoding",
                      "save_local"
                    ],
                    "properties": {
                      "url": {
                        "type": "string",
                        "description": "The URL of the RTMP server.",
                        "example": "rtmps://server.com/live"
                      },
                      "key": {
                        "type": "string",
                        "description": "The stream key to use with the URL.",
                        "example": "g5sr2hz9"
                      },
                      "encoding": {
                        "type": "string",
                        "description": "The encoding used for encoding the captured video. This must match one\nof the encodings returned by the /encoding endpoint\n"
                      },
                      "save_local": {
                        "type": "boolean",
                        "description": "`true` to save a local copy of the stream, `false` otherwise\n"
                      },
                      "file_location": {
                        "type": "string",
                        "description": "The location of the file on disk (folder only, no filename)",
                        "example": "/Users/someuser/Movies"
                      }
                    }
                  },
                  "resi": {
                    "type": "object",
                    "required": [
                      "destination_group",
                      "encoding"
                    ],
                    "properties": {
                      "event_name": {
                        "type": "string",
                        "description": "Optional event name.",
                        "example": "My Event"
                      },
                      "event_description": {
                        "type": "string",
                        "description": "Optional event description.",
                        "example": "This is a short description of the event."
                      },
                      "destination_group": {
                        "type": "string",
                        "example": "Default Destination Group."
                      },
                      "encoding": {
                        "type": "string",
                        "description": "The encoding used for encoding the captured video. This must match one\nof the encodings returned by the /encoding endpoint\n"
                      }
                    }
                  }
                }
              },
              "examples": {
                "disk": {
                  "summary": "Capture to disk",
                  "value": {
                    "source": "3C39C433-5C18-4F51-B357-55BB870227C4",
                    "audio_routing": [
                      [
                        1
                      ],
                      [
                        2
                      ]
                    ],
                    "disk": {
                      "file_location": "/Users/someuser/Movies",
                      "codec": "h_264",
                      "resolution": {
                        "width": 1920,
                        "height": 1080
                      },
                      "frame_rate": 29.97
                    }
                  }
                },
                "rtmp_no_local": {
                  "summary": "Stream to RTMP (no local copy)",
                  "value": {
                    "source": "3C39C433-5C18-4F51-B357-55BB870227C4",
                    "audio_routing": [
                      [
                        1
                      ],
                      [
                        2
                      ]
                    ],
                    "rtmp": {
                      "server": "rtmps://server.com/live",
                      "key": "g5sr2hz9",
                      "encoding": "720p30_2_5",
                      "save_local": false
                    }
                  }
                },
                "rtmp_local": {
                  "summary": "Stream to RTMP (with local copy)",
                  "value": {
                    "source": "3C39C433-5C18-4F51-B357-55BB870227C4",
                    "destination": "disk",
                    "rtmp": {
                      "server": "rtmps://server.com/live",
                      "key": "g5sr2hz9",
                      "encoding": "720p30_2_5",
                      "save_local": true,
                      "file_location": "/Users/someuser/Movies"
                    }
                  }
                },
                "resi": {
                  "summary": "Stream to Resi",
                  "value": {
                    "source": "3C39C433-5C18-4F51-B357-55BB870227C4",
                    "destination": "disk",
                    "audio_routing": [
                      [
                        1
                      ],
                      [
                        2
                      ]
                    ],
                    "resi": {
                      "event_name": "My Event",
                      "event_description": "This is a short description of the event.",
                      "destination_group": "Default Destination Group",
                      "encoding": "720p30_4"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/capture/encodings/{type}": {
      "get": {
        "operationId": "captureModesGet",
        "tags": [
          "Capture"
        ],
        "summary": "Requests a list of all available capture modes for the capture type (disk, rtmp, resi).",
        "parameters": [
          {
            "in": "path",
            "required": true,
            "name": "type",
            "description": "The required capture type.",
            "schema": {
              "type": "string",
              "enum": [
                "disk",
                "rtmp",
                "resi"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request was completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "example": [
                  "h_264",
                  "h_265",
                  "hap",
                  "hap_alpha",
                  "hap_q",
                  "prores_422",
                  "prores_422_hq",
                  "prores_422_lt",
                  "prores_422_proxy",
                  "prores_4444",
                  "prores_4444_xq"
                ]
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/clear/layer/{layer}": {
      "get": {
        "operationId": "clearLayer",
        "tags": [
          "Clear"
        ],
        "summary": "Clears the specified layer (audio, props, messages, announcements, slide, media, video_input).",
        "parameters": [
          {
            "in": "path",
            "required": true,
            "name": "layer",
            "description": "The name of layer that is to be cleared.",
            "schema": {
              "type": "string",
              "enum": [
                "audio",
                "props",
                "messages",
                "announcements",
                "slide",
                "media",
                "video_input"
              ]
            }
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/clear/group/{id}": {
      "get": {
        "operationId": "clearGroupGet",
        "tags": [
          "Clear"
        ],
        "summary": "Requests the details of the specified clear group.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
          }
        ],
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/paths/~1v1~1clear~1groups/post/requestBody/content/application~1json/schema"
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      },
      "put": {
        "operationId": "clearGroupSet",
        "tags": [
          "Clear"
        ],
        "summary": "Sets the details of the specified clear group.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/paths/~1v1~1clear~1groups/post/requestBody/content/application~1json/schema"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/paths/~1v1~1clear~1groups/post/requestBody/content/application~1json/schema"
                }
              }
            }
          },
          "400": {
            "$ref": "#/paths/~1v1~1looks/post/responses/400"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      },
      "delete": {
        "operationId": "clearGroupDelete",
        "tags": [
          "Clear"
        ],
        "summary": "Deletes the specified clear group.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/clear/group/{id}/icon": {
      "parameters": [
        {
          "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
        }
      ],
      "get": {
        "operationId": "clearGroupIconGet",
        "tags": [
          "Clear"
        ],
        "summary": "Requests the image data for the icon of the specified clear group.",
        "responses": {
          "200": {
            "$ref": "#/paths/~1v1~1mask~1%7Bid%7D~1thumbnail/get/responses/200"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      },
      "put": {
        "operationId": "clearGroupIconSet",
        "tags": [
          "Clear"
        ],
        "summary": "Sets the custom icon of the specified clear group.",
        "requestBody": {
          "required": true,
          "content": {
            "image/*": {
              "schema": {
                "type": "string",
                "format": "binary"
              }
            }
          }
        },
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/clear/group/{id}/trigger": {
      "get": {
        "operationId": "clearGroupTrigger",
        "tags": [
          "Clear"
        ],
        "summary": "Triggers the specified clear group.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/clear/groups": {
      "get": {
        "operationId": "clearGroupsGet",
        "tags": [
          "Clear"
        ],
        "summary": "Requests a list of all the configured clear groups.",
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/paths/~1v1~1clear~1groups/post/requestBody/content/application~1json/schema"
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      },
      "post": {
        "operationId": "clearGroupCreate",
        "tags": [
          "Clear"
        ],
        "summary": "Create a clear group with the details specified.",
        "description": "The UUID and index in the request body are ignored. They will be automatically\nassigned and returned in the response body.\n",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "index",
                  "name",
                  "uuid",
                  "layers",
                  "icon",
                  "tint",
                  "stop_timeline_announcements",
                  "stop_timeline_presentation"
                ],
                "properties": {
                  "id": {
                    "$ref": "#/paths/~1v1~1playlist~1current/get/responses/200/content/application~1json/schema"
                  },
                  "icon": {
                    "type": "string",
                    "format": "base64",
                    "description": "Icon to show for this clear group. Base64-encoded JPEG image data."
                  },
                  "tint": {
                    "description": "The color tint to apply to the icon for this clear group.",
                    "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/put/requestBody/content/application~1json/schema/properties/color"
                  },
                  "layers": {
                    "type": "array",
                    "description": "The list of all the layers cleared by this clear group",
                    "items": {
                      "type": "string",
                      "enum": [
                        "music",
                        "audio_effects",
                        "props",
                        "messages",
                        "announcements",
                        "presentation",
                        "presentation_media",
                        "video_input"
                      ]
                    }
                  },
                  "stop_timeline_announcements": {
                    "type": "boolean",
                    "description": "Stop the timeline on the announcements layer",
                    "default": true
                  },
                  "stop_timeline_presentation": {
                    "type": "boolean",
                    "description": "Stop the timeline on the presentation layer",
                    "default": true
                  },
                  "clear_next_presentation": {
                    "type": "boolean",
                    "description": "Clear the next presentation when clearing the slide layer."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/paths/~1v1~1clear~1groups/post/requestBody/content/application~1json/schema"
                }
              }
            }
          },
          "400": {
            "$ref": "#/paths/~1v1~1looks/post/responses/400"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/groups": {
      "get": {
        "operationId": "globalGroupsGet",
        "tags": [
          "Global Groups"
        ],
        "summary": "Requests a list of all the configured global groups.",
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "id",
                      "color"
                    ],
                    "properties": {
                      "id": {
                        "$ref": "#/paths/~1v1~1playlist~1current/get/responses/200/content/application~1json/schema"
                      },
                      "color": {
                        "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/put/requestBody/content/application~1json/schema/properties/color"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/group/{id}": {
      "get": {
        "operationId": "globalGroupTrigger",
        "tags": [
          "Global Groups"
        ],
        "summary": "Triggers the specified global group.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/libraries": {
      "get": {
        "operationId": "libraryListGet",
        "tags": [
          "Library"
        ],
        "summary": "Requests a list of all the configured libraries.",
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "id"
                    ],
                    "properties": {
                      "id": {
                        "$ref": "#/paths/~1v1~1playlist~1current/get/responses/200/content/application~1json/schema"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/library/{id}": {
      "get": {
        "operationId": "libraryGet",
        "tags": [
          "Library"
        ],
        "summary": "Requests an array of all items in the specified library.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
          },
          {
            "$ref": "#/paths/~1v1~1props/get/parameters/0"
          }
        ],
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "updateType",
                    "items"
                  ],
                  "properties": {
                    "updateType": {
                      "type": "string",
                      "description": "The type of update this message represents:\n  * `all` - The entire library, only sent as the initial response.\n  * `add` - One or more items has been added to the library\n  * `remove` - One or more items has been removed from the library\n",
                      "enum": [
                        "all",
                        "add",
                        "remove"
                      ]
                    },
                    "items": {
                      "type": "array",
                      "description": "The items included in this update.",
                      "items": {
                        "$ref": "#/paths/~1v1~1playlist~1current/get/responses/200/content/application~1json/schema"
                      }
                    }
                  }
                },
                "examples": {
                  "initial": {
                    "summary": "Initial response",
                    "value": {
                      "updateType": "all",
                      "items": [
                        {
                          "index": 0,
                          "name": "I Surrender All",
                          "uuid": "942C3FC3-C4B2-44F7-A55D-4CC913BB8A5D"
                        },
                        {
                          "index": 1,
                          "name": "It Is Well With My Soul",
                          "uuid": "942C3FC3-C4B2-44F7-A55D-4CC913BB8A5E"
                        },
                        {
                          "index": 2,
                          "name": "Amazing Grace",
                          "uuid": "942C3FC3-C4B2-44F7-A55D-4CC913BB8A5F"
                        }
                      ]
                    }
                  },
                  "add": {
                    "summary": "Items added",
                    "value": {
                      "updateType": "add",
                      "items": [
                        {
                          "index": 3,
                          "name": "This I Believe",
                          "uuid": "942C3FC3-C4B2-44F7-A55D-4CC913BB8A5A"
                        }
                      ]
                    }
                  },
                  "remove": {
                    "summary": "Items removed",
                    "value": {
                      "updateType": "remove",
                      "items": [
                        {
                          "index": 1,
                          "name": "It Is Well With My Soul",
                          "uuid": "942C3FC3-C4B2-44F7-A55D-4CC913BB8A5E"
                        },
                        {
                          "index": 2,
                          "name": "Amazing Grace",
                          "uuid": "942C3FC3-C4B2-44F7-A55D-4CC913BB8A5F"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/looks": {
      "get": {
        "operationId": "lookGetAll",
        "tags": [
          "Looks"
        ],
        "summary": "Requests a list of all configured audience looks, except the live look.",
        "description": "The current / live look is NOT included. The current look can be retrieved by GET /v1/look/current. While the current look may have the same attributes as one of the looks returned by this endpoint, the current look will have a unique UUID which is not returned by this endpoint.\n",
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/paths/~1v1~1looks/post/requestBody/content/application~1json/schema"
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      },
      "post": {
        "operationId": "lookCreate",
        "tags": [
          "Looks"
        ],
        "summary": "Creates a new audience look with the specified details.",
        "description": "The UUID and index are ignored in the request body. They are automatically\nassigned and returned as part of the response.\n",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "uuid",
                  "index",
                  "name",
                  "screens"
                ],
                "properties": {
                  "id": {
                    "$ref": "#/paths/~1v1~1playlist~1current/get/responses/200/content/application~1json/schema"
                  },
                  "screens": {
                    "type": "array",
                    "description": "The list of screens in the look",
                    "items": {
                      "type": "object",
                      "required": [
                        "video_input",
                        "media",
                        "slide",
                        "props",
                        "messages"
                      ],
                      "properties": {
                        "video_input": {
                          "type": "boolean",
                          "description": "Specifies whether the video input is enabled for this screen"
                        },
                        "media": {
                          "type": "boolean",
                          "description": "Specifies whether background media is enabled for this screen"
                        },
                        "slide": {
                          "type": "boolean",
                          "description": "Specifies whether the slide data is enabled for this screen"
                        },
                        "announcements": {
                          "type": "boolean",
                          "description": "Specifies whether the announcements layer is enabled for this screen"
                        },
                        "props": {
                          "type": "boolean",
                          "description": "Specifies whether props are enabled for this screen"
                        },
                        "messages": {
                          "type": "boolean",
                          "description": "Specifies whether messages are enabled for this screen"
                        },
                        "presentation": {
                          "nullable": true,
                          "type": "string",
                          "description": "The UUID of the theme slide to apply to slide data on the presentation layer.\nNot present or a null or empty string if no template is to be applied.\nIf a UUID is provided but a matching theme slide is not found, then no change is made to the currently assigned theme slide.\n",
                          "example": "42C3FC3-C4B2-44F7-A55D-4CC913BB8A5D"
                        },
                        "mask": {
                          "nullable": true,
                          "type": "string",
                          "description": "The UUID of the mask to apply to this screen.\nNot present or a null or empty string if no mask is to be applied.\nIf a UUID is provided but a matching mask is not found, then no change is made to the currently assigned mask.\n",
                          "example": "42C3FC3-C4B2-44F7-A55D-4CC913BB8A5D"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/paths/~1v1~1looks/post/requestBody/content/application~1json/schema"
                }
              }
            }
          },
          "400": {
            "description": "The request was not valid."
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/look/current": {
      "get": {
        "operationId": "lookGetCurrent",
        "tags": [
          "Looks"
        ],
        "summary": "Requests the details of the currently live audience look.",
        "description": "NOTE: The current look is not contained in the looks returned by `GET /v1/looks` as\nthe current look gets special treatment in ProPresenter and cannot be deleted.\nThe current look may have the same attributes as one of the other not current saved looks, but it will have a\nunique UUID not contained in the response of `GET /v1/looks`. If the current look's attributes match\nthose of one of the saved looks, the index returned is the index of the matching look in the\narray returned by `GET /v1/looks`. If the current look has been modified and its attributes don't\nmatch any of the saved looks, the index returned is the size of the saved looks array.\n",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1props/get/parameters/0"
          }
        ],
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/paths/~1v1~1looks/post/requestBody/content/application~1json/schema"
                }
              }
            }
          }
        }
      },
      "put": {
        "operationId": "lookSetCurrent",
        "tags": [
          "Looks"
        ],
        "summary": "Sets the details of the currently live audience look.",
        "description": "The UUID and index in the request body are ignored and not applied to the specified look.\nFor multiple screens, the screens array is applied in order by index to the array of existing screens in the look.\nUpdates to the screens are done until either the end of the screens update array is reached or the end of the existing screens array is reached.\nIf the current look is not found in the saved looks (because it is modified but not saved), returns the size of the saved looks array for the index.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/paths/~1v1~1looks/post/requestBody/content/application~1json/schema"
              }
            }
          }
        },
        "responses": {
          "204": {
            "description": "The request was processed successfully. There is no response body."
          },
          "400": {
            "$ref": "#/paths/~1v1~1looks/post/responses/400"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/look/{id}": {
      "get": {
        "operationId": "lookGet",
        "tags": [
          "Looks"
        ],
        "summary": "Requests the details of the specified audience look.",
        "description": "NOTE: The currently live look is not found by this endpoint. To get the live look use GET /v1/look/current.\n",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
          }
        ],
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/paths/~1v1~1looks/post/requestBody/content/application~1json/schema"
                }
              }
            }
          },
          "404": "responses.yaml#/404"
        }
      },
      "put": {
        "operationId": "lookPut",
        "tags": [
          "Looks"
        ],
        "summary": "Sets the details of the specified audience look.",
        "description": "The UUID and index are ignored in the request. They are not modified by this operation.\nFor multiple screens, the screens array is applied in order by index to the array of existing screens in the look.\nUpdates to the screens are done until either the end of the screens update array is reached or the end of the existing screens array is reached.\nNOTE: The currently live look is not settable by this endpoint. To set the live look use PUT /v1/look/current.\n",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/paths/~1v1~1looks/post/requestBody/content/application~1json/schema"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/paths/~1v1~1looks/post/requestBody/content/application~1json/schema"
                }
              }
            }
          },
          "400": {
            "$ref": "#/paths/~1v1~1looks/post/responses/400"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      },
      "delete": {
        "operationId": "lookDelete",
        "tags": [
          "Looks"
        ],
        "summary": "Deletes the specified audience look from the saved looks.",
        "description": "NOTE: The currently live look may not be deleted.\n",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/look/{id}/trigger": {
      "get": {
        "operationId": "lookTrigger",
        "tags": [
          "Looks"
        ],
        "summary": "Triggers the specified audience look to make it the live/current look.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/macros": {
      "get": {
        "operationId": "macroGetAll",
        "tags": [
          "Macro"
        ],
        "summary": "Requests a list of all the configured macros.",
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "description": "The list of all defined macros.",
                  "items": {
                    "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/put/requestBody/content/application~1json/schema"
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/macro/{id}": {
      "parameters": [
        {
          "in": "path",
          "required": true,
          "name": "id",
          "description": "The ID of the required item, either name, index or UUID.",
          "schema": {
            "type": "string"
          },
          "examples": {
            "by_name": {
              "summary": "Match item by name",
              "value": "Item Name"
            },
            "by_index": {
              "summary": "Match item by index",
              "value": "3"
            },
            "by_uuid": {
              "summary": "Match item by UUID",
              "value": "3C39C433-5C18-4F51-B357-55BB870227C4"
            }
          }
        }
      ],
      "get": {
        "operationId": "macroGet",
        "tags": [
          "Macro"
        ],
        "summary": "Requests the details of the specified macro.",
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/put/requestBody/content/application~1json/schema"
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      },
      "put": {
        "operationId": "macroSet",
        "tags": [
          "Macro"
        ],
        "summary": "Sets the details of the specified macro.",
        "description": "The UUID and index in the request body are ignored. They are not updated.\n",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "id",
                  "color"
                ],
                "properties": {
                  "id": {
                    "$ref": "#/paths/~1v1~1playlist~1current/get/responses/200/content/application~1json/schema"
                  },
                  "color": {
                    "type": "object",
                    "required": [
                      "red",
                      "green",
                      "blue",
                      "alpha"
                    ],
                    "properties": {
                      "red": {
                        "type": "number",
                        "description": "The red component of the color, between 0 and 1",
                        "example": 0
                      },
                      "green": {
                        "type": "number",
                        "description": "The green component of the color, between 0 and 1",
                        "example": 0.54
                      },
                      "blue": {
                        "type": "number",
                        "description": "The blue component of the color, between 0 and 1",
                        "example": 0.87
                      },
                      "alpha": {
                        "type": "number",
                        "description": "The alpha component of the color, between 0 and 1",
                        "example": 1,
                        "default": 1
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/put/requestBody/content/application~1json/schema"
                }
              }
            }
          },
          "400": {
            "$ref": "#/paths/~1v1~1looks/post/responses/400"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      },
      "delete": {
        "operationId": "macroDelete",
        "tags": [
          "Macro"
        ],
        "summary": "Deletes the specified macro.",
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/macro/{id}/trigger": {
      "get": {
        "operationId": "macroTrigger",
        "tags": [
          "Macro"
        ],
        "summary": "Triggers the specified macro.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "400": {
            "$ref": "#/paths/~1v1~1looks/post/responses/400"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/masks": {
      "get": {
        "operationId": "maskGetAll",
        "tags": [
          "Masks"
        ],
        "summary": "Requests a list of all configured masks.",
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/paths/~1v1~1mask~1%7Bid%7D/get/responses/200/content/application~1json/schema"
                  }
                },
                "example": [
                  {
                    "id": {
                      "uuid": "42C3FC3-C4B2-44F7-A55D-4CC913BB8A5D",
                      "index": 0,
                      "name": "Mask 1"
                    }
                  },
                  {
                    "id": {
                      "uuid": "942C3FC3-C4B2-44F7-A55D-4CC913BB8A5D",
                      "index": 1,
                      "name": "Mask 2"
                    }
                  }
                ]
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/mask/{id}": {
      "get": {
        "operationId": "maskGet",
        "tags": [
          "Masks"
        ],
        "summary": "Requests the details of the specified mask.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
          }
        ],
        "responses": {
          "200": {
            "summary": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "id"
                  ],
                  "properties": {
                    "id": {
                      "$ref": "#/paths/~1v1~1playlist~1current/get/responses/200/content/application~1json/schema"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/mask/{id}/thumbnail": {
      "get": {
        "operationId": "maskThumbnailGet",
        "tags": [
          "Masks"
        ],
        "summary": "Requests a thumbnail image of the specified mask at the given quality value.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
          },
          {
            "in": "query",
            "required": false,
            "name": "quality",
            "description": "The desired quality of the thumbnail, in pixels",
            "schema": {
              "type": "integer",
              "example": 400,
              "default": 400
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "image/jpeg": {
                "schema": {
                  "type": "string",
                  "format": "binary",
                  "example": "image data here"
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/media/playlists": {
      "get": {
        "operationId": "mediaPlaylistsGet",
        "tags": [
          "Media"
        ],
        "summary": "Requests a list of all the configured media playlists.",
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/paths/~1v1~1audio~1playlists/get/responses/200/content/application~1json/schema/items"
                  }
                },
                "example": {
                  "id": {
                    "uuid": "ED59503B-394D-4D5D-B0B0-5AE80D0BA025",
                    "name": "Playlist Folder",
                    "index": 0
                  },
                  "type": "group",
                  "children": [
                    {
                      "id": {
                        "uuid": "C49A250A-3E32-4C26-A220-46D6596426B5",
                        "name": "Playlist 1",
                        "index": 0
                      },
                      "type": "playlist",
                      "children": []
                    },
                    {
                      "id": {
                        "uuid": "D8C5D151-45C9-4CFF-B1F9-74F3B4B5173B",
                        "name": "Playlist 2",
                        "index": 1
                      },
                      "type": "playlist",
                      "children": []
                    }
                  ]
                }
              }
            }
          }
        }
      }
    },
    "/v1/media/playlist/{playlist_id}": {
      "get": {
        "operationId": "mediaPlaylistGet",
        "tags": [
          "Media"
        ],
        "summary": "Requests a list of all the media items in the specified media playlist.",
        "description": "A maximum of 100 items will be returned per call. The `start` query parameter can\nbe used to retrieve multiple pages of items, by setting it to the index of the first\nitem to return.\n",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1playlist~1%7Bplaylist_id%7D/parameters/0"
          },
          {
            "$ref": "#/paths/~1v1~1audio~1playlist~1%7Bplaylist_id%7D/get/parameters/1"
          }
        ],
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "id",
                      "type",
                      "artist",
                      "duration"
                    ],
                    "properties": {
                      "id": {
                        "$ref": "#/paths/~1v1~1playlist~1current/get/responses/200/content/application~1json/schema"
                      },
                      "type": {
                        "type": "string",
                        "enum": [
                          "audio",
                          "video",
                          "image"
                        ],
                        "description": "The type of media this item represents."
                      },
                      "artist": {
                        "type": "string",
                        "description": "The media artist.",
                        "example": "John Newton"
                      },
                      "duration": {
                        "type": "integer",
                        "description": "Time in seconds."
                      }
                    }
                  }
                },
                "example": {
                  "id": {
                    "uuid": "B238C071-3628-4204-BB19-DDE76DC57CE7",
                    "name": "Playlist 3",
                    "index": 2
                  },
                  "items": [
                    {
                      "id": {
                        "uuid": "94A2D4EA-EEA5-48A4-AF6F-850D700C1830",
                        "name": "Photo 1",
                        "index": 0
                      },
                      "type": "image",
                      "artist": "unknown",
                      "duration": 0
                    },
                    {
                      "id": {
                        "uuid": "8F40D44E-4018-4552-8803-60DC788DB1CF",
                        "name": "Amazing Grace",
                        "index": 1
                      },
                      "type": "video",
                      "artist": "John Newton",
                      "duration": 110
                    }
                  ]
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/media/playlist/{playlist_id}/updates": {
      "get": {
        "operationId": "mediaPlaylistUpdateGet",
        "tags": [
          "Media"
        ],
        "summary": "Requests a chunked data update every time the specified media playlist changes.",
        "description": "This endpoint returns a chunked response, where each chunk is a simple string \"change\".\nThis string will be sent whenever the media playlist changes, and the playlist can\nbe queried using the `/media/playlist/{id}` endpoint.\n\nNote that this endpoint will return nothing unless the `chunked` parameters is set to `true`\n",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1playlist~1%7Bplaylist_id%7D/parameters/0"
          },
          {
            "$ref": "#/paths/~1v1~1props/get/parameters/0"
          }
        ],
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string",
                  "enum": [
                    "change"
                  ]
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/media/{uuid}/thumbnail": {
      "get": {
        "operationId": "mediaThumbnailGet",
        "tags": [
          "Media"
        ],
        "summary": "Requests a thumbnail image of the specified media item at the given quality value.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1presentation~1%7Buuid%7D/get/parameters/0"
          },
          {
            "$ref": "#/paths/~1v1~1mask~1%7Bid%7D~1thumbnail/get/parameters/1"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/paths/~1v1~1mask~1%7Bid%7D~1thumbnail/get/responses/200"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/messages": {
      "get": {
        "operationId": "messageGetAll",
        "tags": [
          "Message"
        ],
        "summary": "Requests a list of all configured messages.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1props/get/parameters/0"
          }
        ],
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "description": "The list of all defined messages.",
                  "items": {
                    "$ref": "#/paths/~1v1~1messages/post/requestBody/content/application~1json/schema"
                  }
                },
                "example": [
                  {
                    "title": "New Message",
                    "tokens": [
                      {
                        "name": "",
                        "text": {
                          "text": "Message for "
                        }
                      },
                      {
                        "name": "Name",
                        "text": {
                          "text": null
                        }
                      },
                      {
                        "name": "",
                        "text": {
                          "text": ":"
                        }
                      },
                      {
                        "name": "Message",
                        "text": {
                          "text": ""
                        }
                      }
                    ]
                  }
                ]
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      },
      "post": {
        "operationId": "messageCreate",
        "tags": [
          "Message"
        ],
        "summary": "Creates a new message with specified details.",
        "description": "The UUID and index are ignored in the request body. They are automatically\nassigned and returned in the response body.\n",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "id",
                  "message",
                  "theme"
                ],
                "properties": {
                  "id": {
                    "$ref": "#/paths/~1v1~1playlist~1current/get/responses/200/content/application~1json/schema"
                  },
                  "message": {
                    "type": "string",
                    "description": "The base string for the message.",
                    "example": "Please come to room {room}"
                  },
                  "tokens": {
                    "type": "array",
                    "description": "An array of the substrings and tokens that make up the message detail.",
                    "items": {
                      "$ref": "#/paths/~1v1~1message~1%7Bid%7D~1trigger/post/requestBody/content/application~1json/schema/items"
                    },
                    "example": [
                      {
                        "name": "room",
                        "text": {
                          "text": "204"
                        }
                      }
                    ]
                  },
                  "theme": {
                    "$ref": "#/paths/~1v1~1playlist~1current/get/responses/200/content/application~1json/schema"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/paths/~1v1~1messages/post/requestBody/content/application~1json/schema"
                }
              }
            }
          },
          "400": {
            "$ref": "#/paths/~1v1~1looks/post/responses/400"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/message/{id}": {
      "get": {
        "operationId": "messageGet",
        "tags": [
          "Message"
        ],
        "summary": "Requests the details of the specified message.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
          }
        ],
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/paths/~1v1~1messages/post/requestBody/content/application~1json/schema"
                },
                "example": {
                  "id": {
                    "name": "Test Message",
                    "uuid": "942C3FC3-C4B2-44F7-A55D-4CC913BB8A5D",
                    "index": 0
                  },
                  "message": "Text {text}, Clock {clock}, Countdown {countdown}, Countdown to time {count_down_to_time}, Elapsed {elapsed}",
                  "tokens": [
                    {
                      "name": "text",
                      "text": {
                        "text": "142"
                      }
                    },
                    {
                      "name": "clock",
                      "clock": {
                        "format": {
                          "date": "short",
                          "time": "long",
                          "is_24_hours": true
                        }
                      }
                    },
                    {
                      "name": "countdown",
                      "timer": {
                        "configuration": {
                          "id": {
                            "name": "Timer 1",
                            "uuid": "43b4c5c6-145a-4b19-9968-7b78e6980e82",
                            "index": 0
                          },
                          "allows_overrun": true,
                          "countdown": {
                            "duration": 300
                          }
                        },
                        "format": {
                          "hour": "remove_long",
                          "minute": "remove_long",
                          "second": "short",
                          "millisecond": "none"
                        }
                      }
                    },
                    {
                      "name": "count_down_to_time",
                      "timer": {
                        "configuration": {
                          "id": {
                            "name": "Timer 2",
                            "uuid": "1355b458-5f99-4e6e-8ac7-8522061f6bdb",
                            "index": 0
                          },
                          "allows_overrun": true,
                          "count_down_to_time": {
                            "time_of_day": "09:30",
                            "period": "am"
                          }
                        },
                        "format": {
                          "hour": "remove_long",
                          "minute": "remove_long",
                          "second": "short",
                          "millisecond": "none"
                        }
                      }
                    },
                    {
                      "name": "elapsed",
                      "timer": {
                        "configuration": {
                          "id": {
                            "name": "Timer 3",
                            "uuid": "8efe5ec8-daf4-4609-aea2-7c80efa7f6fa",
                            "index": 0
                          },
                          "allows_overrun": true,
                          "elapsed": {
                            "start_time": 0
                          }
                        },
                        "format": {
                          "hour": "remove_long",
                          "minute": "remove_long",
                          "second": "short",
                          "millisecond": "none"
                        }
                      }
                    }
                  ],
                  "theme": {
                    "name": "Default",
                    "uuid": "f5468354-01fb-44d8-b7b3-5ede94c6115c",
                    "index": 0
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      },
      "put": {
        "operationId": "messageSet",
        "tags": [
          "Message"
        ],
        "summary": "Sets the details of the specified message.",
        "description": "The UUID and index in the request body are ignored. They are not updated.\n",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/paths/~1v1~1messages/post/requestBody/content/application~1json/schema"
              },
              "examples": {
                "text_token": {
                  "summary": "Text token",
                  "value": {
                    "id": {
                      "name": "Message with text token",
                      "uuid": "",
                      "index": 0
                    },
                    "message": "Please come to room {room}",
                    "tokens": [
                      {
                        "name": "room",
                        "text": {
                          "text": "142"
                        }
                      }
                    ],
                    "theme": {
                      "name": "",
                      "uuid": "",
                      "index": 0
                    }
                  }
                },
                "clock_token": {
                  "summary": "Clock Token",
                  "value": {
                    "id": {
                      "name": "Message with clock token",
                      "uuid": "",
                      "index": 0
                    },
                    "message": "The current time is {time}",
                    "tokens": [
                      {
                        "name": "time",
                        "clock": {
                          "format": {
                            "date": "short",
                            "time": "long",
                            "is_24_hours": true
                          }
                        }
                      }
                    ],
                    "theme": {
                      "name": "",
                      "uuid": "",
                      "index": 0
                    }
                  }
                },
                "timer_token_countdown": {
                  "summary": "Timer Token - Countdown",
                  "value": {
                    "id": {
                      "name": "Message with countdown timer token",
                      "uuid": "",
                      "index": 0
                    },
                    "message": "Time until start: {Timer Token}",
                    "tokens": [
                      {
                        "name": "Timer Token",
                        "timer": {
                          "id": {
                            "name": "Countdown Timer",
                            "uuid": "942C3FC3-C4B2-44F7-A55D-4CC913BB8A5D",
                            "index": 1
                          },
                          "allows_overrun": true,
                          "format": {
                            "hour": "remove_long",
                            "minute": "remove_long",
                            "second": "short",
                            "millisecond": "none"
                          },
                          "countdown": {
                            "duration": 300
                          }
                        }
                      }
                    ],
                    "theme": {
                      "name": "",
                      "uuid": "",
                      "index": 0
                    }
                  }
                },
                "timer_token_countdown_to_time": {
                  "summary": "Timer Token - Countdown To Time",
                  "value": {
                    "id": {
                      "name": "Message with countdown to time timer token",
                      "uuid": "",
                      "index": 0
                    },
                    "message": "Time until start: {Timer Token}",
                    "tokens": [
                      {
                        "name": "Timer Token",
                        "timer": {
                          "id": {
                            "name": "Count Down to Time Timer",
                            "uuid": "942C3FC3-C4B2-44F7-A55D-4CC913BB8A5D",
                            "index": 1
                          },
                          "allows_overrun": true,
                          "format": {
                            "hour": "remove_long",
                            "minute": "remove_long",
                            "second": "short",
                            "millisecond": "none"
                          },
                          "count_down_to_time": {
                            "time_of_day": 3600,
                            "period": "pm"
                          }
                        }
                      }
                    ],
                    "theme": {
                      "name": "",
                      "uuid": "",
                      "index": 0
                    }
                  }
                },
                "timer_token_elapsed": {
                  "summary": "Timer Token - Elapsed",
                  "value": {
                    "id": {
                      "name": "Message with elapsed timer token",
                      "uuid": "",
                      "index": 0
                    },
                    "message": "Time since start: {Timer Token}",
                    "tokens": [
                      {
                        "name": "Timer Token",
                        "timer": {
                          "id": {
                            "name": "Elapsed Timer",
                            "uuid": "942C3FC3-C4B2-44F7-A55D-4CC913BB8A5D",
                            "index": 1
                          },
                          "allows_overrun": true,
                          "format": {
                            "hour": "remove_long",
                            "minute": "remove_long",
                            "second": "short",
                            "millisecond": "none"
                          },
                          "elapsed": {
                            "start_time": 0,
                            "end_time": 60
                          }
                        }
                      }
                    ],
                    "theme": {
                      "name": "",
                      "uuid": "",
                      "index": 0
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/paths/~1v1~1messages/post/requestBody/content/application~1json/schema"
                }
              }
            }
          },
          "400": {
            "$ref": "#/paths/~1v1~1looks/post/responses/400"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      },
      "delete": {
        "operationId": "messaageDelete",
        "tags": [
          "Message"
        ],
        "summary": "Deletes the specified message.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/message/{id}/trigger": {
      "post": {
        "operationId": "messageTrigger",
        "tags": [
          "Message"
        ],
        "summary": "Triggers / Shows the specified message.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "oneOf": [
                    {
                      "type": "object",
                      "required": [
                        "name"
                      ],
                      "properties": {
                        "name": {
                          "type": "string",
                          "example": "My Token"
                        },
                        "text": {
                          "type": "object",
                          "required": [
                            "text"
                          ],
                          "properties": {
                            "text": {
                              "type": "string",
                              "example": "Hello, world!"
                            }
                          }
                        }
                      }
                    },
                    {
                      "type": "object",
                      "required": [
                        "name"
                      ],
                      "properties": {
                        "name": {
                          "type": "string",
                          "example": "My Token"
                        },
                        "timer": {
                          "type": "object",
                          "required": [
                            "configuration",
                            "format"
                          ],
                          "properties": {
                            "configuration": {
                              "$ref": "#/paths/~1v1~1timer~1%7Bid%7D/put/requestBody/content/application~1json/schema"
                            },
                            "format": {
                              "type": "object",
                              "required": [
                                "hour",
                                "minute",
                                "second",
                                "millisecond"
                              ],
                              "properties": {
                                "hour": {
                                  "type": "string",
                                  "enum": [
                                    "none",
                                    "short",
                                    "long",
                                    "remove_short",
                                    "remove_long"
                                  ]
                                },
                                "minute": {
                                  "$ref": "#/paths/~1v1~1messages/get/responses/200/content/application~1json/schema/items/properties/tokens/items/oneOf/1/properties/timer/properties/format/properties/hour"
                                },
                                "second": {
                                  "$ref": "#/paths/~1v1~1messages/get/responses/200/content/application~1json/schema/items/properties/tokens/items/oneOf/1/properties/timer/properties/format/properties/hour"
                                },
                                "millisecond": {
                                  "$ref": "#/paths/~1v1~1messages/get/responses/200/content/application~1json/schema/items/properties/tokens/items/oneOf/1/properties/timer/properties/format/properties/hour"
                                }
                              }
                            }
                          }
                        }
                      }
                    },
                    {
                      "type": "object",
                      "required": [
                        "name"
                      ],
                      "properties": {
                        "name": {
                          "type": "string",
                          "example": "My Token"
                        },
                        "clock": {
                          "type": "object",
                          "required": [
                            "format"
                          ],
                          "properties": {
                            "format": {
                              "type": "object",
                              "required": [
                                "date",
                                "time",
                                "is_24_hours"
                              ],
                              "properties": {
                                "date": {
                                  "type": "string",
                                  "enum": [
                                    "none",
                                    "short",
                                    "medium",
                                    "long",
                                    "full"
                                  ]
                                },
                                "time": {
                                  "$ref": "#/paths/~1v1~1messages/get/responses/200/content/application~1json/schema/items/properties/tokens/items/oneOf/2/properties/clock/properties/format/properties/date"
                                },
                                "is_24_hours": {
                                  "type": "boolean"
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              },
              "examples": {
                "trigger_message": {
                  "summary": "Triggering a message with multiple tokens",
                  "value": [
                    {
                      "name": "My Text Token",
                      "text": {
                        "text": "Hello, world!"
                      }
                    },
                    {
                      "name": "My Timer Token",
                      "timer": {
                        "configuration": {
                          "countdown": {
                            "duration": 3600
                          },
                          "format": {
                            "hour": "none",
                            "minute": "short",
                            "second": "long",
                            "millisecond": "remove_short"
                          }
                        }
                      }
                    },
                    {
                      "name": "My Clock Token",
                      "clock": {
                        "format": {
                          "date": "full",
                          "time": "short",
                          "is_24_hours": false
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "400": {
            "$ref": "#/paths/~1v1~1looks/post/responses/400"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/message/{id}/clear": {
      "get": {
        "operationId": "messageClear",
        "tags": [
          "Message"
        ],
        "summary": "Clears / Hides the specified message.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "400": {
            "$ref": "#/paths/~1v1~1looks/post/responses/400"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/find_my_mouse": {
      "get": {
        "operationId": "findMyMouse",
        "tags": [
          "Miscellaneous"
        ],
        "summary": "Executes the “Find My Mouse” operation.",
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/playlists": {
      "get": {
        "operationId": "playlistGetAll",
        "tags": [
          "Playlist"
        ],
        "summary": "Requests a list of all configured playlists.",
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/paths/~1v1~1playlists/post/responses/200/content/application~1json/schema"
                  }
                },
                "example": [
                  {
                    "id": {
                      "index": 0,
                      "name": "Service 2022-01-16",
                      "uuid": "942C3FC3-C4B2-44F7-A55D-4CC913BB8A5D"
                    },
                    "type": "playlist"
                  }
                ]
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      },
      "post": {
        "operationId": "playlistCreateTopLevel",
        "tags": [
          "Playlist"
        ],
        "summary": "Creates a playlist with the specified details.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "name",
                  "type"
                ],
                "properties": {
                  "name": {
                    "type": "string",
                    "description": "The name of the new playlist.",
                    "example": "Sunday Services"
                  },
                  "type": {
                    "type": "string",
                    "description": "The type of playlist item:\n  * `playlist` - A standard playlist\n  * `group` - A playlist folder, which can contain other playlists\n",
                    "enum": [
                      "playlist",
                      "group"
                    ],
                    "example": "playlist"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "type": "object",
                      "required": [
                        "id",
                        "type",
                        "playlists"
                      ],
                      "properties": {
                        "id": {
                          "$ref": "#/paths/~1v1~1playlist~1current/get/responses/200/content/application~1json/schema"
                        },
                        "type": {
                          "$ref": "#/paths/~1v1~1playlists/post/requestBody/content/application~1json/schema/properties/type"
                        },
                        "playlists": {
                          "type": "array",
                          "items": {
                            "$ref": "#/paths/~1v1~1playlists/post/responses/200/content/application~1json/schema"
                          }
                        }
                      }
                    },
                    {
                      "type": "object",
                      "required": [
                        "id",
                        "type"
                      ],
                      "properties": {
                        "id": {
                          "$ref": "#/paths/~1v1~1playlist~1current/get/responses/200/content/application~1json/schema"
                        },
                        "type": {
                          "$ref": "#/paths/~1v1~1playlists/post/requestBody/content/application~1json/schema/properties/type"
                        }
                      }
                    }
                  ],
                  "discriminator": {
                    "propertyName": "type",
                    "mapping": {
                      "group": "schemas.yaml#/playlist_group",
                      "playlist": "schemas.yaml#/playlist_data"
                    }
                  }
                },
                "example": {
                  "id": {
                    "uuid": "942C3FC3-C4B2-44F7-A55D-4CC913BB8A5D",
                    "index": 3,
                    "name": "Sunday Services"
                  },
                  "type": "playlist"
                }
              }
            }
          },
          "400": {
            "$ref": "#/paths/~1v1~1looks/post/responses/400"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/playlist/current": {
      "get": {
        "operationId": "playlistActiveGet",
        "tags": [
          "Playlist"
        ],
        "summary": "Requests the details of the currently active playlist.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1props/get/parameters/0"
          }
        ],
        "responses": {
          "200": {
            "description": "The response was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "uuid",
                    "name",
                    "index"
                  ],
                  "properties": {
                    "uuid": {
                      "type": "string",
                      "description": "The UUID of the item",
                      "example": "942C3FC3-C4B2-44F7-A55D-4CC913BB8A5D"
                    },
                    "name": {
                      "type": "string",
                      "description": "The user-defined name of the item",
                      "example": "My Item"
                    },
                    "index": {
                      "type": "integer",
                      "description": "The index of the item",
                      "example": 3
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/playlist/{playlist_id}": {
      "parameters": [
        {
          "in": "path",
          "required": true,
          "name": "playlist_id",
          "description": "The ID of the playlist, either UUID, name, or index, in order of interpretation and search priority. A path can also be specified to identify playlists within folders. UUID and name matches are searched through the entire playlist tree. Because UUIDs are unique a path is not necessary. A name path is not necessary unless there are multiple playlists with the same name in different folders. A partial path of names can be used as well. Indices only index into the immediate children at each level of the tree so an index path is requred to access playlists within folders if only using indices. A mix of UUIDs, names, and indices can be used for the path if desired.",
          "schema": {
            "type": "string"
          },
          "examples": {
            "by_uuid": {
              "summary": "Match playlist by UUID",
              "value": "3C39C433-5C18-4F51-B357-55BB870227C4"
            },
            "by_name": {
              "summary": "Match playlist by name",
              "value": "Playlist Name"
            },
            "by_name_with_path": {
              "summary": "Match playlist with a name path",
              "value": "Folder1/Folder2/Playlist Name"
            },
            "by_index": {
              "summary": "Match playlist by index",
              "value": 3
            },
            "by_index_path": {
              "summary": "Match playlist by index path",
              "value": "2/0/1"
            },
            "by_mixed_path": {
              "summary": "Match playlist by a mixed path",
              "value": "3C39C433-5C18-4F51-B357-55BB870227C4/Folder Name/0"
            }
          }
        }
      ],
      "get": {
        "operationId": "playlistGet",
        "tags": [
          "Playlist"
        ],
        "summary": "Requests a list of the items in the specified playlist.",
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "id",
                    "items"
                  ],
                  "properties": {
                    "id": {
                      "$ref": "#/paths/~1v1~1playlist~1current/get/responses/200/content/application~1json/schema"
                    },
                    "items": {
                      "type": "array",
                      "items": {
                        "$ref": "#/paths/~1v1~1playlist~1%7Bplaylist_id%7D/put/requestBody/content/application~1json/schema/items"
                      }
                    }
                  }
                },
                "example": {
                  "id": {
                    "index": 0,
                    "name": "Sunday Service",
                    "uuid": "942C3FC3-C4B2-44F7-A55D-4CC913BB8A5A"
                  },
                  "items": [
                    {
                      "id": {
                        "index": 0,
                        "name": "Songs",
                        "uuid": ""
                      },
                      "type": "header",
                      "is_hidden": true
                    },
                    {
                      "id": {
                        "index": 1,
                        "name": "Amazing Grace",
                        "uuid": "942C3FC3-C4B2-44F7-A55D-4CC913BB8A5B"
                      },
                      "type": "presentation",
                      "is_hidden": false
                    },
                    {
                      "id": {
                        "index": 2,
                        "name": "Graves Into Gardens",
                        "uuid": "942C3FC3-C4B2-44F7-A55D-4CC913BB8A5C"
                      },
                      "type": "presentation",
                      "is_hidden": false
                    },
                    {
                      "id": {
                        "index": 3,
                        "name": "Sermon",
                        "uuid": ""
                      },
                      "type": "header",
                      "is_hidden": false
                    },
                    {
                      "id": {
                        "index": 4,
                        "name": "Sermon Notes 2022-01-16",
                        "uuid": "942C3FC3-C4B2-44F7-A55D-4CC913BB8A5D"
                      },
                      "type": "presentation",
                      "is_hidden": false
                    }
                  ]
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      },
      "put": {
        "operationId": "playlistPut",
        "tags": [
          "Playlist"
        ],
        "summary": "Sets the contents of the specified playlist.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "id",
                    "type",
                    "is_hidden",
                    "is_pco"
                  ],
                  "properties": {
                    "id": {
                      "$ref": "#/paths/~1v1~1playlist~1current/get/responses/200/content/application~1json/schema"
                    },
                    "type": {
                      "type": "string",
                      "description": "The type of playlist item:\n  * `presentation` - A presentation playlist item.\n  * `placeholder` - A placeholder item, used for Planning Center items that have not been linked.\n  * `header` - A header playlist item.\n  * `media` - A media playlist item.\n  * `audio` - An audio playlist item.\n  * `livevideo` a live video playlist item.\n",
                      "enum": [
                        "presentation",
                        "placeholder",
                        "header",
                        "media",
                        "audio",
                        "livevideo"
                      ]
                    },
                    "is_hidden": {
                      "type": "boolean",
                      "description": "`true` if the item is hidden, `false` if the item is visible.\n"
                    },
                    "is_pco": {
                      "type": "boolean",
                      "description": "`true` if the item is a Planning Center Online item, `false` otherwise.\n"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "400": {
            "$ref": "#/paths/~1v1~1looks/post/responses/400"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      },
      "post": {
        "operationId": "playlistCreate",
        "tags": [
          "Playlist"
        ],
        "summary": "Creates a playlist with the specified details underneath the specified playlist or playlist folder.",
        "description": "An 400 error will be returned if the specified playlist group is not\nactually a playlist group (i.e. it is a regular playlist).\n",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/paths/~1v1~1playlists/post/requestBody/content/application~1json/schema"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/paths/~1v1~1playlists/post/responses/200/content/application~1json/schema"
                },
                "example": {
                  "id": {
                    "uuid": "942C3FC3-C4B2-44F7-A55D-4CC913BB8A5D",
                    "index": 3,
                    "name": "Sunday Services"
                  },
                  "type": "playlist"
                }
              }
            }
          },
          "400": {
            "$ref": "#/paths/~1v1~1looks/post/responses/400"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/presentation/current": {
      "get": {
        "operationId": "presentationGetActive",
        "tags": [
          "Presentation"
        ],
        "summary": "Requests the details of the currently active presentation.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1props/get/parameters/0"
          }
        ],
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "presentation": {
                      "$ref": "#/paths/~1v1~1presentation~1%7Buuid%7D/get/responses/200/content/application~1json/schema"
                    },
                    "announcements": {
                      "$ref": "#/paths/~1v1~1presentation~1%7Buuid%7D/get/responses/200/content/application~1json/schema"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/presentation/slide_index": {
      "get": {
        "operationId": "presentationGetSlideIndex",
        "tags": [
          "Presentation"
        ],
        "summary": "Requests the index of the current slide/cue within the currently active presentation.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1props/get/parameters/0"
          }
        ],
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "presentation": {
                      "type": "object",
                      "nullable": true,
                      "required": [
                        "index",
                        "presentation_id"
                      ],
                      "properties": {
                        "index": {
                          "type": "integer"
                        },
                        "presentation_id": {
                          "$ref": "#/paths/~1v1~1playlist~1current/get/responses/200/content/application~1json/schema"
                        }
                      }
                    },
                    "announcements": {
                      "$ref": "#/paths/~1v1~1presentation~1slide_index/get/responses/200/content/application~1json/schema/properties/presentation"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/presentation/chord_chart": {
      "get": {
        "operationId": "presentationGetChordChart",
        "tags": [
          "Presentation"
        ],
        "summary": "Requests the current chord chart image (if available) at the given quality value.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1mask~1%7Bid%7D~1thumbnail/get/parameters/1"
          },
          {
            "$ref": "#/paths/~1v1~1props/get/parameters/0"
          }
        ],
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "image/jpeg": {
                "schema": {
                  "type": "string",
                  "format": "binary",
                  "example": "image data here"
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/presentation/{uuid}": {
      "get": {
        "operationId": "presentationGet",
        "tags": [
          "Presentation"
        ],
        "summary": "Requests the details of the specified presentation.",
        "parameters": [
          {
            "in": "path",
            "required": true,
            "name": "uuid",
            "description": "The UUID of the item to look up.",
            "schema": {
              "type": "string"
            },
            "example": "3C39C433-5C18-4F51-B357-55BB870227C4"
          }
        ],
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "groups",
                    "name",
                    "has_timeline",
                    "current_location",
                    "destination"
                  ],
                  "properties": {
                    "id": {
                      "$ref": "#/paths/~1v1~1playlist~1current/get/responses/200/content/application~1json/schema"
                    },
                    "groups": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "required": [
                          "name",
                          "color",
                          "slides"
                        ],
                        "properties": {
                          "name": {
                            "type": "string",
                            "example": "Verse 1"
                          },
                          "color": {
                            "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/put/requestBody/content/application~1json/schema/properties/color"
                          },
                          "slides": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "required": [
                                "enabled",
                                "notes",
                                "text",
                                "image",
                                "label",
                                "color"
                              ],
                              "properties": {
                                "enabled": {
                                  "type": "boolean",
                                  "description": "Is this slide enabled"
                                },
                                "notes": {
                                  "type": "string",
                                  "description": "Notes to be showed along with the slide",
                                  "example": ""
                                },
                                "text": {
                                  "type": "string",
                                  "description": "Slide text",
                                  "example": "Amazing Grace\nHow sweet the sound"
                                },
                                "image": {
                                  "type": "string",
                                  "description": "Base64-encoded JPEG image data.",
                                  "example": "<ImageDataHere>"
                                },
                                "label": {
                                  "type": "string",
                                  "description": "The label for the slide",
                                  "example": "Acoustic"
                                },
                                "color": {
                                  "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/put/requestBody/content/application~1json/schema/properties/color"
                                },
                                "size": {
                                  "$ref": "#/paths/~1v1~1theme~1%7Bid%7D~1slides~1%7Btheme_slide%7D/put/requestBody/content/application~1json/schema/properties/size"
                                }
                              }
                            }
                          }
                        }
                      }
                    },
                    "has_timeline": {
                      "type": "boolean",
                      "description": "True if this presentation has an associated timeline"
                    },
                    "presentation_path": {
                      "type": "string",
                      "description": "The path to the presentation file on disk",
                      "example": "/Users/someuser/Documents/ProPresenter/Libraries/Default/Amazing Grace.pro"
                    },
                    "destination": {
                      "type": "string",
                      "description": "The presentation destination:\n  * `presentation` - Presentation layer\n  * `announcements` - Announcements layer\n",
                      "enum": [
                        "presentation",
                        "announcements"
                      ],
                      "example": "announcements",
                      "default": "presentation"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/presentation/{uuid}/trigger": {
      "get": {
        "operationId": "presentationTrigger",
        "tags": [
          "Presentation"
        ],
        "summary": "Triggers the specified presentation.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1presentation~1%7Buuid%7D/get/parameters/0"
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/presentation/{uuid}/trigger/{index}": {
      "get": {
        "operationId": "presentationTriggerCue",
        "tags": [
          "Presentation"
        ],
        "summary": "Triggers the specified cue inside the specified presentation.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1presentation~1%7Buuid%7D/get/parameters/0"
          },
          {
            "$ref": "#/paths/~1v1~1trigger~1cue~1%7Bindex%7D/get/parameters/0"
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/presentation/active/timeline/{operation}": {
      "get": {
        "operationId": "presentationActiveTimelineOperation",
        "tags": [
          "Presentation"
        ],
        "summary": "Performs the requested timeline operation for the active presentation.",
        "parameters": [
          {
            "in": "path",
            "required": true,
            "name": "operation",
            "description": "The operation to perform on the timeline",
            "schema": {
              "type": "string",
              "enum": [
                "play",
                "pause",
                "rewind"
              ]
            }
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/presentation/focused/timeline/{operation}": {
      "get": {
        "operationId": "presentationFocusedTimelineOperation",
        "tags": [
          "Presentation"
        ],
        "summary": "Performs the requested timeline operation for the currently active presentation (play, pause, rewind).",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1presentation~1active~1timeline~1%7Boperation%7D/get/parameters/0"
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/presentation/{uuid}/timeline/{operation}": {
      "get": {
        "operationId": "presentationTimelineOperation",
        "tags": [
          "Presentation"
        ],
        "summary": "Performs the requested timeline operation for the specified presentation (play, pause, rewind).",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1presentation~1%7Buuid%7D/get/parameters/0"
          },
          {
            "$ref": "#/paths/~1v1~1presentation~1active~1timeline~1%7Boperation%7D/get/parameters/0"
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/presentation/{uuid}/thumbnail/{index}": {
      "get": {
        "operationId": "presentationThumbnailGet",
        "tags": [
          "Presentation"
        ],
        "summary": "Requests a thumbnail image of the specified cue inside the specified presentation at the given quality value.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1presentation~1%7Buuid%7D/get/parameters/0"
          },
          {
            "$ref": "#/paths/~1v1~1trigger~1cue~1%7Bindex%7D/get/parameters/0"
          },
          {
            "$ref": "#/paths/~1v1~1mask~1%7Bid%7D~1thumbnail/get/parameters/1"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/paths/~1v1~1mask~1%7Bid%7D~1thumbnail/get/responses/200"
          },
          "403": {
            "description": "The request was not authorized."
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/props": {
      "get": {
        "operationId": "propGetAll",
        "tags": [
          "Prop"
        ],
        "summary": "Gets a list of all the props.",
        "parameters": [
          {
            "in": "query",
            "required": false,
            "name": "chunked",
            "description": "Turns this request into a streaming chunked response. Each chunk returned by the endpoint\nis equal to the standard response. Each time the data updates, a chunk will be sent, until\nthe connection is closed.\n\nMost browsers can only handle 5-6 open connections per page. If more connections than\nthis are required, use the [/v1/status/updates](#/Status/statusUpdatesGet) endpoint, which functions as an aggregator\nallowing the data from multiple endpoints to be consolidated into one.\n",
            "schema": {
              "type": "boolean"
            },
            "default": false
          }
        ],
        "responses": {
          "200": {
            "description": "The request was completed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "description": "The list of all the defined props.",
                  "items": {
                    "$ref": "#/paths/~1v1~1prop~1%7Bid%7D/get/responses/200/content/application~1json/schema"
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/prop/{id}": {
      "get": {
        "operationId": "propGet",
        "tags": [
          "Prop"
        ],
        "summary": "Requests the details of the specified prop.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
          }
        ],
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "id"
                  ],
                  "properties": {
                    "id": {
                      "$ref": "#/paths/~1v1~1playlist~1current/get/responses/200/content/application~1json/schema"
                    },
                    "is_active": {
                      "type": "boolean",
                      "description": "`true` if the prop is currently active (triggered), `false` otherwise\n"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      },
      "delete": {
        "operationId": "propDelete",
        "tags": [
          "Prop"
        ],
        "summary": "Deletes the specified prop.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/prop/{id}/trigger": {
      "get": {
        "operationId": "propTrigger",
        "tags": [
          "Prop"
        ],
        "summary": "Triggers the specified prop.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "400": {
            "$ref": "#/paths/~1v1~1looks/post/responses/400"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/prop/{id}/clear": {
      "get": {
        "operationId": "propClear",
        "tags": [
          "Prop"
        ],
        "summary": "Clears the specified prop.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "400": {
            "$ref": "#/paths/~1v1~1looks/post/responses/400"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/prop/{id}/thumbnail": {
      "get": {
        "operationId": "propThumbnailGet",
        "tags": [
          "Prop"
        ],
        "summary": "Requests a thumbnail image of the specified prop at the given quality value.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
          },
          {
            "$ref": "#/paths/~1v1~1mask~1%7Bid%7D~1thumbnail/get/parameters/1"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/paths/~1v1~1mask~1%7Bid%7D~1thumbnail/get/responses/200"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/stage/message": {
      "get": {
        "operationId": "stageMessageGet",
        "tags": [
          "Stage"
        ],
        "summary": "Requests the currently active stage message.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1props/get/parameters/0"
          }
        ],
        "responses": {
          "200": {
            "description": "The response was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string",
                  "description": "The current stage message",
                  "example": "Hello World"
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      },
      "put": {
        "operationId": "stageMessageShow",
        "tags": [
          "Stage"
        ],
        "summary": "Shows the specified stage message on the configured stage screen.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "string",
                "description": "The message to show on the stage screens",
                "example": "Your message here"
              }
            }
          }
        },
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "400": {
            "$ref": "#/paths/~1v1~1looks/post/responses/400"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      },
      "delete": {
        "operationId": "stageMessageHide",
        "tags": [
          "Stage"
        ],
        "summary": "Hides the currently displayed stage message from the configured stage screen.",
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/stage/layout_map": {
      "get": {
        "operationId": "stageLayoutMapGet",
        "tags": [
          "Stage"
        ],
        "summary": "Requests the currently selected stage layout for each configured stage screen.",
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/paths/~1v1~1stage~1layout_map/put/requestBody/content/application~1json/schema"
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      },
      "put": {
        "operationId": "stageLayoutMapSet",
        "tags": [
          "Stage"
        ],
        "summary": "Sets the specified stage message to the corresponding stage screens.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "screen",
                    "layout"
                  ],
                  "properties": {
                    "screen": {
                      "$ref": "#/paths/~1v1~1playlist~1current/get/responses/200/content/application~1json/schema"
                    },
                    "layout": {
                      "$ref": "#/paths/~1v1~1playlist~1current/get/responses/200/content/application~1json/schema"
                    }
                  }
                }
              },
              "examples": {
                "set_layouts_by_name": {
                  "summary": "Setting layouts by name",
                  "value": [
                    {
                      "screen": {
                        "name": "Side Screen"
                      },
                      "layout": {
                        "name": "Sermon Notes"
                      }
                    }
                  ]
                },
                "set_layouts_by_index": {
                  "summary": "Setting layouts by index",
                  "value": [
                    {
                      "screen": {
                        "index": 3
                      },
                      "layout": {
                        "index": 7
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "400": {
            "$ref": "#/paths/~1v1~1looks/post/responses/400"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/stage/screens": {
      "get": {
        "operationId": "stageScreensGet",
        "tags": [
          "Stage"
        ],
        "summary": "Requests a list of the configured stage screens.",
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/paths/~1v1~1playlist~1current/get/responses/200/content/application~1json/schema"
                  },
                  "example": [
                    {
                      "id": {
                        "name": "Stage Left",
                        "index": 0,
                        "uuid": "BB6E8C3A-8182-4818-8D57-38B1D85333A9"
                      }
                    },
                    {
                      "id": {
                        "name": "Stage Right",
                        "index": 1,
                        "uuid": "D2BAE32A-CDE2-4166-BA5C-2276D51EEFB8"
                      }
                    }
                  ]
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/stage/screen/{id}/layout": {
      "get": {
        "operationId": "stageScreenLayoutGet",
        "tags": [
          "Stage"
        ],
        "summary": "Requests the current stage layout for the specified stage screen.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
          }
        ],
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "content": {
                  "schema": {
                    "$ref": "#/paths/~1v1~1playlist~1current/get/responses/200/content/application~1json/schema"
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/stage/screen/{id}/layout/{layout_id}": {
      "get": {
        "operationId": "stageScreenLayoutSet",
        "tags": [
          "Stage"
        ],
        "summary": "Sets the specified stage layout for the specified stage screen.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
          },
          {
            "in": "path",
            "required": true,
            "name": "layout_id",
            "description": "The ID of the stage layout to set, either name, index or UUID.",
            "schema": {
              "type": "string"
            },
            "examples": {
              "by_name": {
                "summary": "Match item by name",
                "value": "Item Name"
              },
              "by_index": {
                "summary": "Match item by index",
                "value": "3"
              },
              "by_uuid": {
                "summary": "Match item by UUID",
                "value": "3C39C433-5C18-4F51-B357-55BB870227C4"
              }
            }
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/stage/layouts": {
      "get": {
        "operationId": "stageLayoutsGet",
        "tags": [
          "Stage"
        ],
        "summary": "Requests a list of the configured stage layouts.",
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "id"
                    ],
                    "properties": {
                      "id": {
                        "$ref": "#/paths/~1v1~1playlist~1current/get/responses/200/content/application~1json/schema"
                      }
                    }
                  },
                  "example": [
                    {
                      "id": {
                        "name": "Current/Next Stacked - Music",
                        "index": 0,
                        "uuid": "4D542943-6CF2-4BEE-A625-7C37B79D8EEF"
                      }
                    },
                    {
                      "id": {
                        "name": "Main Screen Preview",
                        "index": 1,
                        "uiuid": "D2BAE32A-CDE2-4166-BA5C-2276D51EEFB8"
                      }
                    }
                  ]
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/stage/layout/{id}": {
      "delete": {
        "operationId": "stageLayoutDelete",
        "tags": [
          "Stage"
        ],
        "summary": "Deletes the specified stage layout.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/stage/layout/{id}/thumbnail": {
      "get": {
        "operationId": "stageLayoutThumbnailGet",
        "tags": [
          "Stage"
        ],
        "summary": "Requests a thumbnail image of the specified stage layout at the given quality value.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
          },
          {
            "$ref": "#/paths/~1v1~1mask~1%7Bid%7D~1thumbnail/get/parameters/1"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/paths/~1v1~1mask~1%7Bid%7D~1thumbnail/get/responses/200"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/version": {
      "get": {
        "operationId": "versionGet",
        "tags": [
          "Status"
        ],
        "summary": "Requests the general information about the currently active ProPresenter instance.",
        "responses": {
          "200": {
            "description": "The response was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "name",
                    "platform",
                    "os_version",
                    "host_description",
                    "api_version"
                  ],
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "Human-readable name representing the machine",
                      "example": "Main sanctuary Pro7 machine"
                    },
                    "platform": {
                      "type": "string",
                      "description": "The platform that ProPresenter is running on\n* `win`- Windows\n* `mac` - macOS\n* `unknown` - Unknown platform\n",
                      "enum": [
                        "win",
                        "mac",
                        "unknown"
                      ]
                    },
                    "os_version": {
                      "type": "string",
                      "description": "Version of the operating system.",
                      "example": "10.0.19043"
                    },
                    "host_description": {
                      "type": "string",
                      "description": "Description of the host machine",
                      "example": "ProPresenter 7.8.1"
                    },
                    "api_version": {
                      "type": "string",
                      "description": "Version of the API supported by this machine",
                      "example": "v1"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The receiving machine does not have Network enabled or the requested path was not found."
          }
        }
      }
    },
    "/v1/status/layers": {
      "get": {
        "operationId": "layerStatusGet",
        "tags": [
          "Status"
        ],
        "summary": "Requests the status of all available layers.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1props/get/parameters/0"
          }
        ],
        "responses": {
          "200": {
            "description": "The response was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "video_input",
                    "media",
                    "slide",
                    "announcements",
                    "props",
                    "messaages",
                    "audio"
                  ],
                  "properties": {
                    "video_input": {
                      "type": "boolean",
                      "description": "`true` if the layer is currently active, `false` otherwise\n"
                    },
                    "media": {
                      "type": "boolean",
                      "description": "`true` if the layer is currently active, `false` otherwise\n"
                    },
                    "slide": {
                      "type": "boolean",
                      "description": "`true` if the layer is currently active, `false` otherwise\n"
                    },
                    "announcements": {
                      "type": "boolean",
                      "description": "`true` if the layer is currently active, `false` otherwise\n"
                    },
                    "props": {
                      "type": "boolean",
                      "description": "`true` if the layer is currently active, `false` otherwise\n"
                    },
                    "messages": {
                      "type": "boolean",
                      "description": "`true` if the layer is currently active, `false` otherwise\n"
                    },
                    "audio": {
                      "type": "boolean",
                      "description": "`true` if the layer is currently active, `false` otherwise\n"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/status/stage_screens": {
      "get": {
        "operationId": "stageScreensStatusGet",
        "tags": [
          "Status"
        ],
        "summary": "Requests the status of the stage screens.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1props/get/parameters/0"
          }
        ],
        "responses": {
          "200": {
            "description": "The response was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "boolean",
                  "description": "`true` if the stage screens are enabled, `false` otherwise."
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      },
      "put": {
        "operationId": "stageScreensStatusSet",
        "tags": [
          "Status"
        ],
        "summary": "Sets the status of the stage screens.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "boolean",
                "description": "`true` to enable the stage screens, `false` otherwise."
              }
            }
          }
        },
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/status/audience_screens": {
      "get": {
        "operationId": "audienceScreensStatusGet",
        "tags": [
          "Status"
        ],
        "summary": "Requests the status of the audience screens.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1props/get/parameters/0"
          }
        ],
        "responses": {
          "200": {
            "description": "The response was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "boolean",
                  "description": "`true` if the audience screens are enabled, `false` otherwise."
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      },
      "put": {
        "operationId": "audienceScreensStatusSet",
        "tags": [
          "Status"
        ],
        "summary": "Sets the status of the audience screens.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "boolean",
                "description": "`true` to enable the audience screens, `false` otherwise."
              }
            }
          }
        },
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/status/screens": {
      "get": {
        "operationId": "statusScreensGet",
        "tags": [
          "Status"
        ],
        "summary": "Requests the details of all configured screens.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1props/get/parameters/0"
          }
        ],
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "id",
                      "size",
                      "screen_type"
                    ],
                    "properties": {
                      "id": {
                        "$ref": "#/paths/~1v1~1playlist~1current/get/responses/200/content/application~1json/schema"
                      },
                      "size": {
                        "$ref": "#/paths/~1v1~1theme~1%7Bid%7D~1slides~1%7Btheme_slide%7D/put/requestBody/content/application~1json/schema/properties/size"
                      },
                      "screen_type": {
                        "type": "string",
                        "description": "The type of screen this item represents, audience or stage display.",
                        "enum": [
                          "audience",
                          "stage"
                        ]
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/status/slide": {
      "get": {
        "operationId": "slideStatusGet",
        "tags": [
          "Status"
        ],
        "summary": "Requests the current/next slide text and image UUIDs.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1props/get/parameters/0"
          }
        ],
        "responses": {
          "200": {
            "description": "The response was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "current": {
                      "$ref": "#/paths/~1v1~1status~1slide/get/responses/200/content/application~1json/schema/properties/next"
                    },
                    "next": {
                      "type": "object",
                      "required": [
                        "text",
                        "notes",
                        "uuid"
                      ],
                      "properties": {
                        "text": {
                          "type": "string",
                          "description": "The text of the slide.",
                          "example": "Amazing Grace, how sweet the sound\nThat saved a wretch like me."
                        },
                        "notes": {
                          "type": "string",
                          "description": "Any notes associated with the slide.",
                          "example": "Start quiet, leave open."
                        },
                        "uuid": {
                          "type": "string",
                          "description": "The UUID of the slide, used when requesting slide images.",
                          "example": "1C43092A-B254-45F0-8F8A-9A8FEE26F4DE"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "current": {
                    "text": "Amazing Grace, how sweet the sound\nThat saved a wretch like me.",
                    "notes": "Start quiet, leave open",
                    "uuid": "1C43092A-B254-45F0-8F8A-9A8FEE26F4DE"
                  },
                  "next": {
                    "text": "I once was lost, but now I'm found\nWas blind, but now I see.",
                    "notes": "Build from last chord",
                    "uuid": "242BAEBB-FAC5-4B7B-A19D-F4C09A66D711"
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/status/updates": {
      "post": {
        "operationId": "statusUpdatesGet",
        "tags": [
          "Status"
        ],
        "summary": "Aggregates the data from one or more streaming endpoints into a single streaming endpoint.",
        "description": "This endpoint is used to overcome a browser limit on the number of concurrent connections allowed. The following\nendpoints are permitted here:\n  * [audio/playlist/{id}/updates](#/Audio/audioPlaylistUpdateGet)\n  * [capture/status](#/Capture/captureStatusGet)\n  * [library/{id}](#/Library/libraryGet)\n  * [look/current](#/Looks/lookGetCurrent)\n  * [media/playlist/{id}/updates](#/Media/mediaPlaylistUpdateGet)\n  * [messages](#/Message/messageGetAll)\n  * [playlist/current](#/Playlist/playlistCurrentGet)\n  * [presentation/current](#/Presentation/presentationGetCurrent)\n  * [presentation/slide_index](#/Presentation/presentationGetSlideIndex)\n  * [stage/message](#/Stage/stageMessageGet)\n  * [status/layers](#/Status/layerStatusGet)\n  * [status/stage_screens](#/Status/stageScreensStatusGet)\n  * [status/audience_screens](#/Status/audienceScreensStatusGet)\n  * [status/screens](#/Status/statusScreensGet)\n  * [status/slide](#/Status/slideStatusGet)\n  * [timers](#/Timer/timerGetAll)\n  * [timers/current](#/Timer/timerGetCurrentTimes)\n  * [timer/system_time](#/Timer/timerGetSystemTime)\n  * [timer/video_countdown](#/Timer/timerGetVideoCountdown)\n  * [transport/{layer}/time](#/Transport/transportTimeGet)\n  * [transport/{layer}/current](#/Transport/transportCurrentMediaGet)\n\nIn particular, all (and only) GET requests that return a chunked JSON response are legal URLs.\n",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "examples": {
                "one_url": {
                  "summary": "One URL",
                  "value": [
                    "status/slide"
                  ]
                },
                "multi_urls": {
                  "summary": "Multiple URLs",
                  "value": [
                    "status/slide",
                    "timer/video_countdown",
                    "presentation/current"
                  ]
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The request was processed successfully. A stream of updates will be returned to the client as they\nbecome available. Each update is separated by a CRLF pair, so a section of data followed by a\nCR-LF-CR-LF sequence is one update. Each update is a JSON object, as below.\n",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "url": {
                      "type": "string",
                      "description": "The URL that caused this chunk of data to be sent",
                      "example": "/v1/timer/video_countdown"
                    },
                    "data": {
                      "type": {},
                      "description": "The data object that was returned by the given URL. This is in the same data format\nas the given URL returns natively.\n",
                      "example": "00:00:00"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The given request was invalid. This can be caused by a number of things:\n  * The given URL was not found.\n  * The given URL is not a streaming URL (i.e. it does not return a chunked response).\n  * The given URL does not return a JSON data type.\n\nThe response body contains a list of URLs that were not valid.\n",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "example": [
                  "/this_is_not_a_valid_url",
                  "/v1/audio/playlist/0",
                  "/v1/presentation/chord_chart"
                ]
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/themes": {
      "get": {
        "operationId": "themeGetAll",
        "tags": [
          "Theme"
        ],
        "summary": "Requests a list of all configured themes and theme slides.",
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "id"
                    ],
                    "properties": {
                      "id": {
                        "$ref": "#/paths/~1v1~1playlist~1current/get/responses/200/content/application~1json/schema"
                      },
                      "themes": {
                        "type": "array",
                        "description": "The list of themes in this group.",
                        "items": {
                          "$ref": "#/paths/~1v1~1theme~1%7Bid%7D/get/responses/200/content/application~1json/schema"
                        }
                      },
                      "groups": {
                        "type": "array",
                        "description": "The list of child groups in this group.",
                        "items": {
                          "$ref": "#/paths/~1v1~1themes/get/responses/200/content/application~1json/schema/items"
                        },
                        "example": [
                          {
                            "id": {
                              "uuid": "",
                              "name": "My Theme",
                              "index": 0
                            },
                            "groups": [],
                            "themes": [
                              {
                                "id": {
                                  "uuid": "",
                                  "name": "My Theme",
                                  "index": 0
                                },
                                "slides": [
                                  {
                                    "id": {
                                      "uuid": "ad19b83b-ee4d-4cfe-9280-220cc9330262",
                                      "name": "New Theme Slide",
                                      "index": 0
                                    },
                                    "size": {
                                      "width": 1920,
                                      "height": 1080
                                    },
                                    "background": {
                                      "red": 0,
                                      "green": 0,
                                      "blue": 0,
                                      "alpha": 1
                                    }
                                  }
                                ]
                              }
                            ]
                          },
                          {
                            "id": {
                              "uuid": "",
                              "name": "My Theme Folder",
                              "index": 1
                            },
                            "groups": [
                              {
                                "id": {
                                  "uuid": "",
                                  "name": "Theme 2",
                                  "index": 0
                                },
                                "groups": [],
                                "themes": [
                                  {
                                    "id": {
                                      "uuid": "",
                                      "name": "Theme 2",
                                      "index": 0
                                    },
                                    "slides": [
                                      {
                                        "id": {
                                          "uuid": "b86f287a-1692-4574-a739-5451da814249",
                                          "name": "New Theme Slide",
                                          "index": 0
                                        },
                                        "size": {
                                          "width": 1920,
                                          "height": 1080
                                        },
                                        "background": {
                                          "red": 0,
                                          "green": 0,
                                          "blue": 0,
                                          "alpha": 1
                                        }
                                      }
                                    ]
                                  }
                                ]
                              }
                            ],
                            "themes": []
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/theme/{id}": {
      "parameters": [
        {
          "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
        }
      ],
      "get": {
        "operationId": "themeGet",
        "tags": [
          "Theme"
        ],
        "summary": "Requests the details of the theme and theme slides.",
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "id",
                    "slides"
                  ],
                  "properties": {
                    "id": {
                      "$ref": "#/paths/~1v1~1playlist~1current/get/responses/200/content/application~1json/schema"
                    },
                    "slides": {
                      "type": "array",
                      "description": "The list of theme slides in this theme.",
                      "items": {
                        "$ref": "#/paths/~1v1~1theme~1%7Bid%7D~1slides~1%7Btheme_slide%7D/put/requestBody/content/application~1json/schema"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/theme/{id}/slides/{theme_slide}": {
      "parameters": [
        {
          "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
        },
        {
          "in": "path",
          "required": "true;",
          "name": "theme_slide",
          "description": "The ID of the required theme slide, either name, index or UUID.",
          "schema": {
            "type": "string"
          },
          "examples": {
            "by_name": {
              "summary": "Match theme slide by name",
              "value": "Item Name"
            },
            "by_index": {
              "summary": "Match theme slide by index",
              "value": "3"
            },
            "by_uuid": {
              "summary": "Match theme slide by UUID",
              "value": "3C39C433-5C18-4F51-B357-55BB870227C4"
            }
          }
        }
      ],
      "get": {
        "operationId": "themeSlideGet",
        "tags": [
          "Theme"
        ],
        "summary": "Requests the details of the specified theme slide within the specified theme.",
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/paths/~1v1~1theme~1%7Bid%7D~1slides~1%7Btheme_slide%7D/put/requestBody/content/application~1json/schema"
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      },
      "put": {
        "operationId": "themeSlideSet",
        "tags": [
          "Theme"
        ],
        "summary": "Sets the details of the specified theme slide within the specified theme.",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "id"
                ],
                "properties": {
                  "id": {
                    "$ref": "#/paths/~1v1~1playlist~1current/get/responses/200/content/application~1json/schema"
                  },
                  "size": {
                    "type": "object",
                    "required": [
                      "width",
                      "height"
                    ],
                    "properties": {
                      "width": {
                        "type": "integer",
                        "description": "The width of the slide, in pixels",
                        "example": 1920
                      },
                      "height": {
                        "type": "integer",
                        "description": "The height of the slide, in pixels",
                        "example": 1080
                      }
                    }
                  },
                  "background": {
                    "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/put/requestBody/content/application~1json/schema/properties/color"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "400": {
            "$ref": "#/paths/~1v1~1looks/post/responses/400"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/theme/{id}/slides/{theme_slide}/thumbnail": {
      "get": {
        "operationId": "themeSlideThumbnailGet",
        "tags": [
          "Theme"
        ],
        "summary": "Requests a thumbnail image of the specified theme slide at the given quality value.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
          },
          {
            "$ref": "#/paths/~1v1~1theme~1%7Bid%7D~1slides~1%7Btheme_slide%7D/parameters/1"
          },
          {
            "$ref": "#/paths/~1v1~1mask~1%7Bid%7D~1thumbnail/get/parameters/1"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/paths/~1v1~1mask~1%7Bid%7D~1thumbnail/get/responses/200"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/timers": {
      "get": {
        "operationId": "timerGetAll",
        "tags": [
          "Timer"
        ],
        "summary": "Requests the details for all configured timers.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1props/get/parameters/0"
          }
        ],
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/paths/~1v1~1timer~1%7Bid%7D/put/requestBody/content/application~1json/schema"
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      },
      "post": {
        "operationId": "timerCreate",
        "tags": [
          "Timer"
        ],
        "summary": "Creates a new timer with the specified details.",
        "description": "The newly created timer's UUID and index are returned in the response body.\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "type": "object",
                    "required": [
                      "id",
                      "allows_overrun"
                    ],
                    "properties": {
                      "name": {
                        "type": "string",
                        "description": "The user-defined name of the timer",
                        "example": "Countdown Timer"
                      },
                      "allows_overrun": {
                        "type": "boolean",
                        "description": "Whether the timer is allowed to overrun."
                      },
                      "countdown": {
                        "type": "object",
                        "required": [
                          "duration"
                        ],
                        "properties": {
                          "duration": {
                            "type": "integer",
                            "description": "Time in seconds."
                          }
                        }
                      }
                    }
                  },
                  {
                    "type": "object",
                    "required": [
                      "id",
                      "allows_overrun"
                    ],
                    "properties": {
                      "name": {
                        "type": "string",
                        "description": "The user-defined name of the timer",
                        "example": "Countdown Timer"
                      },
                      "allows_overrun": {
                        "type": "boolean",
                        "description": "Whether the timer is allowed to overrun."
                      },
                      "count_down_to_time": {
                        "required": [
                          "time_of_day",
                          "period"
                        ],
                        "type": "object",
                        "properties": {
                          "time_of_day": {
                            "type": "integer",
                            "description": "Time in seconds."
                          },
                          "period": {
                            "type": "string",
                            "enum": [
                              "am",
                              "pm",
                              "24_hour"
                            ]
                          }
                        }
                      }
                    }
                  },
                  {
                    "type": "object",
                    "required": [
                      "id",
                      "allows_overrun"
                    ],
                    "properties": {
                      "name": {
                        "type": "string",
                        "description": "The user-defined name of the timer",
                        "example": "Countdown Timer"
                      },
                      "allows_overrun": {
                        "type": "boolean",
                        "description": "Whether the timer is allowed to overrun."
                      },
                      "elapsed": {
                        "required": [
                          "start_time"
                        ],
                        "type": "object",
                        "properties": {
                          "start_time": {
                            "type": "integer",
                            "description": "Time in seconds."
                          },
                          "end_time": {
                            "type": "integer",
                            "nullable": true,
                            "description": "Time in seconds. Omit to specify unlimited end time."
                          }
                        }
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/paths/~1v1~1timer~1%7Bid%7D/put/requestBody/content/application~1json/schema"
                }
              }
            }
          },
          "400": {
            "$ref": "#/paths/~1v1~1looks/post/responses/400"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/timers/current": {
      "get": {
        "operationId": "timerGetCurrentTimes",
        "tags": [
          "Timer"
        ],
        "summary": "Requests the current time for all configured timers.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1props/get/parameters/0"
          }
        ],
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "$ref": "#/paths/~1v1~1playlist~1current/get/responses/200/content/application~1json/schema"
                      },
                      "time": {
                        "type": "string",
                        "description": "The current time for the timer",
                        "example": "00:00:01.00"
                      },
                      "is_active": {
                        "type": "boolean",
                        "description": "If the timer is currently running"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/timers/{operation}": {
      "get": {
        "operationId": "timerOperationAll",
        "tags": [
          "Timer"
        ],
        "summary": "Performs the requested operation for all configured timers (start, stop, reset).",
        "parameters": [
          {
            "in": "path",
            "required": true,
            "name": "operation",
            "description": "The operation to perform on the timer",
            "schema": {
              "type": "string",
              "enum": [
                "start",
                "stop",
                "reset"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/timer/{id}": {
      "get": {
        "operationId": "timerGet",
        "tags": [
          "Timer"
        ],
        "summary": "Requests the details of the specified timer.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
          }
        ],
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/paths/~1v1~1timer~1%7Bid%7D/put/requestBody/content/application~1json/schema"
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      },
      "put": {
        "operationId": "timerSet",
        "tags": [
          "Timer"
        ],
        "summary": "Sets the details of the specified timer.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "type": "object",
                    "required": [
                      "id",
                      "allows_overrun"
                    ],
                    "properties": {
                      "id": {
                        "$ref": "#/paths/~1v1~1playlist~1current/get/responses/200/content/application~1json/schema"
                      },
                      "allows_overrun": {
                        "type": "boolean",
                        "description": "Whether the timer is allowed to overrun."
                      },
                      "countdown": {
                        "type": "object",
                        "required": [
                          "duration"
                        ],
                        "properties": {
                          "duration": {
                            "type": "integer",
                            "description": "Time in seconds."
                          }
                        }
                      }
                    }
                  },
                  {
                    "type": "object",
                    "required": [
                      "id",
                      "allows_overrun"
                    ],
                    "properties": {
                      "id": {
                        "$ref": "#/paths/~1v1~1playlist~1current/get/responses/200/content/application~1json/schema"
                      },
                      "allows_overrun": {
                        "type": "boolean",
                        "description": "Whether the timer is allowed to overrun."
                      },
                      "count_down_to_time": {
                        "required": [
                          "time_of_day",
                          "period"
                        ],
                        "type": "object",
                        "properties": {
                          "time_of_day": {
                            "type": "integer",
                            "description": "Time in seconds."
                          },
                          "period": {
                            "type": "string",
                            "enum": [
                              "am",
                              "pm",
                              "24_hour"
                            ]
                          }
                        }
                      }
                    }
                  },
                  {
                    "type": "object",
                    "required": [
                      "id",
                      "allows_overrun"
                    ],
                    "properties": {
                      "id": {
                        "$ref": "#/paths/~1v1~1playlist~1current/get/responses/200/content/application~1json/schema"
                      },
                      "allows_overrun": {
                        "type": "boolean",
                        "description": "Whether the timer is allowed to overrun."
                      },
                      "elapsed": {
                        "required": [
                          "start_time"
                        ],
                        "type": "object",
                        "properties": {
                          "start_time": {
                            "type": "integer",
                            "description": "Time in seconds."
                          },
                          "end_time": {
                            "type": "integer",
                            "nullable": true,
                            "description": "Time in seconds. Omit to specify unlimited end time."
                          }
                        }
                      }
                    }
                  }
                ]
              },
              "examples": {
                "set_configuration_countdown": {
                  "summary": "Countdown configuration",
                  "value": {
                    "id": {
                      "uuid": "942C3FC3-C4B2-44F7-A55D-4CC913BB8A5D",
                      "name": "Timer 1",
                      "index": 0
                    },
                    "allows_overrun": true,
                    "countdown": {
                      "duration": 300
                    }
                  }
                },
                "set_configuration_countdown_to_time": {
                  "summary": "Countdown to time configuration",
                  "value": {
                    "id": {
                      "uuid": "942C3FC3-C4B2-44F7-A55D-4CC913BB8A5D",
                      "name": "Timer 1",
                      "index": 0
                    },
                    "allows_overrun": true,
                    "count_down_to_time": {
                      "time_of_day": 3600,
                      "period": "pm"
                    }
                  }
                },
                "set_configuration_elapsed": {
                  "summary": "Elapsed configuration",
                  "value": {
                    "id": {
                      "uuid": "942C3FC3-C4B2-44F7-A55D-4CC913BB8A5D",
                      "name": "Timer 1",
                      "index": 0
                    },
                    "allows_overrun": true,
                    "elapsed": {
                      "start_time": 0,
                      "end_time": 120
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/paths/~1v1~1timer~1%7Bid%7D/put/requestBody/content/application~1json/schema"
                }
              }
            }
          },
          "400": {
            "$ref": "#/paths/~1v1~1looks/post/responses/400"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      },
      "delete": {
        "operationId": "timerDelete",
        "tags": [
          "Timer"
        ],
        "summary": "Deletes the specified timer.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/timer/{id}/{operation}": {
      "get": {
        "operationId": "timerOperation",
        "tags": [
          "Timer"
        ],
        "summary": "Performs the requested operation on the specified timer (start, stop, reset).",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
          },
          {
            "$ref": "#/paths/~1v1~1timers~1%7Boperation%7D/get/parameters/0"
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/timer/system_time": {
      "get": {
        "operationId": "timerGetSystemTime",
        "tags": [
          "Timer"
        ],
        "summary": "Requests the current system time.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1props/get/parameters/0"
          }
        ],
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "integer",
                  "description": "The current system time defined as seconds since midnight, 1st January 1970.",
                  "example": 1628029541
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/timer/video_countdown": {
      "get": {
        "operationId": "timerGetVideoCountdown",
        "tags": [
          "Timer"
        ],
        "summary": "Requests the current value of the video countdown timer.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1props/get/parameters/0"
          }
        ],
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string",
                  "example": "00:00:01.00"
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/transport/{layer}/play": {
      "get": {
        "operationId": "transportPlay",
        "tags": [
          "Transport"
        ],
        "summary": "Plays the content on the specified layer (presentation, announcement, audio).",
        "parameters": [
          {
            "in": "path",
            "required": true,
            "name": "layer",
            "description": "The layer to perform the transport operation on",
            "schema": {
              "type": "string",
              "enum": [
                "presentation",
                "announcement",
                "audio"
              ]
            }
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/transport/{layer}/pause": {
      "get": {
        "operationId": "transportPause",
        "tags": [
          "Transport"
        ],
        "summary": "Pauses the content on the specified layer (presentation, announcement, audio).",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1transport~1%7Blayer%7D~1play/get/parameters/0"
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/transport/{layer}/skip_backward/{time}": {
      "get": {
        "operationId": "transportSkipBackward",
        "tags": [
          "Transport"
        ],
        "summary": "Moves backward in the content on the specified layer by the specified number of seconds (presentation, announcement, audio).",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1transport~1%7Blayer%7D~1play/get/parameters/0"
          },
          {
            "$ref": "#/paths/~1v1~1transport~1%7Blayer%7D~1skip_forward~1%7Btime%7D/get/parameters/1"
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "400": {
            "$ref": "#/paths/~1v1~1looks/post/responses/400"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/transport/{layer}/skip_forward/{time}": {
      "get": {
        "operationId": "transportSkipForward",
        "tags": [
          "Transport"
        ],
        "summary": "Moves forward in the content on the specified layer by the specified number of seconds (presentation, announcement, audio).",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1transport~1%7Blayer%7D~1play/get/parameters/0"
          },
          {
            "in": "path",
            "required": true,
            "name": "time",
            "description": "The time component of the request, in seconds",
            "schema": {
              "type": "integer",
              "example": 15
            }
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "400": {
            "$ref": "#/paths/~1v1~1looks/post/responses/400"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/transport/{layer}/go_to_end": {
      "get": {
        "operationId": "transportGoToEnd",
        "tags": [
          "Transport"
        ],
        "summary": "Moves to the end on a certain layer",
        "description": "Moves to the end in the content on the specified layer or moves the specified number of seconds away from the end in the content on the specified layer (presentation, announcement, audio).",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1transport~1%7Blayer%7D~1play/get/parameters/0"
          },
          {
            "in": "query",
            "required": false,
            "name": "time",
            "description": "The time component of the request, in seconds",
            "schema": {
              "type": "integer",
              "example": 15
            }
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "400": {
            "$ref": "#/paths/~1v1~1looks/post/responses/400"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/transport/{layer}/time": {
      "get": {
        "operationId": "transportTimeGet",
        "tags": [
          "Transport"
        ],
        "summary": "Requests the current transport time for the specified layer (presentation, announcement, audio).",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1transport~1%7Blayer%7D~1play/get/parameters/0"
          },
          {
            "$ref": "#/paths/~1v1~1props/get/parameters/0"
          }
        ],
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "number",
                  "description": "The current transport time in seconds."
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      },
      "put": {
        "operationId": "transportTimeSet",
        "tags": [
          "Transport"
        ],
        "summary": "Moves to the specified time for the specified layer (presentation, announcement, audio).",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1transport~1%7Blayer%7D~1play/get/parameters/0"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "integer",
                "description": "The time in seconds to move to."
              }
            }
          }
        },
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "400": {
            "$ref": "#/paths/~1v1~1looks/post/responses/400"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/transport/{layer}/auto_advance": {
      "parameters": [
        {
          "in": "path",
          "required": true,
          "name": "layer",
          "description": "The layer to perform the transport operation on",
          "schema": {
            "type": "string",
            "enum": [
              "presentation",
              "announcement"
            ]
          }
        }
      ],
      "get": {
        "operationId": "transportAutoAdvanceGet",
        "tags": [
          "Transport"
        ],
        "summary": "Requests the auto-advance status for the specified layer (presentation, announcement).",
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "boolean",
                  "description": "`true` if auto-advance is enabled, `false` otherwise.\n"
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      },
      "delete": {
        "operationId": "transportAutoAdvanceCancel",
        "tags": [
          "Transport"
        ],
        "summary": "Cancels the auto-advance for the specified layer (presentation, announcement).",
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "400": {
            "$ref": "#/paths/~1v1~1looks/post/responses/400"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/transport/{layer}/current": {
      "get": {
        "operationId": "transportCurrentMediaGet",
        "tags": [
          "Transport"
        ],
        "summary": "Requests the details of the currently playing content for the specified layer (presentation, announcement, audio).",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1transport~1%7Blayer%7D~1play/get/parameters/0"
          },
          {
            "$ref": "#/paths/~1v1~1props/get/parameters/0"
          }
        ],
        "responses": {
          "200": {
            "description": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "is_playing",
                    "uuid",
                    "name",
                    "artist",
                    "audio_only",
                    "length"
                  ],
                  "properties": {
                    "is_playing": {
                      "type": "boolean",
                      "description": "`true` if media is currently playing, `false` otherwise.\n"
                    },
                    "uuid": {
                      "type": "string",
                      "description": "The UUID of the media item",
                      "example": "942C3FC3-C4B2-44F7-A55D-4CC913BB8A5D"
                    },
                    "name": {
                      "type": "string",
                      "description": "The media name.",
                      "example": "Amazing Grace"
                    },
                    "artist": {
                      "type": "string",
                      "nullable": true,
                      "description": "The media artist.",
                      "example": "John Newton"
                    },
                    "audio_only": {
                      "type": "boolean",
                      "description": "`true` if the item is audio-only, `false` otherwise\n"
                    },
                    "duration": {
                      "type": "number",
                      "description": "The length of the media in seconds",
                      "example": 112.5
                    }
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/trigger/cue/{index}": {
      "get": {
        "operationId": "triggerCue",
        "tags": [
          "Trigger"
        ],
        "summary": "Triggers the specified cue in the currently active playlist item.",
        "parameters": [
          {
            "in": "path",
            "required": true,
            "name": "index",
            "description": "The index of the cue to use. Respects the selected arrangement of cues.",
            "schema": {
              "type": "integer"
            },
            "example": 0
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "400": {
            "$ref": "#/paths/~1v1~1looks/post/responses/400"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/trigger/playlist/{playlist_id}/{item_id}/{cue_index}": {
      "get": {
        "operationId": "triggerPlaylist",
        "tags": [
          "Trigger"
        ],
        "summary": "Triggers the specified cue in the specified item in the specified playlist.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1playlist~1%7Bplaylist_id%7D/parameters/0"
          },
          {
            "$ref": "#/paths/~1v1~1trigger~1media~1%7Bplaylist_id%7D~1%7Bitem_id%7D/get/parameters/1"
          },
          {
            "in": "path",
            "required": true,
            "name": "cue_index",
            "description": "The index of the cue (slide) to use. Respects the selected arrangement of cues. For media playlist items pass 0 here.",
            "schema": {
              "type": "integer"
            },
            "example": 0
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "400": {
            "$ref": "#/paths/~1v1~1looks/post/responses/400"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/trigger/media/{playlist_id}/{item_id}": {
      "get": {
        "operationId": "triggerMedia",
        "tags": [
          "Trigger"
        ],
        "summary": "Triggers the specified media item in the specified media playlist.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1playlist~1%7Bplaylist_id%7D/parameters/0"
          },
          {
            "in": "path",
            "required": true,
            "name": "item_id",
            "description": "The ID of the item within a playlist, either UUID, name, or index, in order of interpretation and search priority.",
            "schema": {
              "type": "string"
            },
            "examples": {
              "by_uuid": {
                "summary": "Match item by UUID",
                "value": "3C39C433-5C18-4F51-B357-55BB870227C4"
              },
              "by_name": {
                "summary": "Match item by name",
                "value": "Presentation Name"
              },
              "by_index": {
                "summary": "Match item by index",
                "value": 3
              }
            }
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "400": {
            "$ref": "#/paths/~1v1~1looks/post/responses/400"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/trigger/media/next": {
      "get": {
        "operationId": "triggerMediaNext",
        "tags": [
          "Trigger"
        ],
        "summary": "Triggers the next item in the currently active media playlist.",
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/trigger/media/previous": {
      "get": {
        "operationId": "triggerMediaPrevious",
        "tags": [
          "Trigger"
        ],
        "summary": "Triggers the previous item in the currently active media playlist.",
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/trigger/audio/{playlist_id}/{item_id}": {
      "get": {
        "operationId": "triggerAudio",
        "tags": [
          "Trigger"
        ],
        "summary": "Triggers the specified audio item in the specified audio playlist.",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1playlist~1%7Bplaylist_id%7D/parameters/0"
          },
          {
            "$ref": "#/paths/~1v1~1trigger~1media~1%7Bplaylist_id%7D~1%7Bitem_id%7D/get/parameters/1"
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "400": {
            "$ref": "#/paths/~1v1~1looks/post/responses/400"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/trigger/audio/next": {
      "get": {
        "operationId": "triggerAudioNext",
        "tags": [
          "Trigger"
        ],
        "summary": "Triggers the next item in the currently active audio playlist.",
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/trigger/audio/previous": {
      "get": {
        "operationId": "triggerAudioPrevious",
        "tags": [
          "Trigger"
        ],
        "summary": "Triggers the previous item in the currently active audio playlist.",
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/trigger/video_input/{id}": {
      "get": {
        "operationId": "triggerVideoInput",
        "tags": [
          "Trigger"
        ],
        "summary": "Triggers the specified video input in the video input playlist.",
        "description": "Video input sources must be added to the Video Input playlist in the Media Bin in order to be triggered with this endpoint.\n",
        "parameters": [
          {
            "$ref": "#/paths/~1v1~1macro~1%7Bid%7D/parameters/0"
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "400": {
            "$ref": "#/paths/~1v1~1looks/post/responses/400"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/trigger/library/{library_id}/{presentation_id}/{index}": {
      "get": {
        "operationId": "triggerLibrary",
        "tags": [
          "Trigger"
        ],
        "summary": "Triggers the specified slide in the specified presentation in the specified library.",
        "parameters": [
          {
            "in": "path",
            "required": true,
            "name": "library_id",
            "description": "The ID of the library, either UUID, name, or index, in order of interpretation and search priority.",
            "schema": {
              "type": "string"
            },
            "examples": {
              "by_uuid": {
                "summary": "Match library by UUID",
                "value": "3C39C433-5C18-4F51-B357-55BB870227C4"
              },
              "by_name": {
                "summary": "Match library by name",
                "value": "Library Name"
              },
              "by_index": {
                "summary": "Match library by index",
                "value": "3"
              }
            }
          },
          {
            "in": "path",
            "required": true,
            "name": "presentation_id",
            "description": "The ID of the presentation, either UUID, name, or index, in order of interpretation and search priority.",
            "schema": {
              "type": "string"
            },
            "examples": {
              "by_uuid": {
                "summary": "Match presentation by UUID",
                "value": "3C39C433-5C18-4F51-B357-55BB870227C4"
              },
              "by_name": {
                "summary": "Match presentation by name",
                "value": "Presentation Name"
              },
              "by_index": {
                "summary": "Match presentation by index",
                "value": "3"
              }
            }
          },
          {
            "$ref": "#/paths/~1v1~1trigger~1cue~1%7Bindex%7D/get/parameters/0"
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "400": {
            "$ref": "#/paths/~1v1~1looks/post/responses/400"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/trigger/next": {
      "get": {
        "operationId": "triggerNext",
        "tags": [
          "Trigger"
        ],
        "summary": "Triggers the next cue or item in the currently active playlist or library.",
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/trigger/previous": {
      "get": {
        "operationId": "triggerPrevious",
        "tags": [
          "Trigger"
        ],
        "summary": "Triggers the previous cue or item in the currently active playlist or library.",
        "responses": {
          "204": {
            "$ref": "#/paths/~1v1~1look~1current/put/responses/204"
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    },
    "/v1/video_inputs": {
      "get": {
        "operationId": "videoInputsGet",
        "tags": [
          "Video Input"
        ],
        "summary": "Requests a list of the configured and triggerable video inputs.",
        "description": "Triggerable video inputs come from the Video Inputs playlist in the Media Bin. Once the video input is added there it can be triggered with GET /v1/trigger/video_input/{id}\n",
        "responses": {
          "200": {
            "summary": "The request was processed successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/paths/~1v1~1playlist~1current/get/responses/200/content/application~1json/schema"
                  }
                }
              }
            }
          },
          "404": {
            "$ref": "#/paths/~1version/get/responses/404"
          }
        }
      }
    }
  }
}