General Information

Base-URL for our API is https://api.embedo.co

All requests to the API shall be HTTP GET or POST

Please make sure to use the API with https only, http requests will result in a HTTP 302 redirect to https.

Most requests require a API Login & API Key, you can find both in the User Panel at the "Account" Tab.

Response is json, structure is as follows:

{
"status": <status-code>,
"msg": "<informational message. might vary, use the status code in your code!>",
"server_time":"<Time of server>"",
"result": <result of the request. varies depending on the request>
}
status

200: Everything is OK. Request succeeded

400: Bad request (e.g. wrong parameters)

403: Permission denied (wrong api login/key, action on a file which does not belong to you, ...)

404: File not found

451: Unavailable For Legal Reasons

509: Bandwidth usage exceeded. Please try again later. (you might see this during peak hours)

50x: Server errors. You should not see this, but be prepared.

msg

This message gives more detailed information in case there is an error.

You can use this for displaying it to the user, but please don't use it for checking if the request succeeded. That's what the status code is for.

result

holds the response of the request if succeeded. Might hold an array of data or just a boolean true/false, depending on the request

Account Infos

Everything account related (total used storage, reward, ...)

Request
https://api.embedo.co/account/info?login={login}&key={key}
Parameters

Name Description Example Required
login API-Login 8efb927ef798aa827 yes
key API-Key / API-Password 91kb5kp94k3kk8 yes

Response
200 (OK)
Content-Type: application/json
{
"status": 200,
"msg": "OK",
"server_time":"2021-07-12 08:36:15",
"result": {
    "id": "<userextid>",
    "email": "email@embedo.co",
    "signup_at": "2019-01-09 23:59:59",
}
}
File Info

check the status of a file, e.g. if the file exists

Request
https://api.embedo.co/file/info?file={file}&login={login}&key={key}
Parameters

Name Description Example Required
file File-ID Vxj4mjsK4PX yes
login API-Login 8efb927ef798aa827 yes
key API-Key / API-Password 91kb5kp94k3kk8 yes

Response
200 (OK)
Content-Type: application/json
{
"status": 200,
"msg": "OK",
"server_time":"2021-07-12 08:36:15",
"result": {
        "id": "vcatzwnjh0sm",
        "status": 200,
        "name": "test878ds78d88s.mp4",
        "size": "361357875",
        "folder": "2",
        "sha1": "d16594b09e7645b1377e85f86b6e873889085059",
        "content_type": "video/mp4",
}
}
Upload

Get an Upload URL

Uploads shall be POSTed to the upload URL returned by our API and shall be multipart/form-data encoded. Example with curl:

curl \
-F "login=6a6d9c40ed240f4e3" \
-F "key=d9tbp9ugv1ttz1" \
-F "file=@test.mp4" \
-F "folder=1" \
https://server.example.com/uls/60f9badb15337

Get next available upload server
https://api.embedo.co/file/ul?login={login}&key={key}
Parameters

Name Description Example Required
login API-Login 8efb927ef798aa827 yes
key API-Key / API-Password 91kb5kp94k3kk8 yes
folder Folder-ID to upload to 1234 no

Response
200 (OK)
Content-Type: application/json
{
"status": 200,
"msg": "OK",
"server_time":"2021-07-12 08:36:15",
"result": {
    "url": "https://server.example.com/uls/60ec19ff4d321",
    "valid_until": "2019-01-09 00:32:20"
}
}
Add Remote Upload

Remote Uploading a file

Request
https://api.embedo.co/remotedl/add?login={login}&key={key}&url={url}&folder={folder}
Parameters

Name Description Example Required
login API-Login 8efb927ef798aa827 yes
key API-Key / API-Password 91kb5kp94k3kk8 yes
url Remote URL http://google.com/favicon.ico yes
folder Folder-ID to upload to 1234 no

Response
200 (OK)
Content-Type: application/json
{
"status": 200,
"msg": "OK",
"server_time":"2021-07-12 08:36:15",
"result": {
"id": "8ykqg0nkqxoh",
"folderid": "12345"
}
}
Check Remote Upload Status

Check Status of Remote Upload

Request
https://api.embedo.co/remotedl/status?login={login}&key={key}&id={id}
Parameters

