API Documentation
Endpoint Examples
Endpoint Examples
Fetch Face-Swap Task
GET
/
v1
/
faceswap-opanpai
/
listbyids
curl --request GET \
--url https://api.clipzap.ai/v1/faceswap-opanpai/listbyids \
--header 'X-ClipZap-Apikey: <x-clipzap-apikey>'
{
"list": [
{
"id": {},
"imageUrl": "<string>",
"videoUrl": "<string>",
"userId": 123,
"objectId": "<string>",
"title": "<string>",
"status": "<string>",
"taskId": "<string>",
"footageId": "<string>",
"videoId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>",
"publishStatus": 123,
"duration": 123,
"error": "<string>",
"Footage": {
"id": 123,
"type": "<string>",
"name": "<string>",
"card": "<string>",
"cardId": "<string>",
"workflowId": "<string>",
"status": "<string>",
"cover": "<string>",
"objectId": "<string>",
"userId": 123,
"webId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"trashedAt": "<string>",
"removedAt": "<string>",
"videoQty": 123
},
"Video": {
"id": 123,
"userId": 123,
"objectId": "<string>",
"footageId": "<string>",
"name": "<string>",
"width": 123,
"height": 123,
"size": 123,
"duration": 123,
"suffix": "<string>",
"webId": "<string>",
"status": "<string>",
"originUrl": "<string>",
"videoUrl": "<string>",
"coverUrl": "<string>",
"audioUrl": "<string>",
"avatars": "<string>",
"audioText": "<string>",
"uploadAt": "<string>"
}
}
]
}
Headers
Query Parameters
任务ID(支持批量,逗号分隔)
Response
200 - application/json
The response is of type object
.
curl --request GET \
--url https://api.clipzap.ai/v1/faceswap-opanpai/listbyids \
--header 'X-ClipZap-Apikey: <x-clipzap-apikey>'
{
"list": [
{
"id": {},
"imageUrl": "<string>",
"videoUrl": "<string>",
"userId": 123,
"objectId": "<string>",
"title": "<string>",
"status": "<string>",
"taskId": "<string>",
"footageId": "<string>",
"videoId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>",
"publishStatus": 123,
"duration": 123,
"error": "<string>",
"Footage": {
"id": 123,
"type": "<string>",
"name": "<string>",
"card": "<string>",
"cardId": "<string>",
"workflowId": "<string>",
"status": "<string>",
"cover": "<string>",
"objectId": "<string>",
"userId": 123,
"webId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"trashedAt": "<string>",
"removedAt": "<string>",
"videoQty": 123
},
"Video": {
"id": 123,
"userId": 123,
"objectId": "<string>",
"footageId": "<string>",
"name": "<string>",
"width": 123,
"height": 123,
"size": 123,
"duration": 123,
"suffix": "<string>",
"webId": "<string>",
"status": "<string>",
"originUrl": "<string>",
"videoUrl": "<string>",
"coverUrl": "<string>",
"audioUrl": "<string>",
"avatars": "<string>",
"audioText": "<string>",
"uploadAt": "<string>"
}
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.