> For the complete documentation index, see [llms.txt](https://docs.podplay.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.podplay.app/api/replay-servers.md).

# Replay Servers

## GET /replay-servers

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Replay Servers"}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ReplayServerCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ReplayServerDto"}},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_pagination","_links"]},"ReplayServerDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"},"_links":{"description":"A `LinksDto` structure containing URL references to propertes that can be expanded","allOf":[{"$ref":"#/components/schemas/LinksDto"}]},"deviceId":{"type":"string","description":"Unique device identifier","readOnly":true},"hostname":{"type":"string","description":"Device hostname"},"version":{"type":"string","description":"Software version running on the device"},"displayName":{"type":"string","description":"Display name for the server"},"status":{"type":"string","description":"Status of the server","enum":["PENDING","APPROVED","REVOKED"],"readOnly":true},"area":{"description":"Area the server is assigned to","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"approvedDate":{"format":"date-time","type":"string","description":"When the device was approved"},"approvedByUser":{"description":"User who approved the server","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"lastSeenDate":{"format":"date-time","type":"string","description":"When the device was last seen"},"lastSeenIp":{"type":"string","description":"IP address of last request"},"config":{"description":"Server configuration (cameras, paths, etc)","allOf":[{"$ref":"#/components/schemas/ReplayServerConfigDto"}]},"targetVersion":{"type":"string","description":"Target software version for this server"},"serverUrl":{"type":"string","description":"External DDNS or URL where this server is reachable"},"localIp":{"type":"string","description":"Local network IP address reported by the device"},"createdDate":{"format":"date-time","type":"string","description":"When the server was created","readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["id","_links","deviceId","status","createdDate","errors"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ReplayServerConfigDto":{"type":"object","properties":{"apiBaseUrl":{"type":"string","description":"API base URL for pairing"},"gcpStorageBucket":{"type":"string","description":"GCP storage bucket name"},"logoPath":{"type":"string","description":"Path to logo overlay image"},"logoPlacement":{"type":"string","description":"Logo placement","enum":["bottom-right","bottom-center"]},"gcpCredentialsPath":{"type":"string","description":"Path to GCP credentials JSON file"},"postrollPath":{"type":"string","description":"Path to postroll video file"},"cleanupEnabled":{"type":"boolean","description":"Enable auto-cleanup of old chunks and clips"},"cameras":{"description":"Camera configurations","type":"array","items":{"$ref":"#/components/schemas/CameraConfigDto"}}}},"CameraConfigDto":{"type":"object","properties":{"id":{"type":"string","description":"Camera ID"},"name":{"type":"string","description":"Camera name"},"feed":{"type":"string","description":"RTSP feed URL"},"feed2":{"type":"string","description":"Secondary RTSP feed URL"},"isEnabled":{"type":"boolean","description":"Whether the camera is enabled"},"videoCodec":{"type":"string","description":"Video codec","enum":["h264","h265"]},"audioCodec":{"type":"string","description":"Audio codec","enum":["aac","alaw","mulaw"]},"distortion1":{"type":"number","description":"Lens distortion correction 1"},"distortion2":{"type":"number","description":"Lens distortion correction 2"},"rotation":{"type":"number","description":"Image rotation in degrees"},"scale":{"type":"number","description":"Image scale factor"},"vignette":{"type":"number","description":"Vignette effect intensity"},"lutPath":{"type":"string","description":"Path to LUT file for color grading"}},"required":["id","name","feed","isEnabled"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]},"PaginationDto":{"type":"object","properties":{"page":{"type":"number"},"ipp":{"type":"number"},"count":{"type":"number"},"total":{"type":"number"}},"required":["page","ipp","count","total"]}}},"paths":{"/replay-servers":{"get":{"operationId":"ReplayServersController_findAll","parameters":[{"name":"status","required":false,"in":"query","description":"Filter by status","schema":{"enum":["PENDING","APPROVED","REVOKED"],"type":"string"}},{"name":"areaId","required":false,"in":"query","description":"Filter by area ID","schema":{"type":"string"}},{"name":"page","required":false,"in":"query","schema":{"type":"number"}},{"name":"ipp","required":false,"in":"query","schema":{"type":"number"}}],"responses":{"200":{"description":"Returns a list of replay servers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplayServerCollectionDto"}}}}},"tags":["Replay Servers"]}}}}
```

## GET /replay-servers/available-versions

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Replay Servers"}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"AvailableVersionsResponseDto":{"type":"object","properties":{"versions":{"description":"List of available versions sorted newest first","type":"array","items":{"$ref":"#/components/schemas/VersionDto"}}},"required":["versions"]},"VersionDto":{"type":"object","properties":{"version":{"type":"string","description":"Version string (semver)","readOnly":true}},"required":["version"]}}},"paths":{"/replay-servers/available-versions":{"get":{"operationId":"ReplayServersController_getAvailableVersions","parameters":[],"responses":{"200":{"description":"Returns available software versions from GCS","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailableVersionsResponseDto"}}}}},"tags":["Replay Servers"]}}}}
```

