Skip to main content
GET
/
v3
/
async
/
task-result
Task Result
curl --request GET \
  --url https://api.novita.ai/v3/async/task-result \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>'
{
  "extra": {
    "seed": "<string>",
    "enable_nsfw_detection": true,
    "debug_info": {
      "request_info": "<string>",
      "submit_time_ms": "<string>",
      "execute_time_ms": "<string>",
      "complete_time_ms": "<string>"
    }
  },
  "task": {
    "task_id": "<string>",
    "status": "<string>",
    "reason": "<string>",
    "task_type": "<string>",
    "eta": 123,
    "progress_percent": 123
  },
  "images": [
    {
      "image_url": "<string>",
      "image_url_ttl": 123,
      "image_type": "<string>"
    }
  ],
  "videos": [
    {
      "video_url": "<string>",
      "video_url_ttl": "<string>",
      "video_type": "<string>"
    }
  ],
  "audios": [
    {
      "audio_url": "<string>",
      "audio_url_ttl": "<string>",
      "audio_type": "<string>",
      "audio_metadata": {
        "text": "<string>",
        "start_time": {},
        "end_time": {}
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://novita.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

This API is used to retrieve images, audio, or video results from v3 asynchronous tasks using the task_id.

​
Request Headers

​
Content-Type
string
required
Enum: application/json
​
Authorization
string
required
Bearer authentication format, for example: Bearer {{API Key}}.

​
Query Parameters

​
task_id
string
required
Returned in the 200 response of v3 asynchronous APIs.

​
Response

​
extra
object
​
task
object
Task information.
​
images
object[]
Contains information about images associated with image-type tasks. This parameter provides detailed data on each image processed or generated during the task, such as file paths, metadata, or any image-specific attributes. It is returned only for tasks that involve image operations, facilitating enhanced tracking and management of image data.
​
videos
object[]
Contains information about videos associated with video-type tasks. This parameter provides detailed data on each video processed or generated during the task, such as file paths, metadata, or any video-specific attributes. It is returned only for tasks that involve video operations, facilitating enhanced tracking and management of video data.
​
audios
object[]
Contains information about audios associated with audio type tasks. This parameter provides detailed data on each audio processed or generated during the task, such as file paths, metadata, or any image-specific attributes. It is returned only for tasks that involve audio operations, facilitating enhanced tracking and management of audio data.

​
Example

request 
curl --location --globoff 'https://api.novita.ai/v3/async/task-result?task_id={{Novita-TaskID}}' \
--header 'Authorization: Bearer {{API Key}}'
response 
{
  "extra": {
    "seed": "158881667",
    "enable_nsfw_detection": false,
    "debug_info": {
      "request_info": "",
      "submit_time_ms": "",
      "execute_time_ms": "",
      "complete_time_ms": ""
    }
  },
  "task": {
    "task_id": "830d9c90-d53f-4c5a-8009-xxx",
    "status": "TASK_STATUS_SUCCEED",
    "reason": "",
    "task_type": "TXT_TO_IMG",
    "eta": 0,
    "progress_percent": 0
  },
  "images": [
    {
      "image_url": "https://faas-output-image.s3.ap-southeast-1.amazonaws.com/prod/xxx",
      "image_url_ttl": 3600,
      "image_type": "jpeg",
      "nsfw_detection_result": {}
    }
  ],
  "videos": [],
  "audios": []
}