Skip to main content
POST
/
api
/
transfer
Transfer a remote file
curl --request POST \
  --url https://convertly.sh/api/transfer \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
"<string>"

Authorizations

​
Authorization
string
header
required

Dashboard-generated Convertly API key. Keys currently begin with cvly_.

Body

application/json

Provide exactly one of sourceUrl or cloudSource.

​
sourceUrl
string<uri>

Public HTTP(S) file URL. Localhost and private network targets are blocked.

​
destination
enum<string>
default:download
Available options:
download,
convertly-storage
​
filename
string
Maximum string length: 180
​
contentType
string
Maximum string length: 120
​
async
boolean
default:true

Queue single-file URL transfers into Convertly Storage as background jobs. Set false only for small synchronous storage requests.

​
extract
boolean
default:false

Extract a ZIP archive into Convertly Storage.

​
extractOptions
object
​
cloudSource
object

Response

Transferred file bytes or Convertly Storage metadata

The response is of type file.