## GET /replay-servers/branding-assets

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Replay Servers"}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"BrandingAssetsResponseDto":{"type":"object","properties":{"assets":{"description":"List of branding assets","type":"array","items":{"$ref":"#/components/schemas/BrandingAssetDto"}}},"required":["assets"]},"BrandingAssetDto":{"type":"object","properties":{"name":{"type":"string","description":"File name"},"path":{"type":"string","description":"Full path in bucket"},"url":{"type":"string","description":"Signed URL for preview"}},"required":["name","path"]}}},"paths":{"/replay-servers/branding-assets":{"get":{"operationId":"ReplayServersController_listBrandingAssets","parameters":[],"responses":{"200":{"description":"List branding assets with signed URLs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandingAssetsResponseDto"}}}}},"tags":["Replay Servers"]}}}}
```

## POST /replay-servers/branding-assets

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Replay Servers"}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"BrandingAssetUploadDto":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"File to upload"}},"required":["file"]},"BrandingAssetDto":{"type":"object","properties":{"name":{"type":"string","description":"File name"},"path":{"type":"string","description":"Full path in bucket"},"url":{"type":"string","description":"Signed URL for preview"}},"required":["name","path"]}}},"paths":{"/replay-servers/branding-assets":{"post":{"operationId":"ReplayServersController_uploadBrandingAsset","parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/BrandingAssetUploadDto"}}}},"responses":{"201":{"description":"Uploaded branding asset","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandingAssetDto"}}}}},"tags":["Replay Servers"]}}}}
```

