api.md

title	FinalRip
language_tabs	shell Shell http HTTP javascript JavaScript ruby Ruby python Python php PHP java Java go Go
toc_footers
includes
search	true
code_clipboard	true
highlight_theme	darkula
headingLevel	2
generator	@tarslib/widdershins v4.0.27

FinalRip

Base URLs:

Authentication

• API Key (apikey-header-token)
  • Parameter Name: token, in: header.

task

POST Start

POST /api/v1/task/start

Body Parameters

script: "import os\r

  import vapoursynth as vs\r

  from vapoursynth import core\r

  \r

  clip = core.bs.VideoSource(source=os.getenv('FINALRIP_SOURCE'))\r

  clip.set_output()"
encode_param: ffmpeg -i - -vcodec libx265 -crf 16 FINALRIP_ENCODED_CLIP.mkv
video_key: Roshidere-08.mkv
slice: "true"
timeout: 20
queue: default

Params

Name	Location	Type	Required	Description
body	body	object	no	none
» script	body	string	yes	vapoursynth script
» encode_param	body	string	yes	encoder param
» video_key	body	string	yes	video oss key
» slice	body	boolean	no	cut video into clips or not
» timeout	body	integer	no	clip timeout, minute
» queue	body	string	no	queue name, default or priority

Response Examples

200 Response

{
  "success": true,
  "error": {
    "message": "string"
  }
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	none	Inline

Responses Data Schema

HTTP Status Code 200

Name	Type	Required	Restrictions	Title	description
» success	boolean	true	none		none
» error	object	false	none		none
»» message	string	true	none		none

POST New

POST /api/v1/task/new

new a task after upload oss

Body Parameters

video_key: Roshidere-08.mkv

Params

Name	Location	Type	Required	Description
body	body	object	no	none
» video_key	body	string	yes	video oss key

Response Examples

200 Response

{
  "success": true,
  "error": {
    "message": "string"
  }
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	none	Inline

Responses Data Schema

HTTP Status Code 200

Name	Type	Required	Restrictions	Title	description
» success	boolean	true	none		none
» error	object	false	none		none
»» message	string	true	none		none

POST Clear

POST /api/v1/task/clear

Body Parameters

video_key: Roshidere-06.mkv

Params

Name	Location	Type	Required	Description
body	body	object	no	none
» video_key	body	string	yes	video oss key

Response Examples

200 Response

{
  "success": true,
  "error": {
    "message": "string"
  }
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	none	Inline

Responses Data Schema

HTTP Status Code 200

Name	Type	Required	Restrictions	Title	description
» success	boolean	true	none		none
» error	object	false	none		none
»» message	string	true	none		none

GET Progress

GET /api/v1/task/progress

Params

Name	Location	Type	Required	Description
video_key	query	string	yes	none

Response Examples

200 Response

{
  "success": true,
  "error": {
    "message": "string"
  },
  "data": {
    "progress": [
      {
        "completed": true,
        "index": 0,
        "clip_key": "string",
        "clip_url": "string",
        "encode_key": "string",
        "encode_url": "string"
      }
    ],
    "key": "string",
    "url": "string",
    "size": "string",
    "encode_key": "string",
    "encode_url": "string",
    "encode_size": "string",
    "encode_param": "string",
    "script": "string",
    "status": "string",
    "create_at": 0
  }
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	none	Inline

Responses Data Schema

HTTP Status Code 200

Name	Type	Required	Restrictions	Title	description
» success	boolean	true	none		none
» error	object	false	none		none
»» message	string	true	none		none
» data	object	false	none		none
»» progress	[object]	true	none		none
»»» completed	boolean	true	none		none
»»» index	number	true	none		none
»»» clip_key	string	true	none		none
»»» clip_url	string	true	none		none
»»» encode_key	string	true	none		none
»»» encode_url	string	true	none		none
»» key	string	true	none		none
»» url	string	true	none		none
»» size	string	true	none		none
»» encode_key	string	true	none		none
»» encode_url	string	true	none		none
»» encode_size	string	true	none		none
»» encode_param	string	true	none		none
»» script	string	true	none		none
»» status	string	true	none		pending, running, completed
»» create_at	integer	true	none		unix time, int64

GET OSSPresigned

GET /api/v1/task/oss/presigned

Params

Name	Location	Type	Required	Description
video_key	query	string	yes	none

Response Examples

200 Response

{
  "success": true,
  "error": {
    "message": "string"
  },
  "data": {
    "url": "string",
    "exist": true
  }
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	none	Inline

Responses Data Schema

HTTP Status Code 200

Name	Type	Required	Restrictions	Title	description
» success	boolean	true	none		none
» error	object	false	none		none
»» message	string	true	none		none
» data	object	false	none		none
»» url	string	true	none		upload url
»» exist	boolean	true	none		none

POST RetryEncode

POST /api/v1/task/retry/encode

Body Parameters

video_key: Roshidere-06.mkv
index: 2
timeout: 20
queue: default

Params

Name	Location	Type	Required	Description
body	body	object	no	none
» video_key	body	string	yes	video oss key
» index	body	integer	yes	video clip index
» timeout	body	integer	no	clip timeout, minute
» queue	body	string	no	queue name, default or priority

Response Examples

200 Response

{
  "success": true,
  "error": {
    "message": "string"
  }
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	none	Inline

Responses Data Schema

HTTP Status Code 200

Name	Type	Required	Restrictions	Title	description
» success	boolean	true	none		none
» error	object	false	none		none
»» message	string	true	none		none

POST RetryMerge

POST /api/v1/task/retry/merge

Body Parameters

video_key: Roshidere-06.mkv

Params

Name	Location	Type	Required	Description
body	body	object	no	none
» video_key	body	string	yes	video oss key

Response Examples

200 Response

{
  "success": true,
  "error": {
    "message": "string"
  }
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	none	Inline

Responses Data Schema

HTTP Status Code 200

Name	Type	Required	Restrictions	Title	description
» success	boolean	true	none		none
» error	object	false	none		none
»» message	string	true	none		none

GET List

GET /api/v1/task/list

Params

Name	Location	Type	Required	Description
pending	query	boolean	yes	none
running	query	boolean	yes	none
completed	query	boolean	yes	none

Response Examples

200 Response

{
  "success": true,
  "error": {
    "message": "string"
  },
  "data": [
    {
      "key": "string",
      "url": "string",
      "encode_key": "string",
      "encode_url": "string",
      "encode_param": "string",
      "script": "string",
      "status": "string",
      "create_at": 0
    }
  ]
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	none	Inline

Responses Data Schema

HTTP Status Code 200

Name	Type	Required	Restrictions	Title	description
» success	boolean	true	none		none
» error	object	false	none		none
»» message	string	true	none		none
» data	[object]	false	none		none
»» key	string	true	none		none
»» url	string	true	none		none
»» encode_key	string	true	none		none
»» encode_url	string	true	none		none
»» encode_param	string	true	none		none
»» script	string	true	none		none
»» status	string	true	none		pending, running, completed
»» create_at	integer	true	none		unix time, int64

Data Schema