OCT-103 Gumlet outreach
GET/video/live/assets/list/{live_source_id}

List live assets for a source

Lists live assets for a specified live source, with an optional filter by asset status. Use status to select one or more statuses and offset and size to paginate the results.

4 parameters
live_source_idstringrequired

The Gumlet live source or collection identifier whose assets to list.

statusstringoptional

Filter by one or more current asset statuses: created, active, complete, disconnected, errored, or deleted. Supply a single value or comma-separated values.

offsetintegeroptional

Number of matching assets to skip in the paginated results.

sizeintegeroptional

Maximum number of matching assets to return in the page.

4 status codes
200Returns a list of live asset objects, the current offset, and the total live asset count.
all_live_assetsarray<object>optional
current_offsetintegeroptional
Default:0
total_live_asset_countintegeroptional
Default:0
400Returned when the request is invalid.

One documented failure

  • source_not_found

    Could not find any video source with the specified source_id.

errorobjectrequired
401Returned when the request is unauthorized.

One documented failure

  • live_source_not_found

    Could not find any live video source with specified source ID.

errorobjectoptional
403Returned when the account is unpaid or the authenticated user lacks the required role permissions.

One documented failure

  • unauthorized

    You don't have access to this feature. Please contact your organization owner.

errorobjectrequired

Error handling

A 400 is returned for a bad request, a 401 for an unauthorized request, and a 403 for an unpaid account or insufficient role permissions. live_source_id must identify the source to list; status, when supplied, must contain one or more of created, active, complete, disconnected, errored, or deleted.