## PATCH /replay-servers/{serverId}/target-version

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Replay Servers"}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"SetTargetVersionDto":{"type":"object","properties":{"version":{"type":"string","description":"Target version for this replay server (empty string or null to clear)"}}},"ReplayServerDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"},"_links":{"description":"A `LinksDto` structure containing URL references to propertes that can be expanded","allOf":[{"$ref":"#/components/schemas/LinksDto"}]},"deviceId":{"type":"string","description":"Unique device identifier","readOnly":true},"hostname":{"type":"string","description":"Device hostname"},"version":{"type":"string","description":"Software version running on the device"},"displayName":{"type":"string","description":"Display name for the server"},"status":{"type":"string","description":"Status of the server","enum":["PENDING","APPROVED","REVOKED"],"readOnly":true},"area":{"description":"Area the server is assigned to","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"approvedDate":{"format":"date-time","type":"string","description":"When the device was approved"},"approvedByUser":{"description":"User who approved the server","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"lastSeenDate":{"format":"date-time","type":"string","description":"When the device was last seen"},"lastSeenIp":{"type":"string","description":"IP address of last request"},"config":{"description":"Server configuration (cameras, paths, etc)","allOf":[{"$ref":"#/components/schemas/ReplayServerConfigDto"}]},"targetVersion":{"type":"string","description":"Target software version for this server"},"serverUrl":{"type":"string","description":"External DDNS or URL where this server is reachable"},"localIp":{"type":"string","description":"Local network IP address reported by the device"},"createdDate":{"format":"date-time","type":"string","description":"When the server was created","readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["id","_links","deviceId","status","createdDate","errors"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ReplayServerConfigDto":{"type":"object","properties":{"apiBaseUrl":{"type":"string","description":"API base URL for pairing"},"gcpStorageBucket":{"type":"string","description":"GCP storage bucket name"},"logoPath":{"type":"string","description":"Path to logo overlay image"},"logoPlacement":{"type":"string","description":"Logo placement","enum":["bottom-right","bottom-center"]},"gcpCredentialsPath":{"type":"string","description":"Path to GCP credentials JSON file"},"postrollPath":{"type":"string","description":"Path to postroll video file"},"cleanupEnabled":{"type":"boolean","description":"Enable auto-cleanup of old chunks and clips"},"cameras":{"description":"Camera configurations","type":"array","items":{"$ref":"#/components/schemas/CameraConfigDto"}}}},"CameraConfigDto":{"type":"object","properties":{"id":{"type":"string","description":"Camera ID"},"name":{"type":"string","description":"Camera name"},"feed":{"type":"string","description":"RTSP feed URL"},"feed2":{"type":"string","description":"Secondary RTSP feed URL"},"isEnabled":{"type":"boolean","description":"Whether the camera is enabled"},"videoCodec":{"type":"string","description":"Video codec","enum":["h264","h265"]},"audioCodec":{"type":"string","description":"Audio codec","enum":["aac","alaw","mulaw"]},"distortion1":{"type":"number","description":"Lens distortion correction 1"},"distortion2":{"type":"number","description":"Lens distortion correction 2"},"rotation":{"type":"number","description":"Image rotation in degrees"},"scale":{"type":"number","description":"Image scale factor"},"vignette":{"type":"number","description":"Vignette effect intensity"},"lutPath":{"type":"string","description":"Path to LUT file for color grading"}},"required":["id","name","feed","isEnabled"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]}}},"paths":{"/replay-servers/{serverId}/target-version":{"patch":{"operationId":"ReplayServersController_setTargetVersion","parameters":[{"name":"serverId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Set the target version for this replay server","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetTargetVersionDto"}}}},"responses":{"200":{"description":"Returns the updated replay server","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplayServerDto"}}}}},"tags":["Replay Servers"]}}}}
```

## GET /replay-servers/pending

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Replay Servers"}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ReplayServerCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ReplayServerDto"}},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_pagination","_links"]},"ReplayServerDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"},"_links":{"description":"A `LinksDto` structure containing URL references to propertes that can be expanded","allOf":[{"$ref":"#/components/schemas/LinksDto"}]},"deviceId":{"type":"string","description":"Unique device identifier","readOnly":true},"hostname":{"type":"string","description":"Device hostname"},"version":{"type":"string","description":"Software version running on the device"},"displayName":{"type":"string","description":"Display name for the server"},"status":{"type":"string","description":"Status of the server","enum":["PENDING","APPROVED","REVOKED"],"readOnly":true},"area":{"description":"Area the server is assigned to","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"approvedDate":{"format":"date-time","type":"string","description":"When the device was approved"},"approvedByUser":{"description":"User who approved the server","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"lastSeenDate":{"format":"date-time","type":"string","description":"When the device was last seen"},"lastSeenIp":{"type":"string","description":"IP address of last request"},"config":{"description":"Server configuration (cameras, paths, etc)","allOf":[{"$ref":"#/components/schemas/ReplayServerConfigDto"}]},"targetVersion":{"type":"string","description":"Target software version for this server"},"serverUrl":{"type":"string","description":"External DDNS or URL where this server is reachable"},"localIp":{"type":"string","description":"Local network IP address reported by the device"},"createdDate":{"format":"date-time","type":"string","description":"When the server was created","readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["id","_links","deviceId","status","createdDate","errors"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ReplayServerConfigDto":{"type":"object","properties":{"apiBaseUrl":{"type":"string","description":"API base URL for pairing"},"gcpStorageBucket":{"type":"string","description":"GCP storage bucket name"},"logoPath":{"type":"string","description":"Path to logo overlay image"},"logoPlacement":{"type":"string","description":"Logo placement","enum":["bottom-right","bottom-center"]},"gcpCredentialsPath":{"type":"string","description":"Path to GCP credentials JSON file"},"postrollPath":{"type":"string","description":"Path to postroll video file"},"cleanupEnabled":{"type":"boolean","description":"Enable auto-cleanup of old chunks and clips"},"cameras":{"description":"Camera configurations","type":"array","items":{"$ref":"#/components/schemas/CameraConfigDto"}}}},"CameraConfigDto":{"type":"object","properties":{"id":{"type":"string","description":"Camera ID"},"name":{"type":"string","description":"Camera name"},"feed":{"type":"string","description":"RTSP feed URL"},"feed2":{"type":"string","description":"Secondary RTSP feed URL"},"isEnabled":{"type":"boolean","description":"Whether the camera is enabled"},"videoCodec":{"type":"string","description":"Video codec","enum":["h264","h265"]},"audioCodec":{"type":"string","description":"Audio codec","enum":["aac","alaw","mulaw"]},"distortion1":{"type":"number","description":"Lens distortion correction 1"},"distortion2":{"type":"number","description":"Lens distortion correction 2"},"rotation":{"type":"number","description":"Image rotation in degrees"},"scale":{"type":"number","description":"Image scale factor"},"vignette":{"type":"number","description":"Vignette effect intensity"},"lutPath":{"type":"string","description":"Path to LUT file for color grading"}},"required":["id","name","feed","isEnabled"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]},"PaginationDto":{"type":"object","properties":{"page":{"type":"number"},"ipp":{"type":"number"},"count":{"type":"number"},"total":{"type":"number"}},"required":["page","ipp","count","total"]}}},"paths":{"/replay-servers/pending":{"get":{"operationId":"ReplayServersController_findPending","parameters":[],"responses":{"200":{"description":"Returns pending replay servers awaiting approval","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplayServerCollectionDto"}}}}},"tags":["Replay Servers"]}}}}
```

