Task Details

Retrieve the original request and response for any previously executed task. Useful for debugging, recovering past results, and auditing API interactions.

Introduction

The getTaskDetails task retrieves the complete request and response objects for any previously executed task. Pass the taskUUID of a past task to recover its original request payload and the API response it produced.

This is useful for debugging failed requests by inspecting the exact payload that was sent, recovering responses that your application didn't store, and auditing historical API interactions.

The returned request and response objects are untyped because their structure depends on the original task type. They are the whole original objects, exactly as they were sent and received.

The taskUUID in this request refers to the UUID of the task you want to inspect. The response echoes it back along with the original request and response objects.

Request

Our API always accepts an array of objects as input, where each object represents a specific task to be performed. The structure of the object varies depending on the type of the task. For this section, we will focus on the parameters related to the task details task.

The following JSON snippet shows the basic structure of a request object.

[
  {
    "taskType": "getTaskDetails",
    "taskUUID": "a770f077-f413-47de-9dac-be0b26a35da6"
  }
]

taskType const:getTaskDetails required value: getTaskDetails: The type of task to perform.

taskUUID string required UUID v4: UUID v4 identifier for tracking tasks and matching async responses. Must be unique per task.

Response

The response always includes the original request array and a response object. The request is the original array of task objects you sent to the API. The response is the full API response envelope, containing either a data array (if the task completed successfully) or an errors array (if the task failed).

Both objects are untyped because their structure depends on the original task type.

Successful task

When the original task completed successfully, the response object contains a data array with the results.

{
  "data": [
    {
      "taskType": "getTaskDetails",
      "taskUUID": "a770f077-f413-47de-9dac-be0b26a35da6",
      "request": [
        {
          "taskType": "imageInference",
          "model": "runware:101@1",
          "positivePrompt": "a cat",
          "width": 1024,
          "height": 1024,
          "numberResults": 1,
          "includeCost": true,
          "taskUUID": "a770f077-f413-47de-9dac-be0b26a35da6"
        }
      ],
      "response": {
        "data": [
          {
            "taskType": "imageInference",
            "taskUUID": "a770f077-f413-47de-9dac-be0b26a35da6",
            "imageUUID": "77da2d99-a6d3-44d9-b8c0-ae9fb06b6200",
            "imageURL": "https://im.runware.ai/image/ws/0.5/ii/77da2d99-a6d3-44d9-b8c0-ae9fb06b6200.jpg",
            "cost": 0.0013
          }
        ]
      }
    }
  ]
}

Failed task

When the original task failed, the response object contains an errors array with the error details from the original failure.

{
  "data": [
    {
      "taskType": "getTaskDetails",
      "taskUUID": "b880f077-e514-58ef-0ebd-ce1c37b46eb7",
      "request": [
        {
          "taskType": "imageInference",
          "model": "runware:400@1",
          "positivePrompt": "a landscape",
          "width": 1024,
          "height": 1024,
          "numberResults": 1,
          "inputs": {
            "referenceImages": [
              "https://im.runware.ai/image/ws/5/bucket/media-storage/ii/4e7a91c3-28d5-4f6b-a0e2-7c3d8f1b5a94",
              "https://im.runware.ai/image/ws/5/bucket/media-storage/ii/d2f08b47-9c31-4a85-be6f-5e9a12c7d403",
              "https://im.runware.ai/image/ws/5/bucket/media-storage/ii/8b5c3e19-f7a2-4d60-91c4-a6e8d0f23b71",
              "https://im.runware.ai/image/ws/5/bucket/media-storage/ii/c1d94f6a-3b82-47e5-a5c0-9f2e71d08b36",
              "https://im.runware.ai/image/ws/5/bucket/media-storage/ii/7a0e5d93-6f14-4c28-b9d7-e3c1a84f2650"
            ]
          },
          "taskUUID": "b880f077-e514-58ef-0ebd-ce1c37b46eb7"
        }
      ],
      "response": {
        "errors": [
          {
            "code": "invalidReferenceImagesCount",
            "message": "Invalid number of elements for 'referenceImages' parameter. Reference images must contain between 0 and 4.",
            "parameter": "inputs.referenceImages",
            "type": "string[]",
            "documentation": "https://runware.ai/docs",
            "taskUUID": "b880f077-e514-58ef-0ebd-ce1c37b46eb7"
          }
        ]
      }
    }
  ]
}

Task not found

If the provided taskUUID does not exist or belongs to a different organization, the API returns a standard error response.

{
  "data": [],
  "errors": [
    {
      "code": "taskNotFound",
      "message": "No task found for the provided 'taskUUID'. The taskUUID may not exist or may belong to a different organization.",
      "parameter": "taskUUID",
      "type": "string",
      "documentation": "https://runware.ai/docs",
      "taskUUID": "abcdc144-7364-4a7c-b6e4-fadb3dbf2f67"
    }
  ]
}

taskType string required value: getTaskDetails: Identifier for the type of task being performed

taskUUID string required UUID v4: UUID v4 identifier for tracking tasks and matching async responses. Must be unique per task.

request array of objects required: The original request array sent for this task. The structure of each object depends on the task type.

response object required: The original API response for this task. Contains a data array when the task completed successfully, or an errors array when the task failed.