Spiritme

videos_list

开发环境

http://dev-cn.your-api-server.com

GET

/api/videos/

videos

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://dev-cn.your-api-server.com/api/videos/' \
--header 'Authorization;'

响应示例

{
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100",
    "results": [
        {
            "id": 0,
            "cd": "2019-08-24T14:15:22Z",
            "gd": "2019-08-24T14:15:22Z",
            "name": "New video",
            "slides": [
                {
                    "id": 0,
                    "audio_source": {
                        "text": "string",
                        "voice": {
                            "id": 0,
                            "name": "string",
                            "label": "string",
                            "provider": "amazon",
                            "sex": "male",
                            "language": "string",
                            "language_code": "string"
                        },
                        "file": {
                            "id": 0,
                            "name": "string",
                            "duration": 0,
                            "tag": "general",
                            "file": "http://example.com",
                            "compressed_file": "http://example.com"
                        }
                    },
                    "layers": [
                        {
                            "avatar": {
                                "id": 0,
                                "name": "string",
                                "preview": "http://example.com",
                                "frame_width": 0,
                                "frame_height": 0
                            },
                            "media": {
                                "id": 0,
                                "name": "string",
                                "tag": "general",
                                "file": "http://example.com",
                                "compressed_file": "http://example.com",
                                "width": 0,
                                "height": 0
                            },
                            "x": -1,
                            "y": -1,
                            "scale": 1,
                            "crop": {
                                "left_upper_x": 0,
                                "left_upper_y": 0,
                                "right_lower_x": 0,
                                "right_lower_y": 0
                            },
                            "view_type": "rectangular"
                        }
                    ],
                    "background": {
                        "id": 0,
                        "name": "string",
                        "tag": "general",
                        "file": "http://example.com",
                        "compressed_file": "http://example.com",
                        "width": 0,
                        "height": 0
                    }
                }
            ],
            "webhook": {
                "id": 0,
                "cd": "2019-08-24T14:15:22Z",
                "url": "http://example.com"
            },
            "resolution": {
                "width": 1920,
                "height": 1080
            },
            "auto_emotions_markup": false,
            "status": "draft",
            "result": "http://example.com",
            "thumbnail": "http://example.com"
        }
    ]
}

请求参数

Query 参数

limit

integer

可选

Number of results to return per page.

offset

integer

可选

The initial index from which to return the results.

ordering

string

可选

Which field to use when ordering the results.

status

array[string]

可选

枚举值:

cleareddrafterrorexecutingin_queueinsufficient_balance_errorsuccess

Header 参数

Authorization

string

必需

默认值:

Token <api-key>

返回响应

🟢200成功

application/json

Body

count

integer

可选

示例值:

123

string <uri> | null

可选

示例值:

http://api.example.org/accounts/?offset=400&limit=100

string <uri> | null

可选

示例值:

http://api.example.org/accounts/?offset=200&limit=100

results

array[object (Video) {11}]

可选

integer

只读必需

string <date-time>

Created datetime

只读必需

string <date-time> | null

Generated datetime

只读必需

name

string

可选

<= 80 字符

默认值:

New video

slides

array[object (Slide) {4}]

必需

webhook

null | allOf {1}

可选

resolution

object

可选

默认值:

{"width":1920,"height":1080}

auto_emotions_markup

boolean

可选

默认值:

false

status

enum<string>

只读必需

枚举值:

draftin_queueexecutingerrorinsufficient_balance_errorsuccesscleared

result

string <uri> | null

只读必需

thumbnail

string <uri>

只读必需

Thumbnail for video

修改于 2024-03-28 09:50:16

users_current_destroy

videos_create