## GET /replay-servers/{serverId}/health

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Replay Servers"}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}}},"paths":{"/replay-servers/{serverId}/health":{"get":{"operationId":"ReplayServersController_proxyHealth","parameters":[{"name":"serverId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns health data from the device"}},"tags":["Replay Servers"]}}}}
```

## GET /replay-servers/{serverId}/logs

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Replay Servers"}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}}},"paths":{"/replay-servers/{serverId}/logs":{"get":{"operationId":"ReplayServersController_proxyLogs","parameters":[{"name":"serverId","required":true,"in":"path","schema":{"type":"string"}},{"name":"lines","required":false,"in":"query","schema":{"type":"number"}}],"responses":{"200":{"description":"Returns log lines from the device"}},"tags":["Replay Servers"]}}}}
```

## GET /replay-servers/{serverId}/config

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Replay Servers"}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}}},"paths":{"/replay-servers/{serverId}/config":{"get":{"operationId":"ReplayServersController_proxyConfig","parameters":[{"name":"serverId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns camera config from the device"}},"tags":["Replay Servers"]}}}}
```

## PATCH /replay-servers/{serverId}/config

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Replay Servers"}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ReplayServerConfigDto":{"type":"object","properties":{"apiBaseUrl":{"type":"string","description":"API base URL for pairing"},"gcpStorageBucket":{"type":"string","description":"GCP storage bucket name"},"logoPath":{"type":"string","description":"Path to logo overlay image"},"logoPlacement":{"type":"string","description":"Logo placement","enum":["bottom-right","bottom-center"]},"gcpCredentialsPath":{"type":"string","description":"Path to GCP credentials JSON file"},"postrollPath":{"type":"string","description":"Path to postroll video file"},"cleanupEnabled":{"type":"boolean","description":"Enable auto-cleanup of old chunks and clips"},"cameras":{"description":"Camera configurations","type":"array","items":{"$ref":"#/components/schemas/CameraConfigDto"}}}},"CameraConfigDto":{"type":"object","properties":{"id":{"type":"string","description":"Camera ID"},"name":{"type":"string","description":"Camera name"},"feed":{"type":"string","description":"RTSP feed URL"},"feed2":{"type":"string","description":"Secondary RTSP feed URL"},"isEnabled":{"type":"boolean","description":"Whether the camera is enabled"},"videoCodec":{"type":"string","description":"Video codec","enum":["h264","h265"]},"audioCodec":{"type":"string","description":"Audio codec","enum":["aac","alaw","mulaw"]},"distortion1":{"type":"number","description":"Lens distortion correction 1"},"distortion2":{"type":"number","description":"Lens distortion correction 2"},"rotation":{"type":"number","description":"Image rotation in degrees"},"scale":{"type":"number","description":"Image scale factor"},"vignette":{"type":"number","description":"Vignette effect intensity"},"lutPath":{"type":"string","description":"Path to LUT file for color grading"}},"required":["id","name","feed","isEnabled"]},"ReplayServerDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"},"_links":{"description":"A `LinksDto` structure containing URL references to propertes that can be expanded","allOf":[{"$ref":"#/components/schemas/LinksDto"}]},"deviceId":{"type":"string","description":"Unique device identifier","readOnly":true},"hostname":{"type":"string","description":"Device hostname"},"version":{"type":"string","description":"Software version running on the device"},"displayName":{"type":"string","description":"Display name for the server"},"status":{"type":"string","description":"Status of the server","enum":["PENDING","APPROVED","REVOKED"],"readOnly":true},"area":{"description":"Area the server is assigned to","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"approvedDate":{"format":"date-time","type":"string","description":"When the device was approved"},"approvedByUser":{"description":"User who approved the server","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"lastSeenDate":{"format":"date-time","type":"string","description":"When the device was last seen"},"lastSeenIp":{"type":"string","description":"IP address of last request"},"config":{"description":"Server configuration (cameras, paths, etc)","allOf":[{"$ref":"#/components/schemas/ReplayServerConfigDto"}]},"targetVersion":{"type":"string","description":"Target software version for this server"},"serverUrl":{"type":"string","description":"External DDNS or URL where this server is reachable"},"localIp":{"type":"string","description":"Local network IP address reported by the device"},"createdDate":{"format":"date-time","type":"string","description":"When the server was created","readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["id","_links","deviceId","status","createdDate","errors"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]}}},"paths":{"/replay-servers/{serverId}/config":{"patch":{"operationId":"ReplayServersController_updateConfig","parameters":[{"name":"serverId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Configuration to apply to the device","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplayServerConfigDto"}}}},"responses":{"200":{"description":"Returns the updated replay server","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplayServerDto"}}}}},"tags":["Replay Servers"]}}}}
```

