Skip to Content
Get Task Results

Get Task Status & Results

Overview

After creating a task, you can query its status and retrieve the generated results using the task ID returned from the create endpoint.

Test API KEY: key_00000000000000000000000000000000

Endpoints

Get Task Status & Results

Request

POST https://api.pixwith.ai/api/task/get

Headers

HeaderValueRequired
Content-Typeapplication/jsonYes
Api-Key{API_KEY}Yes

Request Parameters

ParameterTypeRequiredDescription
task_idstringYesThe ID of the task to query (e.g., “cf0ddb5ad6a0f0c85ab4d1dceb9fd89c”)

Example Request

{ "task_id": "cf0ddb5ad6a0f0c85ab4d1dceb9fd89c" }

Response Parameters

ParameterTypeDescription
codeint1=success, 0=error
messagestringSuccess and failure messages
dataobjectContains the task details and results
data.task_idstringThe ID of the task
data.statusintThe status of the task (1=processing, 2=completed, 3=failed)
data.result_urlsarray of stringsURLs of the generated results (images or videos, depending on the task type)

Response

{ "code": 1, "message": "success", "data": { "task_id": "cf0ddb5ad6a0f0c85ab4d1dceb9fd89c", "status": 2, "result_urls": [ "https://cdn.pixwith.ai/images/cf0ddb5ad6a0f0c85ab4d1dceb9fd89c_0.jpeg" ] } }
Last updated on