List highlights

get

https://studio.zentag.ai/api/v1/partner/highlights

Highlight reels owned by your organization. Highlights are produced asynchronously, so entries may be non-terminal - check status before treating preview_url as playable.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

limit

integer

1 to 100

Defaults to 25

Page size (1-100, default 25).

cursor

string

Opaque pagination cursor from a previous response's next_cursor.

stream_id

string

Restrict to highlights attached to this stream.

status

string

Comma-separated statuses. Multiple values are OR-ed.

string

Case-insensitive substring match on title.

aspect_ratio

string

Exact aspect ratio, e.g. 9:16.

category

string

Comma-separated categories. Multiple values are OR-ed.

rating

string

Comma-separated star ratings (1-5). Multiple values are OR-ed.

is_ai_created

boolean

Filter to AI-generated highlights, or to manually built ones.

duration

string

enum

Duration buckets, as upper bounds in seconds. Only 180, 300, 420 and 600 are recognised. These are ceilings rather than ranges, so passing several is equivalent to passing the largest: 180,600 means "10 minutes or under".

Allowed:

start_date

date

Only highlights created on or after this date (inclusive).

end_date

date

Only highlights created on or before this date (inclusive).

sort_by

string

enum

Defaults to latest

Result ordering. Cursors are tied to the ordering they were issued under, so changing sort_by mid-pagination invalidates the cursor - restart from the first page.

Allowed:

Responses

Language

Credentials

Bearer

zt_live_sk_*

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A paginated list of highlights.

401Missing or invalid API key.

403The API key lacks the required scope or IP is not allowed.

429Rate limit exceeded.