## GET /replay-servers/{serverId}/branding

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Replay Servers"}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}}},"paths":{"/replay-servers/{serverId}/branding":{"get":{"operationId":"ReplayServersController_proxyBrandingStatus","parameters":[{"name":"serverId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns branding status from the device (what is currently downloaded)"}},"tags":["Replay Servers"]}}}}
```

## GET /replay-servers/{serverId}/branding/logo

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Replay Servers"}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}}},"paths":{"/replay-servers/{serverId}/branding/logo":{"get":{"operationId":"ReplayServersController_proxyBrandingLogo","parameters":[{"name":"serverId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the logo image currently on the device"}},"tags":["Replay Servers"]}}}}
```

## GET /replay-servers/{serverId}/branding/postroll

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Replay Servers"}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}}},"paths":{"/replay-servers/{serverId}/branding/postroll":{"get":{"operationId":"ReplayServersController_proxyBrandingPostroll","parameters":[{"name":"serverId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the postroll video currently on the device"}},"tags":["Replay Servers"]}}}}
```

## GET /replay-servers/{serverId}/instant-replay/{cameraId}/branded

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Replay Servers"}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}}},"paths":{"/replay-servers/{serverId}/instant-replay/{cameraId}/branded":{"get":{"operationId":"ReplayServersController_proxyBrandedReplay","parameters":[{"name":"serverId","required":true,"in":"path","schema":{"type":"string"}},{"name":"cameraId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns branded instant replay video (with logo + postroll)"}},"tags":["Replay Servers"]}}}}
```

