Videos

List videos

get

List the videos associated to the account.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

account_uuidstringOptional

account uuid

folder_uuidstringOptional

folder uuid

pageintegerOptional

select a page default page=1

limitintegerOptional

number of item in a page default=12

tagsstring[]Optional

don’t forget the comma between each tag, ex: METEO,TF1,Week

namestringOptional

name

isStoredbooleanOptional

if video was stored

Default: false

isDeletedbooleanOptional

if video was deleted

Default: false

isInTrashbooleanOptional

if video was trashed

Default: false

isArchivedbooleanOptional

if video was archived

Default: false

isMultiEncodedbooleanOptional

if video was multiencoded

Default: false

startAtstring · dateOptional

start interval

endAtstring · dateOptional

end interval

Responses

200

Success

application/json

404

Not found

application/json

get

/api/v1/videos

HTTPcURLJavaScriptPython

GET /api/v1/videos HTTP/1.1
Host: app-api.greenencoder.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "uuid": "",
    "name": "text",
    "duration": 1,
    "progress": 1,
    "isMultiEncoded": true,
    "isStored": true,
    "createdAt": null,
    "deletedAt": "2026-03-25T17:05:52.407Z",
    "user": {
      "uuid": "",
      "email": "text"
    },
    "mediaType": "DEFAULT",
    "extension": "text",
    "outputExtension": "MP4",
    "encodes": [
      {
        "uuid": "",
        "quality": "text",
        "size": "text",
        "updatedAt": "2026-03-25T17:05:52.407Z",
        "downloadLink": "text",
        "streamLink": "text",
        "maxDownloadAuthorized": 1,
        "isDeleted": true,
        "jobConfig": {},
        "progress": 1,
        "encodingState": "PENDING",
        "tag": "text",
        "isMultiEncoded": true,
        "sizeOptimisation": 1,
        "publication": {
          "uuid": "",
          "thumbnail": "text",
          "title": "text",
          "description": "text",
          "createdAt": "2026-03-25T17:05:52.407Z",
          "channel": {
            "uuid": "",
            "name": "text",
            "link": "text",
            "parameters": {},
            "createdAt": "2026-03-25T17:05:52.407Z"
          },
          "publishedBy": {
            "uuid": "",
            "email": "text"
          }
        },
        "presetName": "text"
      }
    ],
    "isArchived": true,
    "isDeleted": true,
    "isInTrash": true,
    "downloadLink": "text",
    "streamLink": "text",
    "thumbnail": "text",
    "thumbnailLd": "text",
    "gainOptimisation": 1,
    "maxDownloadAuthorized": 1,
    "isUploadComplete": true,
    "encodingState": "PENDING",
    "tagsName": [
      "text"
    ],
    "encodedBy": "text",
    "title": "text",
    "account": {
      "uuid": "",
      "email": "text",
      "name": "text",
      "company": "text"
    },
    "folder": {
      "uuid": "",
      "name": "text",
      "level": 1
    },
    "publications": [
      {
        "uuid": "",
        "thumbnail": "text",
        "title": "text",
        "description": "text",
        "createdAt": "2026-03-25T17:05:52.407Z",
        "channel": {
          "uuid": "",
          "name": "text",
          "link": "text",
          "parameters": {},
          "createdAt": "2026-03-25T17:05:52.407Z"
        },
        "publishedBy": {
          "uuid": "",
          "email": "text"
        }
      }
    ],
    "files": [
      {
        "uuid": "",
        "downloadLink": "text"
      }
    ]
  }
]

Get a video

get

Get informations about the specified video. Contains the encoding status.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

video_uuidstringRequired

Video identifier

Responses

200

Success

application/json

404

Not found

application/json

get

/api/v1/videos/{video_uuid}

HTTPcURLJavaScriptPython

