Skip to main content

​
Overview

This endpoint is used to initiate a download package for a specific job under a workflow. It collects both the input and output assets of a job run and generates a downloadable URL. Users must provide the workflow and job IDs. Authentication is required.

  • Method: PUT
  • URL: /v0/workflows/{workflow_id}/jobs/{job_id}/download
  • Operation: Create a downloadable package from a workflow job
  • 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 identifies the workflow containing the job, while job_id specifies the particular job whose assets need to be downloaded. These parameters are essential to precisely locate and retrieve the correct set of job data for packaging.

NameTypeRequiredDescription
workflow_idstringYesUnique ID of the workflow to download assets from
job_idstringYesJob ID within the workflow to generate the download package from

​
Response

A 200 OK response includes a signed_url that allows temporary access to download the assets packaged from the specified job. The response also includes the download operation’s status and ID, providing both metadata and the file access link in a secure, authenticated manner.

NameTypeDescription
idstringUnique identifier of the download operation
statusstringCurrent status of the download request (e.g., “pending”, “ready”)
signed_urlstringURL to securely download the packaged input and output assets
workflowIdstringID of the workflow associated with the job
Here is a sample 200 response:
200
{
  "id": "<string>",
  "status": "<string>",
  "signed_url": "<string>",
  "workflowId": "<string>"
}
A 400 Bad Request indicates invalid or missing parameters. A 403 Forbidden response means the user lacks permission to access the specified workflow or job. These error responses include structured fields like code, message, and optional details to assist in resolving the issue.
400 403
{
  "error": {
    "code": "<string>",
    "details": "<any>",
    "message": "<string>"
  }
}

​
How to use the endpoint

  1. Prepare Your Request Ensure you have the workflow_id and job_id of the job you want to download from. Include the Authorization header with a valid bearer token.
  2. Send the Request Make a PUT request to https://api.pixxel.space/v0/workflows/{workflow_id}/jobs/{job_id}/download
  3. Handle the Response On success, the response will contain a signed_url to download the ZIP package. Handle errors by checking for a 400 or 403 status and reviewing the returned error message.

⌘I