Name Description Example Required
login API-Login 8efb927ef798aa827 yes
key API-Key / API-Password 91kb5kp94k3kk8 yes
id Remote Upload ID nly9m6lc6fvo yes

Response
200 (OK)
Content-Type: application/json
{
"status": 200,
"msg": "OK",
"server_time":"2021-07-12 08:36:15",
"result": {
    "id": "oau6d7cbex8s",
    "remoteurl": "http://proof.ovh.net/files/100Mio.dat",
    "status": "pending",
    "bytes_loaded": null,
    "bytes_total": "0",
    "folderid": "12345",
    "added": "2019-01-01 02:20:12",
    "started": "0000-00-00 00:00:00",
    "finished": "0000-00-00 00:00:00",

}
}
Remove Remote Upload

Removing/Cancelling a remote upload

Request
https://api.embedo.co/remotedl/remove?login={login}&key={key}&id={id}
Parameters

Name Description Example Required
login API-Login 8efb927ef798aa827 yes
key API-Key / API-Password 91kb5kp94k3kk8 yes
id Remote Upload ID (or put in "all" to remove all remote uploads) nly9m6lc6fvo or "all" yes

Response
{
"status": 200,
"msg": "OK",
"server_time":"2021-07-12 08:36:15",
"result": true
}
restart Remote Upload

restart a remote upload

Request
https://api.embedo.co/remotedl/restart?login={login}&key={key}&restart=true
Parameters

Name Description Example Required
login API-Login 8efb927ef798aa827 yes
key API-Key / API-Password 91kb5kp94k3kk8 yes
restart restart all Failed remote uploads true yes

Response
{
"status": 200,
"msg": "OK",
"server_time":"2021-07-12 08:36:15",
"result": true
}
List Folder/Files

Shows the content of your folders Limit per page 200

Request
https://api.embedo.co/file/listfolder?login={login}&key={key}&folder={folder}&limit={limit}&page={pagination}
Parameters

Name Description Example Required
login API-Login 8efb927ef798aa827 yes
key API-Key / API-Password 91kb5kp94k3kk8 yes
folder Folder-ID 5 no
pagination page 1 no
limit limit 200 no

Response
200 (OK)
Content-Type: application/json
{
"status": 200,
"msg": "OK",
"server_time":"2021-07-12 08:36:15",
"result": {
"folders": [
    {
    "id": "34567",
    "name": "RemoteDl"
    },
    {
    "id": "4567",
    "name": "test"
    },
    {
    "id": "567",
    "name": "videos"
    },
    {
    "id": "6789",
    "name": "series"
    },
    {
    "id": "678",
    "name": "film"
    }
],
"files": [
    {
    "name": "bigbuckbunny.mp4",
    "sha1": "de179ccafa808cabf06cd2e12cd38eb663094e47",
    "folderid": "4567",
    "upload_at": "2021-07-12 14:16:10",
    "status": "active",
    "size": "5321514545",
    "content_type": "video/mp4",
    "download_count": "848",
    "cstatus": "pending",
    "link": "https://embedo.co/f/9fnelnvpql73/big_buck_bunny.mp4.mp4",
    "id": "9fnelnvpql73"
    },
    {
    "name": "Sintel.2010.mkv.mp4",
    "sha1": "75b16e207b52f38019fe5400946ff7b228d94bc1",
    "folderid": "4567",
    "upload_at": "2021-07-12 14:16:10",
    "status": "active",
    "size": "5321514545",
    "content_type": "video/mp4",
    "download_count": "1337",
    "cstatus": "Completed",
    "link": "https://embedo.co/f/baespiqulj4e/Sintel.2010.1080p.mkv.mp4",
    "id": "baespiqulj4e"
    }
]
}
}
Create Folder

Creates a new Folder

Request
https://api.embedo.co/file/createfolder?login={login}&key={key}&name={name}&pid={parent}
Parameters

Name Description Example Required
login API-Login 8efb927ef798aa827 yes
key API-Key / API-Password 91kb5kp94k3kk8 yes
name Name of new Folder 12345 yes
pid Parent Folder ID (if not set root folder will be used) 12345 no

