Spiritme

avatars_list

开发环境

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

GET

/api/avatars/

avatars

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://dev-cn.your-api-server.com/api/avatars/' \
--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",
            "name": "string",
            "description": "string",
            "status": "created",
            "thumbnail": "http://example.com",
            "preview": "http://example.com",
            "circular_preview": "http://example.com",
            "frame_width": 0,
            "frame_height": 0,
            "best_fit_voices": [
                0
            ],
            "supported_emotions": [
                "string"
            ],
            "supports_background_removal": true,
            "ownership": true
        }
    ]
}

请求参数

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]

可选

枚举值:

approvedcapturedclarificationcreatedreadyrejectedtraining

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 (Avatar) {14}]

可选

integer

只读必需

string <date-time>

Created datetime

只读必需

name

string

必需

<= 80 字符

description

string | null

只读必需

status

enum<string>

只读必需

枚举值:

createdcapturedclarificationapprovedtrainingreadyrejected

thumbnail

string <uri>

只读必需

preview

string <uri>

只读必需

circular_preview

string <uri>

只读必需

frame_width

integer

只读必需

frame_height

integer

只读必需

best_fit_voices

array[integer]

只读必需

supported_emotions

array[string]

只读必需

supports_background_removal

boolean

只读必需

ownership

boolean

只读必需

batch_video_templates_list