## GET /replay-servers/{serverId}/instant-replay/{cameraId}

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Replay Servers"}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}}},"paths":{"/replay-servers/{serverId}/instant-replay/{cameraId}":{"get":{"operationId":"ReplayServersController_proxyInstantReplay","parameters":[{"name":"serverId","required":true,"in":"path","schema":{"type":"string"}},{"name":"cameraId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns instant replay video file"}},"tags":["Replay Servers"]}}}}
```

## POST /replay-servers/{serverId}/snapshot/{cameraId}

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Replay Servers"}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}}},"paths":{"/replay-servers/{serverId}/snapshot/{cameraId}":{"post":{"operationId":"ReplayServersController_proxySnapshot","parameters":[{"name":"serverId","required":true,"in":"path","schema":{"type":"string"}},{"name":"cameraId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns snapshot image"}},"tags":["Replay Servers"]}}}}
```

## POST /replay-servers/{serverId}/restart

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Replay Servers"}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}}},"paths":{"/replay-servers/{serverId}/restart":{"post":{"operationId":"ReplayServersController_proxyRestart","parameters":[{"name":"serverId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Requests device service restart"}},"tags":["Replay Servers"]}}}}
```

## GET /replay-servers/{serverId}

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Replay Servers"}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ReplayServerDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"},"_links":{"description":"A `LinksDto` structure containing URL references to propertes that can be expanded","allOf":[{"$ref":"#/components/schemas/LinksDto"}]},"deviceId":{"type":"string","description":"Unique device identifier","readOnly":true},"hostname":{"type":"string","description":"Device hostname"},"version":{"type":"string","description":"Software version running on the device"},"displayName":{"type":"string","description":"Display name for the server"},"status":{"type":"string","description":"Status of the server","enum":["PENDING","APPROVED","REVOKED"],"readOnly":true},"area":{"description":"Area the server is assigned to","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"approvedDate":{"format":"date-time","type":"string","description":"When the device was approved"},"approvedByUser":{"description":"User who approved the server","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"lastSeenDate":{"format":"date-time","type":"string","description":"When the device was last seen"},"lastSeenIp":{"type":"string","description":"IP address of last request"},"config":{"description":"Server configuration (cameras, paths, etc)","allOf":[{"$ref":"#/components/schemas/ReplayServerConfigDto"}]},"targetVersion":{"type":"string","description":"Target software version for this server"},"serverUrl":{"type":"string","description":"External DDNS or URL where this server is reachable"},"localIp":{"type":"string","description":"Local network IP address reported by the device"},"createdDate":{"format":"date-time","type":"string","description":"When the server was created","readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["id","_links","deviceId","status","createdDate","errors"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ReplayServerConfigDto":{"type":"object","properties":{"apiBaseUrl":{"type":"string","description":"API base URL for pairing"},"gcpStorageBucket":{"type":"string","description":"GCP storage bucket name"},"logoPath":{"type":"string","description":"Path to logo overlay image"},"logoPlacement":{"type":"string","description":"Logo placement","enum":["bottom-right","bottom-center"]},"gcpCredentialsPath":{"type":"string","description":"Path to GCP credentials JSON file"},"postrollPath":{"type":"string","description":"Path to postroll video file"},"cleanupEnabled":{"type":"boolean","description":"Enable auto-cleanup of old chunks and clips"},"cameras":{"description":"Camera configurations","type":"array","items":{"$ref":"#/components/schemas/CameraConfigDto"}}}},"CameraConfigDto":{"type":"object","properties":{"id":{"type":"string","description":"Camera ID"},"name":{"type":"string","description":"Camera name"},"feed":{"type":"string","description":"RTSP feed URL"},"feed2":{"type":"string","description":"Secondary RTSP feed URL"},"isEnabled":{"type":"boolean","description":"Whether the camera is enabled"},"videoCodec":{"type":"string","description":"Video codec","enum":["h264","h265"]},"audioCodec":{"type":"string","description":"Audio codec","enum":["aac","alaw","mulaw"]},"distortion1":{"type":"number","description":"Lens distortion correction 1"},"distortion2":{"type":"number","description":"Lens distortion correction 2"},"rotation":{"type":"number","description":"Image rotation in degrees"},"scale":{"type":"number","description":"Image scale factor"},"vignette":{"type":"number","description":"Vignette effect intensity"},"lutPath":{"type":"string","description":"Path to LUT file for color grading"}},"required":["id","name","feed","isEnabled"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]}}},"paths":{"/replay-servers/{serverId}":{"get":{"operationId":"ReplayServersController_findOne","parameters":[{"name":"serverId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a replay server","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplayServerDto"}}}}},"tags":["Replay Servers"]}}}}
```

