@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Browshot API
@base https://api.browshot.com/api/v1
@version 1.17.0
@auth ApiKey key in query
@endpoints 17
@toc screenshot(10), batch(2), account(1), instance(2), browser(2)

@group screenshot
@endpoint GET /screenshot/create
@required {url: any, instance_id: any}
@optional {size: any, cache: any, delay: any, flash_delay: any, screen_width: any, screen_height: any, priority: any, referer: any, post_data: any, cookie: any, script: any, details: any, html: any, max_wait: any, headers: any, shots: any, shot_interval: any, hosting: any, hosting_height: any, hosting_width: any, hosting_scale: any, hosting_bucket: any, hosting_file: any, hosting_headers: any}
@returns(200)
@errors {403}

@endpoint GET /screenshot/multiple
@required {url: any, instance_id: any}
@optional {size: any, cache: any, delay: any, flash_delay: any, screen_width: any, screen_height: any, priority: any, referer: any, post_data: any, cookie: any, script: any, details: any, html: any, max_wait: any, headers: any, hosting: any, hosting_height: any, hosting_width: any, hosting_scale: any, hosting_bucket: any, hosting_file: any, hosting_headers: any}
@returns(200)
@errors {403}

@endpoint GET /screenshot/info
@required {id: any}
@optional {details: any}
@returns(200)

@endpoint GET /screenshot/list
@optional {limit: any, status: any}
@returns(200)

@endpoint GET /screenshot/search
@required {url: any}
@optional {limit: any, status: any}
@returns(200)

@endpoint GET /screenshot/host
@required {id: any, hosting: any}
@optional {width: any, height: any, scale: any, bucket: any, file: any, headers: any}
@returns(200)

@endpoint GET /screenshot/thumbnail
@required {id: any}
@optional {width: any, height: any, scale: any, zoom: any, ratio: any, left: any, right: any, top: any, bottom: any, format: any, shot: any, quality: any}
@returns(200)
@errors {404}

@endpoint GET /screenshot/share
@required {id: any}
@optional {note: any}
@returns(200)

@endpoint GET /screenshot/delete
@required {id: any}
@optional {data: any}
@returns(200)

@endpoint GET /screenshot/html
@required {id: any}

@endgroup

@group batch
@endpoint POST /batch/ceate
@required {instance_id: any}
@optional {file: any, size: any, name: any, width: any, height: any, delay: any, flash_delay: any, screen_width: any, screen_height: any, priority: any, referer: any, post_data: any, cookie: any, script: any, details: any, html: any, max_wait: any, headers: any, format: any, hosting: any, hosting_height: any, hosting_width: any, hosting_scale: any, hosting_bucket: any, hosting_file: any, hosting_headers: any}
@returns(200)

@endpoint GET /batch/info
@required {id: any}
@returns(200)

@endgroup

@group account
@endpoint GET /account/info
@optional {details: any}
@returns(200)

@endgroup

@group instance
@endpoint GET /instance/info
@required {id: any}
@returns(200)

@endpoint GET /instance/list
@returns(200)

@endgroup

@group browser
@endpoint GET /browser/info
@required {id: any}
@returns(200)

@endpoint GET /browser/list
@returns(200)

@endgroup

@end