GET /api/v1/videos/{video_uuid} HTTP/1.1
Host: app-api.greenencoder.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "uuid": "",
    "name": "text",
    "duration": 1,
    "progress": 1,
    "isMultiEncoded": true,
    "isStored": true,
    "createdAt": null,
    "deletedAt": "2026-03-25T17:05:52.407Z",
    "user": {
      "uuid": "",
      "email": "text"
    },
    "mediaType": "DEFAULT",
    "extension": "text",
    "outputExtension": "MP4",
    "encodes": [
      {
        "uuid": "",
        "quality": "text",
        "size": "text",
        "updatedAt": "2026-03-25T17:05:52.407Z",
        "downloadLink": "text",
        "streamLink": "text",
        "maxDownloadAuthorized": 1,
        "isDeleted": true,
        "jobConfig": {},
        "progress": 1,
        "encodingState": "PENDING",
        "tag": "text",
        "isMultiEncoded": true,
        "sizeOptimisation": 1,
        "publication": {
          "uuid": "",
          "thumbnail": "text",
          "title": "text",
          "description": "text",
          "createdAt": "2026-03-25T17:05:52.407Z",
          "channel": {
            "uuid": "",
            "name": "text",
            "link": "text",
            "parameters": {},
            "createdAt": "2026-03-25T17:05:52.407Z"
          },
          "publishedBy": {
            "uuid": "",
            "email": "text"
          }
        },
        "presetName": "text"
      }
    ],
    "isArchived": true,
    "isDeleted": true,
    "isInTrash": true,
    "downloadLink": "text",
    "streamLink": "text",
    "thumbnail": "text",
    "thumbnailLd": "text",
    "gainOptimisation": 1,
    "maxDownloadAuthorized": 1,
    "isUploadComplete": true,
    "encodingState": "PENDING",
    "tagsName": [
      "text"
    ],
    "encodedBy": "text",
    "title": "text",
    "account": {
      "uuid": "",
      "email": "text",
      "name": "text",
      "company": "text"
    },
    "folder": {
      "uuid": "",
      "name": "text",
      "level": 1
    },
    "publications": [
      {
        "uuid": "",
        "thumbnail": "text",
        "title": "text",
        "description": "text",
        "createdAt": "2026-03-25T17:05:52.407Z",
        "channel": {
          "uuid": "",
          "name": "text",
          "link": "text",
          "parameters": {},
          "createdAt": "2026-03-25T17:05:52.407Z"
        },
        "publishedBy": {
          "uuid": "",
          "email": "text"
        }
      }
    ],
    "files": [
      {
        "uuid": "",
        "downloadLink": "text"
      }
    ]
  }
]

Edit video informations

put

Edit the title of a video.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

video_uuidstringRequired

Video identifier

Body

application/json

titlestringRequired

Responses

200

Video

application/json

put

/api/v1/videos/{video_uuid}

HTTPcURLJavaScriptPython

PUT /api/v1/videos/{video_uuid} HTTP/1.1
Host: app-api.greenencoder.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "title": "text",
  "encodes": [
    {
      "uuid": "",
      "tag": "text"
    }
  ]
}

200

Video

[
  {
    "encodes": [
      {
        "uuid": "",
        "tag": "text"
      }
    ],
    "encodedBy": "text",
    "title": "text"
  }
]

Download encoded videos

get

Download the encoded videos associated to the specified source video in ZIP format.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

video_uuidstringRequired

Video identifier

Responses

200

Videos successfully downloaded

application/zip

404

Not found

application/json

get

/api/v1/videos/{video_uuid}/download-multi

HTTPcURLJavaScriptPython

GET /api/v1/videos/{video_uuid}/download-multi HTTP/1.1
Host: app-api.greenencoder.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

Download video

get

Download a video.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

video_uuidstringRequired

Video identifier

Responses

200

Video successfully downloaded

application/json

404

Not found

application/json

get

/api/v1/videos/{video_uuid}/download

HTTPcURLJavaScriptPython

GET /api/v1/videos/{video_uuid}/download HTTP/1.1
Host: app-api.greenencoder.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "file": "binary"
}

Encode video

post

Upload a video then run one or multiple encoding jobs

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

multipart/form-data

titleanyOptional

alternative name

filestring · binaryRequired

video file to encode

multipreset_uuidstringOptional

identifier of the multi-preset used to encode the video file

multipreset_namestringOptional

name of the multi-preset used to encode the video file

account_uuidstringRequired

the videos will belong to the account corresponding to this identifier

folderIdstringRequired

identifier of the folder where the videos will be stored

tagsstring[]Optional

list of names used to sort videos. Tags must be separated by a comma, ex: METEO,TF1,Week

Responses

201

Created uploaded Video

application/json

401

Forbidden

application/json

403

Forbidden

application/json

406

Not Acceptable

application/json

415

Unsupported Media Type

application/json

422

Unprocessable Entity

application/json

post

/api/v1/videos/encode

HTTPcURLJavaScriptPython

POST /api/v1/videos/encode HTTP/1.1
Host: app-api.greenencoder.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 212

{
  "title": null,
  "file": "binary",
  "presets": [
    {
      "name": "text",
      "uuid": "text",
      "renditions": [],
      "tags": [
        "text"
      ]
    }
  ],
  "multipreset_uuid": "text",
  "multipreset_name": "text",
  "account_uuid": "text",
  "folderId": "text",
  "tags": [
    "text"
  ]
}

