Download package

GET /v1/package/{id}/download

Downloads a package in a specified format.

Source: Robopack public API v1 OpenAPI definition · OpenAPI 3.0.1 · Snapshot: 2026-10-01. Download this snapshot.

Servers

• https://api.robopack.com/

Authentication

Scheme	Type	Location	Name	Description
API key	apiKey	header	X-API-Key	Robopack API key generated for account

Send your API key in the X-API-Key header. Examples read it from ROBOPACK_API_KEY.

Parameters

Name	In	Required	Type	Nullable	Constraints / default	Description
id	path	Yes	string (uuid)	Not declared	—	ID of package to download.
format	query	No	V1PackageDownloadFormat	Not declared	—	The format to download the package as. Not all packages support all formats.
noScriptWrap	query	No	boolean	Not declared	default: false	If the package should not be wrapped in an installation script.
templateId	query	No	string (uuid)	Not declared	default: null	ID of script template to use for wrapping the package. If not specified, will use the default for the package.

Parameter names and capitalization follow the source definition. Required status follows the parameter's explicit required flag; optional does not imply a server default.

Request body

No request body is declared in the source definition.

Responses

200 response

OK

Response media type: application/octet-stream

Type: string (byte)

Only response statuses declared in the snapshot are listed. The source does not define a complete error contract.

curl example

This GET example reads data. Set ROBOPACK_API_KEY in your shell and set ID to the target values. Query values must be URL encoded. Optional query parameters are omitted.

The response is saved to response.bin.

curl --request GET \
  --url "https://api.robopack.com/v1/package/${ID}/download" \
  --header "X-API-Key: ${ROBOPACK_API_KEY}" \
  --header "Accept: application/octet-stream" \
  --output 'response.bin'

Related models

• V1PackageDownloadFormat

Complete operation definition

{
  "description": "Downloads a package in a specified format.",
  "parameters": [
    {
      "description": "ID of package to download.",
      "in": "path",
      "name": "id",
      "required": true,
      "schema": {
        "format": "uuid",
        "type": "string"
      }
    },
    {
      "description": "The format to download the package as. Not all packages support all formats.",
      "in": "query",
      "name": "format",
      "schema": {
        "$ref": "#/components/schemas/V1PackageDownloadFormat"
      }
    },
    {
      "description": "If the package should not be wrapped in an installation script.",
      "in": "query",
      "name": "noScriptWrap",
      "schema": {
        "default": false,
        "type": "boolean"
      }
    },
    {
      "description": "ID of script template to use for wrapping the package. If not specified, will use the default for the package.",
      "in": "query",
      "name": "templateId",
      "schema": {
        "default": null,
        "format": "uuid",
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/octet-stream": {
          "schema": {
            "format": "byte",
            "type": "string"
          }
        }
      },
      "description": "OK"
    }
  },
  "summary": "Download package.",
  "tags": [
    "Package"
  ]
}