Response
200 (OK)
Content-Type: application/json
{
"status": 200,
"msg": "OK",
"server_time":"2021-07-12 08:36:15",
"result": {
    "folderid": "35678"
}
}
Rename Folder

Renames a Folder

Request
https://api.embedo.co/file/renamefolder?login={login}&key={key}&folder={folder}&name={name}
Parameters

Name Description Example Required
login API-Login 8efb927ef798aa827 yes
key API-Key / API-Password 91kb5kp94k3kk8 yes
folder Folder ID to delete 12345 yes
name New Name my%20new%20videos yes

Response
200 (OK)
Content-Type: application/json
{
"status": 200,
"msg": "OK",
"server_time":"2021-07-12 08:36:15",
"result": true
}
Delete Folder

Deletes a Folder with all subfolders and all files in it. Be careful!

Request
https://api.embedo.co/file/deletefolder?login={login}&key={key}&folder={folder}
Parameters

Name Description Example Required
login API-Login 8efb927ef798aa827 yes
key API-Key / API-Password 91kb5kp94k3kk8 yes
folder Folder ID to delete 12345 yes

Response
200 (OK)
Content-Type: application/json
{
"status": 200,
"msg": "OK",
"server_time":"2021-07-12 08:36:15",
"result": true
}
Rename File

Renames a File

Request
https://api.embedo.co/file/rename?login={login}&key={key}&file={file}&name={name}
Parameters

Name Description Example Required
login API-Login 8efb927ef798aa827 yes
key API-Key / API-Password 91kb5kp94k3kk8 yes
file File ID to rename nly9m6lc6fvo yes
name New Name newvideo.mp4 yes

Response
200 (OK)
Content-Type: application/json
{
"status": 200,
"msg": "OK",
"server_time":"2021-07-12 08:36:15",
"result": true
}
Move File

Moves a File into a different folder

Request
https://api.embedo.co/file/move?login={login}&key={key}&file={file}&folder={folder}
Parameters

Name Description Example Required
login API-Login 8efb927ef798aa827 yes
key API-Key / API-Password 91kb5kp94k3kk8 yes
file File ID to move 9fnelnvpql73 yes
folder Folder to move in 1234567 yes

Response
200 (OK)
Content-Type: application/json
{
"status": 200,
"msg": "OK",
"server_time":"2021-07-12 08:36:15",
"result": true
}
Delete File

Removes a file

Request
https://api.embedo.co/file/delete?login={login}&key={key}&file={file}
Parameters

Name Description Example Required
login API-Login 8efb927ef798aa827 yes
key API-Key / API-Password 91kb5kp94k3kk8 yes
file File ID to delete baespiqulj4e yes

Response
200 (OK)
Content-Type: application/json
{
"status": 200,
"msg": "OK",
"server_time":"2021-07-12 08:36:15",

"result": true
}
Show running file converts

Shows running file converts by folder

Request
https://api.embedo.co/file/runningconverts?login={login}&key={key}
Parameters

Name Description Example Required
login API-Login 8efb927ef798aa827 yes
key API-Key / API-Password 91kb5kp94k3kk8 yes

Response
200 (OK)
Content-Type: application/json
{
"status": 200,
"msg": "OK",
"server_time":"2021-07-12 08:36:15",
"result": [
{
    "name": "MyOldCamera.avi",
    "id": "16544848",
    "status": "pending",
    "last_update": "2019-01-01 04:40:40",
    "link": "https://embedo.co/f/baespiqulj4e/Geysir.AVI",
    "id": "paupt7t96vod"
}
]
}
Show failed file converts

Should be unnecessary, if you have problems with convert, send us a message

Get splash image

Shows the video splash image (thumbnail)

Request
https://api.embedo.co/file/getsplash?login={login}&key={key}&file={file}
Parameters

Name Description Example Required
login API-Login 8efb927ef798aa827 yes
key API-Key / API-Password 91kb5kp94k3kk8 yes
file File-ID paupt7t96vod yes

Response
200 (OK)
Content-Type: application/json
{
"status": 200,
"msg": "OK",
"server_time":"2021-07-12 08:36:15",
"result": "https://thumb.embedo.net/thumb/d79eb7cdd4ac/paupt7t96vod.jpg"
}