[
  {
    "uuid": "",
    "name": "text",
    "duration": 1,
    "progress": 1,
    "isMultiEncoded": true,
    "isStored": true,
    "createdAt": null,
    "deletedAt": "2026-03-25T17:05:52.407Z",
    "user": {
      "uuid": "",
      "email": "text"
    },
    "mediaType": "DEFAULT",
    "extension": "text",
    "outputExtension": "MP4",
    "encodes": [
      {
        "uuid": "",
        "quality": "text",
        "size": "text",
        "updatedAt": "2026-03-25T17:05:52.407Z",
        "downloadLink": "text",
        "streamLink": "text",
        "maxDownloadAuthorized": 1,
        "isDeleted": true,
        "jobConfig": {},
        "progress": 1,
        "encodingState": "PENDING",
        "tag": "text",
        "isMultiEncoded": true,
        "sizeOptimisation": 1,
        "publication": {
          "uuid": "",
          "thumbnail": "text",
          "title": "text",
          "description": "text",
          "createdAt": "2026-03-25T17:05:52.407Z",
          "channel": {
            "uuid": "",
            "name": "text",
            "link": "text",
            "parameters": {},
            "createdAt": "2026-03-25T17:05:52.407Z"
          },
          "publishedBy": {
            "uuid": "",
            "email": "text"
          }
        },
        "presetName": "text"
      }
    ],
    "isArchived": true,
    "isDeleted": true,
    "isInTrash": true,
    "downloadLink": "text",
    "streamLink": "text",
    "thumbnail": "text",
    "thumbnailLd": "text",
    "gainOptimisation": 1,
    "maxDownloadAuthorized": 1,
    "isUploadComplete": true,
    "encodingState": "PENDING",
    "tagsName": [
      "text"
    ],
    "encodedBy": "text",
    "title": "text",
    "account": {
      "uuid": "",
      "email": "text",
      "name": "text",
      "company": "text"
    },
    "folder": {
      "uuid": "",
      "name": "text",
      "level": 1
    },
    "publications": [
      {
        "uuid": "",
        "thumbnail": "text",
        "title": "text",
        "description": "text",
        "createdAt": "2026-03-25T17:05:52.407Z",
        "channel": {
          "uuid": "",
          "name": "text",
          "link": "text",
          "parameters": {},
          "createdAt": "2026-03-25T17:05:52.407Z"
        },
        "publishedBy": {
          "uuid": "",
          "email": "text"
        }
      }
    ],
    "files": [
      {
        "uuid": "",
        "downloadLink": "text"
      }
    ]
  }
]

Encode from an existing video

post

Re-encode a video with a new configuration

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

video_uuidstringRequired

Video identifier

Body

application/json

multipreset_uuidstringOptional

Identifier of the multi-preset used to encode the video file

multipreset_namestringOptional

Name of the multi-preset used to encode the video file

Responses

200

Video

application/json

post

/api/v1/videos/{video_uuid}/encode

HTTPcURLJavaScriptPython

POST /api/v1/videos/{video_uuid}/encode HTTP/1.1
Host: app-api.greenencoder.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 127

{
  "presets": [
    {
      "name": "text",
      "uuid": "text",
      "renditions": [],
      "tags": [
        "text"
      ]
    }
  ],
  "multipreset_uuid": "text",
  "multipreset_name": "text"
}

200

Video

[
  {
    "uuid": "",
    "progress": 1,
    "encodingState": "PENDING"
  }
]

Video trash

patch

Put the specified video in the trash.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

video_uuidstringRequired

Video identifier

Responses

200

Video

application/json

patch

/api/v1/videos/{video_uuid}/trash

HTTPcURLJavaScriptPython

PATCH /api/v1/videos/{video_uuid}/trash HTTP/1.1
Host: app-api.greenencoder.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Video

{
  "code": 200,
  "message": "Video successfully moved to trash!",
  "data": "null",
  "error": [
    []
  ]
}

Cancel a video encoding job

patch

Cancel the encodings currently being processed for the specified video. If the video serves as the source material, this action will remove all associated encodings. However, if the video is currently undergoing encoding, only the current encoding will be canceled.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

video_uuidstringRequired

Video identifier

Responses

200

Success

application/json

404

Not found

application/json

patch

/api/v1/videos/{video_uuid}/cancel

HTTPcURLJavaScriptPython

PATCH /api/v1/videos/{video_uuid}/cancel HTTP/1.1
Host: app-api.greenencoder.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "code": 200,
  "data": "Encoded video successfully canceled!"
}