Download package PDF documentation

GET /v1/package/{id}/documentation/pdf

Downloads a PDF file containing App Documentation for a package.

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 documentation for.

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/pdf

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.pdf.

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

Complete operation definition

{
  "description": "Downloads a PDF file containing App Documentation for a package.",
  "parameters": [
    {
      "description": "ID of package to download documentation for.",
      "in": "path",
      "name": "id",
      "required": true,
      "schema": {
        "format": "uuid",
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/pdf": {
          "schema": {
            "format": "byte",
            "type": "string"
          }
        }
      },
      "description": "OK"
    }
  },
  "summary": "Download package PDF documentation.",
  "tags": [
    "Package"
  ]
}