Create Usenet Download
POST {{api_base}}/{{api_version}}/api/usenet/createusenetdownload
Overview
Creates a usenet download under your account. Simply send either a link, or an nzb file. Once they have been checked, they will begin downloading assuming your account has available active download slots, and they aren't too large.
Post Processing Options:
All post processing options that the Usenet client will perform before TorBox's own processing to make the files available. It is recommended you either don't send this parameter, or keep it at
-1
for default, which will give only the wanted files.
-
-1, Default. This runs repairs, and extractions as well as deletes the source files leaving only the wanted downloaded files. -
0, None. No post-processing at all. Just download all the files (including all PAR2). TorBox will still do its normal processing to make the download available, but no repairs, or extraction will take place. -
1, Repair. Download files and do a PAR2 verification. If the verification fails, download more PAR2 files and attempt to repair the files. -
2, Repair and Unpack. Download all files, do a PAR2 verification and unpack the files. The final folder will also include the RAR and ZIP files. -
3, Repair, Unpack and Delete. Download all files, do a PAR2 verification, unpack the files to the final folder and delete the source files.
Authorization
Requires an API key using the Authorization Bearer Header.
Request Body
[{"name"=>"file", "value"=>nil, "datatype"=>"null"}, {"name"=>"link", "value"=>"string", "datatype"=>"string"}, {"name"=>"name", "value"=>"string", "datatype"=>"string"}, {"name"=>"password", "value"=>"string", "datatype"=>"string"}, {"name"=>"post_processing", "value"=>"integer", "datatype"=>"string"}]
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status: OK
{"success":true,"error":null,"detail":"Download started successfully","data":{"hash":"XXXXXXXXXXXXXXXXX","usenetdownload_id":"0","auth_id":"XXXXXXXXXXXXXXXXX"}}