## DELETE /replay-servers/{serverId}

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Replay Servers"}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ReplayServerDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"},"_links":{"description":"A `LinksDto` structure containing URL references to propertes that can be expanded","allOf":[{"$ref":"#/components/schemas/LinksDto"}]},"deviceId":{"type":"string","description":"Unique device identifier","readOnly":true},"hostname":{"type":"string","description":"Device hostname"},"version":{"type":"string","description":"Software version running on the device"},"displayName":{"type":"string","description":"Display name for the server"},"status":{"type":"string","description":"Status of the server","enum":["PENDING","APPROVED","REVOKED"],"readOnly":true},"area":{"description":"Area the server is assigned to","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"approvedDate":{"format":"date-time","type":"string","description":"When the device was approved"},"approvedByUser":{"description":"User who approved the server","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"lastSeenDate":{"format":"date-time","type":"string","description":"When the device was last seen"},"lastSeenIp":{"type":"string","description":"IP address of last request"},"config":{"description":"Server configuration (cameras, paths, etc)","allOf":[{"$ref":"#/components/schemas/ReplayServerConfigDto"}]},"targetVersion":{"type":"string","description":"Target software version for this server"},"serverUrl":{"type":"string","description":"External DDNS or URL where this server is reachable"},"localIp":{"type":"string","description":"Local network IP address reported by the device"},"createdDate":{"format":"date-time","type":"string","description":"When the server was created","readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["id","_links","deviceId","status","createdDate","errors"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ReplayServerConfigDto":{"type":"object","properties":{"apiBaseUrl":{"type":"string","description":"API base URL for pairing"},"gcpStorageBucket":{"type":"string","description":"GCP storage bucket name"},"logoPath":{"type":"string","description":"Path to logo overlay image"},"logoPlacement":{"type":"string","description":"Logo placement","enum":["bottom-right","bottom-center"]},"gcpCredentialsPath":{"type":"string","description":"Path to GCP credentials JSON file"},"postrollPath":{"type":"string","description":"Path to postroll video file"},"cleanupEnabled":{"type":"boolean","description":"Enable auto-cleanup of old chunks and clips"},"cameras":{"description":"Camera configurations","type":"array","items":{"$ref":"#/components/schemas/CameraConfigDto"}}}},"CameraConfigDto":{"type":"object","properties":{"id":{"type":"string","description":"Camera ID"},"name":{"type":"string","description":"Camera name"},"feed":{"type":"string","description":"RTSP feed URL"},"feed2":{"type":"string","description":"Secondary RTSP feed URL"},"isEnabled":{"type":"boolean","description":"Whether the camera is enabled"},"videoCodec":{"type":"string","description":"Video codec","enum":["h264","h265"]},"audioCodec":{"type":"string","description":"Audio codec","enum":["aac","alaw","mulaw"]},"distortion1":{"type":"number","description":"Lens distortion correction 1"},"distortion2":{"type":"number","description":"Lens distortion correction 2"},"rotation":{"type":"number","description":"Image rotation in degrees"},"scale":{"type":"number","description":"Image scale factor"},"vignette":{"type":"number","description":"Vignette effect intensity"},"lutPath":{"type":"string","description":"Path to LUT file for color grading"}},"required":["id","name","feed","isEnabled"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]}}},"paths":{"/replay-servers/{serverId}":{"delete":{"operationId":"ReplayServersController_revokeDevice","parameters":[{"name":"serverId","required":true,"in":"path","schema":{"type":"string"}},{"name":"permanent","required":false,"in":"query","description":"Permanently delete the server (only for REVOKED or PENDING)","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Returns the revoked replay server","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplayServerDto"}}}},"204":{"description":"Server permanently deleted"}},"tags":["Replay Servers"]}}}}
```

## POST /replay-servers/approve

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Replay Servers"}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ApproveReplayServerDto":{"type":"object","properties":{"server":{"description":"The replay server to approve","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"area":{"description":"The area to assign the replay server to","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"displayName":{"type":"string","description":"Optional display name for the server"}},"required":["server","area"]},"ItemRefDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"}},"required":["id"]},"ReplayServerDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource"},"_links":{"description":"A `LinksDto` structure containing URL references to propertes that can be expanded","allOf":[{"$ref":"#/components/schemas/LinksDto"}]},"deviceId":{"type":"string","description":"Unique device identifier","readOnly":true},"hostname":{"type":"string","description":"Device hostname"},"version":{"type":"string","description":"Software version running on the device"},"displayName":{"type":"string","description":"Display name for the server"},"status":{"type":"string","description":"Status of the server","enum":["PENDING","APPROVED","REVOKED"],"readOnly":true},"area":{"description":"Area the server is assigned to","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"approvedDate":{"format":"date-time","type":"string","description":"When the device was approved"},"approvedByUser":{"description":"User who approved the server","allOf":[{"$ref":"#/components/schemas/ItemRefDto"}]},"lastSeenDate":{"format":"date-time","type":"string","description":"When the device was last seen"},"lastSeenIp":{"type":"string","description":"IP address of last request"},"config":{"description":"Server configuration (cameras, paths, etc)","allOf":[{"$ref":"#/components/schemas/ReplayServerConfigDto"}]},"targetVersion":{"type":"string","description":"Target software version for this server"},"serverUrl":{"type":"string","description":"External DDNS or URL where this server is reachable"},"localIp":{"type":"string","description":"Local network IP address reported by the device"},"createdDate":{"format":"date-time","type":"string","description":"When the server was created","readOnly":true},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}}},"required":["id","_links","deviceId","status","createdDate","errors"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"ReplayServerConfigDto":{"type":"object","properties":{"apiBaseUrl":{"type":"string","description":"API base URL for pairing"},"gcpStorageBucket":{"type":"string","description":"GCP storage bucket name"},"logoPath":{"type":"string","description":"Path to logo overlay image"},"logoPlacement":{"type":"string","description":"Logo placement","enum":["bottom-right","bottom-center"]},"gcpCredentialsPath":{"type":"string","description":"Path to GCP credentials JSON file"},"postrollPath":{"type":"string","description":"Path to postroll video file"},"cleanupEnabled":{"type":"boolean","description":"Enable auto-cleanup of old chunks and clips"},"cameras":{"description":"Camera configurations","type":"array","items":{"$ref":"#/components/schemas/CameraConfigDto"}}}},"CameraConfigDto":{"type":"object","properties":{"id":{"type":"string","description":"Camera ID"},"name":{"type":"string","description":"Camera name"},"feed":{"type":"string","description":"RTSP feed URL"},"feed2":{"type":"string","description":"Secondary RTSP feed URL"},"isEnabled":{"type":"boolean","description":"Whether the camera is enabled"},"videoCodec":{"type":"string","description":"Video codec","enum":["h264","h265"]},"audioCodec":{"type":"string","description":"Audio codec","enum":["aac","alaw","mulaw"]},"distortion1":{"type":"number","description":"Lens distortion correction 1"},"distortion2":{"type":"number","description":"Lens distortion correction 2"},"rotation":{"type":"number","description":"Image rotation in degrees"},"scale":{"type":"number","description":"Image scale factor"},"vignette":{"type":"number","description":"Vignette effect intensity"},"lutPath":{"type":"string","description":"Path to LUT file for color grading"}},"required":["id","name","feed","isEnabled"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]}}},"paths":{"/replay-servers/approve":{"post":{"operationId":"ReplayServersController_approveDevice","parameters":[],"requestBody":{"required":true,"description":"Approve a pending device","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApproveReplayServerDto"}}}},"responses":{"201":{"description":"Returns the approved replay server","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplayServerDto"}}}},"404":{"description":"Server not found"},"422":{"description":"Validation error"}},"tags":["Replay Servers"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.podplay.app/api/replay-servers.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.