Skip to main content

​
Overview

This endpoint allows users to generate a downloadable package of assets for a specific task within a job run of a workflow. By specifying the workflow, job, and task IDs, users can retrieve a signed URL for securely downloading the task’s output. Authentication is required.

  • Method: PUT
  • URL: /v0/workflows/{workflow_id}/jobs/{job_id}/tasks/{task_id}/download
  • Operation: Create a download package from a specific task
  • Authentication Required: Yes

​
Authorization

You need the api key which you can get from the API tab in Organization Settings. The api key is required in almost all the commands

Authorization: <YOUR_API_KEY>

​
Path Parameters

The workflow_id scopes the request to the correct workflow, job_id identifies the job in which the task ran, and task_id specifies the task whose assets should be downloaded. Together, they allow precise targeting of task-level outputs within complex workflow executions.

NameTypeRequiredDescription
workflow_idstringYesID of the workflow from which the task is associated
job_idstringYesID of the job that executed the task
task_idstringYesID of the specific task to download assets from

​
Response

The 200 OK response includes metadata about the task and a signed_url for downloading its output assets. The signed URL is time-bound for security and enables direct download without additional authentication. This is useful for exporting individual task results from larger workflows.

NameTypeDescription
idstringUnique identifier of the task
job_idstringID of the job to which the task belongs
workflow_idstringID of the workflow associated with the job
statusstringStatus of the download request (e.g., “pending”, “ready”)
signed_urlstringURL to securely download the task’s packaged output assets
Here is a sample 200 response:
200
{
  "id": "<string>",
  "job_id": "<string>",
  "workflow_id": "<string>",
  "status": "<string>",
  "signed_url": "<string>"
}
A 400 Bad Request is returned for malformed or missing parameters. A 403 Forbidden error indicates that the user lacks permission to access the specified workflow, job, or task. Structured error objects with code, message, and details help identify and resolve access or request issues.
400 403
{
  "error": {
    "code": "<string>",
    "details": "<any>",
    "message": "<string>"
  }
}

​
How to use the endpoint

  1. Prepare Your Request Ensure you have the workflow_id, job_id, and task_id of the task you want to download. Include your Authorization header with a valid token.
  2. Send the Request Make a PUT request to https://api.pixxel.space/v0/workflows/workflow_id/jobs/job_id/tasks/task_id/download
  3. Process the Response On success, retrieve the signed_url from the response and use it to download the task package. Handle any errors using the error object and status codes.

⌘I