This endpoint requires API Key authentication. You must include your API key in the api-key header of your request.
Request Headers:
Request Query Parameters:
Response Codes:
Response Body (Success - 200 OK):
Response Body Fields:
Media Types:
The type field within the asset object indicates the media type of an asset. The following media types are supported:
taskList[].task.message
Array of Strings
Messages associated with the task, providing more context about the task's progress or status.
taskList[].task.date
Date
The date and time the task was created. Format is a standard JavaScript Date object, typically in ISO 8601 format.
taskList[].asset
Array
An array of asset objects associated with the task.
taskList[].asset[].url
String
The URL of the asset.
taskList[].asset[].thumbnail
String
The URL of the asset's thumbnail, if available.
taskList[].asset[].embed
String
Embed code for the asset, if applicable.
taskList[].asset[].name
String
The name of the asset.
taskList[].asset[].type
String
The media type of the asset (e.g., "image", "video", "sound").
taskList[].asset[].status
String
The status of the asset.
taskList[].asset[]._id
String
The unique identifier of the asset.
totalPages
Number
The total number of pages available for the current query.
currentPage
Number
The current page number being returned.
totalTasks
Number
The total number of tasks matching the query criteria (across all pages).
api-key
String
Yes
Your organization's API key for authentication.
page
Number
No
1
The page number for pagination.
limit
Number
No
15
The maximum number of tasks to return per page. The backend will cast this to a number, ensure you are sending a number.
200 OK
Tasks successfully retrieved.
See "Response Body (Success - 200 OK)" below.
401 Unauthorized
Authentication failed - Missing or invalid API Key.
Returned when the api-key header is missing.
500 Internal Server Error
An unexpected error occurred on the server.
{ "error": "System Error. Please try again" }
isSuccess
Boolean
Indicates whether the request was successful (always true for a 200 OK response).
taskList
Array
An array of task objects, each containing task details and an array of associated assets.
taskList[].task
Object
Contains details about the task.
taskList[].task.status
String
The current status of the task (e.g., "generating", "completed", "failed").
voice
Audio recording of a human voice.
image
Static image (e.g., JPEG, PNG, GIF).
sound
General audio clip (e.g., sound effects, music).
video
Video clip (e.g., MP4, MOV).
360
360-degree image or video, providing an immersive, panoramic view.
3d
3D model or scene (specific formats may vary, e.g., glTF, OBJ, USDZ).
{
"isSuccess": true,
"taskList": [
{
"task": {
"status": "string",
"message": ["string"],
"date": "Date"
},
"asset": [
{
"url": "string",
"thumbnail": "string",
"embed": "string",
"name": "string",
"type": "string",
"status": "string",
"_id": "string"
}
]
}
],
"totalPages": number,
"currentPage": number,
"totalTasks": number
}