Skip to navigation

Get Bot Screenshots

View as Markdown

List the screenshots captured for a bot, newest first, with a one-hour download URL for each. Paginated with continuation tokens.

Authentication

AuthorizationToken

Format: Token <your_api_key>

Path parameters

bot_idstringRequired

Query parameters

limitintegerOptional<=100Defaults to 25
Page size. Values below 1 fall back to 25.
recorded_at_afterdatetimeOptional
Only screenshots recorded at or after this ISO 8601 time.
recorded_at_beforedatetimeOptional
Only screenshots recorded before this ISO 8601 time.
continuation_tokenstringOptional

A next_continuation_token or prev_continuation_token from a previous page.

actionenumOptional

Send prev with a prev_continuation_token to page backwards.

Allowed values:
metastringOptional

The meta value from the previous page, sent back with the continuation token.

Response

Success
bot_idstringOptional
screenshotslist of objectsOptional
Newest first.
next_continuation_tokenstring or nullOptional

Pass as continuation_token to fetch the next (older) page. Null on the last page.

prev_continuation_tokenstring or nullOptional

Pass as continuation_token with action=prev to page back. Null on the first page.

metastringOptional

Opaque value that carries the current filters; send it back with the continuation token.

Errors

403
Forbidden Error
404
Not Found Error